You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en-US/Set-KustoIngestionMapping.md
+54-19Lines changed: 54 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -9,41 +9,63 @@ schema: 2.0.0
9
9
10
10
## SYNOPSIS
11
11
12
-
{{ Fill in the Synopsis }}
12
+
Creates or updates an ingestion mapping that can be associated with a specific format and a specific table or database.
13
13
14
14
## SYNTAX
15
15
16
16
```powershell
17
17
Set-KustoIngestionMapping
18
-
[-MappingName] <String>
19
-
[-Table] <String>
18
+
[-Name] <String>
19
+
[[-Table] <String>]
20
20
[[-Database] <String>]
21
-
-IngestionMapping <IngestionMapping>
22
-
[-RemoveOldestIfRequired]
21
+
-Mapping <IngestionMapping>
22
+
[-Force]
23
23
[-OutputType <OutputType>]
24
24
[-RequestProperties <ClientRequestProperties>]
25
25
[<CommonParameters>]
26
26
```
27
27
28
28
## DESCRIPTION
29
29
30
-
{{ Fill in the Description }}
30
+
The `Set-KustoIngestionMapping` cmdlet can be used to create or update an ingestion mapping that can be associated with a specific format and a specific table or database. For more information see [__.create ingestion mapping command__](https://learn.microsoft.com/en-us/kusto/management/create-ingestion-mapping-command?view=microsoft-fabric)
31
+
and [__.create-or-alter ingestion mapping command__](https://learn.microsoft.com/en-us/kusto/management/create-or-alter-ingestion-mapping-command?view=microsoft-fabric).
31
32
32
33
## EXAMPLES
33
34
34
-
### Example 1
35
+
### Example 1: Creates a new ingestion mapping on a Table
This example demonstrates how to create a new `Json` mapping with name `myNewMapping` on `myTable` in a Database specified by `Connect-Kusto -Database`.
43
+
44
+
### Example 2: Creates a new ingestion mapping on a Database
Specifies the Kusto Database where the new ingestion mapping is being created.
47
69
48
70
> [!NOTE]
49
71
>
@@ -61,9 +83,14 @@ Accept pipeline input: False
61
83
Accept wildcard characters: False
62
84
```
63
85
64
-
### -IngestionMapping
86
+
### -Mapping
65
87
66
-
{{ Fill IngestionMapping Description }}
88
+
This parameter indicates how to map data from the source file to the actual columns in the table.
89
+
You can define the format value with the relevant mapping type.
90
+
91
+
To create a new mapping object, checkout [`New-KustoIngestionMapping`](New-KustoIngestionMapping.md) and [`New-KustoColumnMapping`](New-KustoColumnMapping.md) documentations.
92
+
93
+
See [__data mappings__](https://learn.microsoft.com/en-us/kusto/management/mappings?view=microsoft-fabric) and [__Class `KustoIngestionProperties`__](https://learn.microsoft.com/en-us/kusto/api/netfx/kusto-ingest-client-reference?view=microsoft-fabric#class-kustoingestionproperties) for more information.
67
94
68
95
```yaml
69
96
Type: IngestionMapping
@@ -77,9 +104,9 @@ Accept pipeline input: False
77
104
Accept wildcard characters: False
78
105
```
79
106
80
-
### -MappingName
107
+
### -Name
81
108
82
-
{{ Fill MappingName Description }}
109
+
The name for the ingestion mapping.
83
110
84
111
```yaml
85
112
Type: String
@@ -104,15 +131,15 @@ Aliases:
104
131
Accepted values: PSObject, Json, Csv, DataTable, Html
105
132
106
133
Required: False
107
-
Position: 1
134
+
Position: Named
108
135
Default value: None
109
136
Accept pipeline input: False
110
137
Accept wildcard characters: False
111
138
```
112
139
113
-
### -RemoveOldestIfRequired
140
+
### -Force
114
141
115
-
{{ Fill RemoveOldestIfRequired Description }}
142
+
If a mapping with same name in the given scope already exists, `.create` fails. Use this switch to execute a `.create-or-alter` control command instead.
0 commit comments