Skip to content

Commit b359cb9

Browse files
committed
getting there
1 parent 832c955 commit b359cb9

File tree

2 files changed

+33
-28
lines changed

2 files changed

+33
-28
lines changed

docs/en-US/Invoke-KustoControlCommand.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Accept wildcard characters: False
109109

110110
### -OutputType
111111

112-
Determines the output type this cmdlet will produce. The default value is `PSObject`.
112+
Determines the output type this cmdlet will produce. The default value is __`PSObject`__.
113113

114114
```yaml
115115
Type: OutputType

docs/en-US/Invoke-KustoIngestFromStorage.md

Lines changed: 32 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ schema: 2.0.0
99

1010
## SYNOPSIS
1111

12-
{{ Fill in the Synopsis }}
12+
Ingests local or blob storage files into Azure Data Explorer.
1313

1414
## SYNTAX
1515

@@ -28,11 +28,13 @@ Invoke-KustoIngestFromStorage
2828

2929
## DESCRIPTION
3030

31-
{{ Fill in the Description }}
31+
The `Invoke-KustoIngestFromStorage` cmdlet can be used to ingest local or blob storage files into a table
32+
on your Azure Data Explorer Cluster. For more details on Kusto ingestion, checkout
33+
[__Ingest from storage__](https://learn.microsoft.com/en-us/kusto/management/data-ingestion/ingest-from-storage?view=microsoft-fabric).
3234

3335
## EXAMPLES
3436

35-
### Example 1: Ingest a local Csv file
37+
### Example 1: Ingest a local Csv
3638

3739
```powershell
3840
Invoke-KustoIngestFromStorage .\myCsvFile.csv -Table myTable -Database myDb -IgnoreFirstRecord
@@ -45,7 +47,8 @@ $uri = 'https://myStorageAccount.blob.core.windows.net/my-container/myCsvFile.cs
4547
Invoke-KustoIngestFromStorage $uri -Table myTable -Database myDb -IgnoreFirstRecord
4648
```
4749

48-
This example demonstrates how you can ingest into `myTable` directly from a Storage Account using a SAS Key and URI link.
50+
This example demonstrates how you can ingest into `myTable` directly from a Storage Account
51+
using a SAS Key and URI.
4952

5053
### Example 3: Ingest a local Json
5154

@@ -63,13 +66,15 @@ Invoke-KustoIngestFromStorage .\myJson.json -Table MyJsonTable -Database myDb -F
6366
> The reason `multijson` format instead of `json` is used in this example is because a Json Array is considered as
6467
> `multijson` whereas _JSON Lines_ corresponds to the `json` format. See [__The JSON format__](https://learn.microsoft.com/en-us/azure/data-explorer/ingest-json-formats?tabs=kusto-query-language#the-json-format) for more details.
6568
66-
{{ Add example description here }}
67-
6869
## PARAMETERS
6970

7071
### -Database
7172

72-
{{ Fill Database Description }}
73+
This non mandatory parameter determines which Database in your Cluster will be targetted by your ingest command.
74+
75+
> [!NOTE]
76+
>
77+
> If not supplied, the Database used will be the one specified when you called [`Connect-Kusto`](Connect-Kusto.md).
7378
7479
```yaml
7580
Type: String
@@ -85,13 +90,16 @@ Accept wildcard characters: False
8590
8691
### -Format
8792
88-
{{ Fill Format Description }}
93+
This parameter determines the format of the file to be ingested. The default value is __`csv`__.
8994

9095
```yaml
9196
Type: DataSourceFormat
9297
Parameter Sets: (All)
9398
Aliases:
94-
Accepted values: csv, tsv, scsv, sohsv, psv, txt, raw, tsve, w3clogfile, apacheavro, orc, sstream, parquet, avro, multijson, singlejson, json
99+
Accepted values: csv, tsv, scsv, sohsv, psv, txt,
100+
raw, tsve, w3clogfile, apacheavro,
101+
orc, sstream, parquet, avro,
102+
multijson, singlejson, json
95103
96104
Required: False
97105
Position: Named
@@ -102,7 +110,9 @@ Accept wildcard characters: False
102110

103111
### -IgnoreFirstRecord
104112

105-
{{ Fill IgnoreFirstRecord Description }}
113+
This switch indicates that ingestion should ignore the first record of a file.
114+
This property is useful for files in `CSV` and similar formats,
115+
if the first record in the file are the column names.
106116

107117
```yaml
108118
Type: SwitchParameter
@@ -118,7 +128,12 @@ Accept wildcard characters: False
118128

119129
### -Mapping
120130

121-
{{ Fill Mapping Description }}
131+
This optional parameter indicates how to map data from the source file to the actual columns in the table.
132+
You can define the format value with the relevant mapping type.
133+
134+
To create a new mapping object, checkout [`New-KustoIngestionMapping`](New-KustoIngestionMapping.md) and [`New-KustoColumnMapping`](New-KustoColumnMapping.md) documentations.
135+
136+
See [__data mappings__](https://learn.microsoft.com/en-us/kusto/management/mappings?view=microsoft-fabric) for more information.
122137

123138
```yaml
124139
Type: IngestionMapping
@@ -196,22 +211,6 @@ Accept pipeline input: False
196211
Accept wildcard characters: False
197212
```
198213

199-
### -ProgressAction
200-
201-
{{ Fill ProgressAction Description }}
202-
203-
```yaml
204-
Type: ActionPreference
205-
Parameter Sets: (All)
206-
Aliases: proga
207-
208-
Required: False
209-
Position: Named
210-
Default value: None
211-
Accept pipeline input: False
212-
Accept wildcard characters: False
213-
```
214-
215214
### CommonParameters
216215

217216
This cmdlet supports the common parameters.
@@ -228,3 +227,9 @@ For more information, see [about_CommonParameters](http://go.microsoft.com/fwlin
228227
## NOTES
229228

230229
## RELATED LINKS
230+
231+
[__Ingest from storage__](https://learn.microsoft.com/en-us/kusto/management/data-ingestion/ingest-from-storage?view=microsoft-fabric)
232+
233+
[__Data mappings__](https://learn.microsoft.com/en-us/kusto/management/mappings?view=microsoft-fabric)
234+
235+
[__The JSON format__](https://learn.microsoft.com/en-us/azure/data-explorer/ingest-json-formats?tabs=kusto-query-language#the-json-format)

0 commit comments

Comments
 (0)