File: change_data_capture_create.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (442 lines) | stat: -rw-r--r-- 25,863 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python change_data_capture_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="12345678-1234-1234-1234-12345678abc",
    )

    response = client.change_data_capture.create_or_update(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        change_data_capture_name="exampleChangeDataCapture",
        change_data_capture={
            "properties": {
                "Policy": {"mode": "Microbatch", "recurrence": {"frequency": "Minute", "interval": 15}},
                "SourceConnectionsInfo": [
                    {
                        "Connection": {
                            "commonDslConnectorProperties": [
                                {"name": "allowSchemaDrift", "value": True},
                                {"name": "inferDriftedColumnTypes", "value": True},
                                {"name": "format", "value": "delimited"},
                                {
                                    "name": "dateFormats",
                                    "value": [
                                        "MM/dd/yyyy",
                                        "dd/MM/yyyy",
                                        "yyyy/MM/dd",
                                        "MM-dd-yyyy",
                                        "dd-MM-yyyy",
                                        "yyyy-MM-dd",
                                        "dd.MM.yyyy",
                                        "MM.dd.yyyy",
                                        "yyyy.MM.dd",
                                    ],
                                },
                                {
                                    "name": "timestampFormats",
                                    "value": [
                                        "yyyyMMddHHmm",
                                        "yyyyMMdd HHmm",
                                        "yyyyMMddHHmmss",
                                        "yyyyMMdd HHmmss",
                                        "dd-MM-yyyy HH:mm:ss",
                                        "dd-MM-yyyy HH:mm",
                                        "yyyy-M-d H:m:s",
                                        "yyyy-MM-dd\\'T\\'HH:mm:ss\\'Z\\'",
                                        "yyyy-M-d\\'T\\'H:m:s\\'Z\\'",
                                        "yyyy-M-d\\'T\\'H:m:s",
                                        "yyyy-MM-dd\\'T\\'HH:mm:ss",
                                        "yyyy-MM-dd HH:mm:ss",
                                        "yyyy-MM-dd HH:mm",
                                        "yyyy.MM.dd HH:mm:ss",
                                        "MM/dd/yyyy HH:mm:ss",
                                        "M/d/yyyy H:m:s",
                                        "yyyy/MM/dd HH:mm:ss",
                                        "yyyy/M/d H:m:s",
                                        "dd MMM yyyy HH:mm:ss",
                                        "dd MMMM yyyy HH:mm:ss",
                                        "d MMM yyyy H:m:s",
                                        "d MMMM yyyy H:m:s",
                                        "d-M-yyyy H:m:s",
                                        "d-M-yyyy H:m",
                                        "yyyy-M-d H:m",
                                        "MM/dd/yyyy HH:mm",
                                        "M/d/yyyy H:m",
                                        "yyyy/MM/dd HH:mm",
                                        "yyyy/M/d H:m",
                                        "dd MMMM yyyy HH:mm",
                                        "dd MMM yyyy HH:mm",
                                        "d MMMM yyyy H:m",
                                        "d MMM yyyy H:m",
                                        "MM-dd-yyyy hh:mm:ss a",
                                        "MM-dd-yyyy HH:mm:ss",
                                        "MM/dd/yyyy hh:mm:ss a",
                                        "yyyy.MM.dd hh:mm:ss a",
                                        "MM/dd/yyyy",
                                        "dd/MM/yyyy",
                                        "yyyy/MM/dd",
                                        "MM-dd-yyyy",
                                        "dd-MM-yyyy",
                                        "yyyy-MM-dd",
                                        "dd.MM.yyyy",
                                        "MM.dd.yyyy",
                                        "yyyy.MM.dd",
                                    ],
                                },
                                {"name": "enableCdc", "value": True},
                                {"name": "skipInitialLoad", "value": True},
                                {"name": "columnNamesAsHeader", "value": True},
                                {"name": "columnDelimiter", "value": ","},
                                {"name": "escapeChar", "value": "\\\\"},
                                {"name": "quoteChar", "value": '\\"'},
                            ],
                            "isInlineDataset": True,
                            "linkedService": {"referenceName": "amjaAdls03", "type": "LinkedServiceReference"},
                            "linkedServiceType": "AzureBlobFS",
                            "type": "linkedservicetype",
                        },
                        "SourceEntities": [
                            {
                                "name": "source/customer",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "container", "value": "source"},
                                        {"name": "fileSystem", "value": "source"},
                                        {"name": "folderPath", "value": "customer"},
                                        {"name": "allowSchemaDrift", "value": False},
                                        {"name": "inferDriftedColumnTypes", "value": False},
                                    ],
                                    "schema": [
                                        {"dataType": "short", "name": "CustId"},
                                        {"dataType": "string", "name": "CustName"},
                                        {"dataType": "string", "name": "CustAddres"},
                                        {"dataType": "string", "name": "CustDepName"},
                                        {"dataType": "string", "name": "CustDepLoc"},
                                    ],
                                },
                            },
                            {
                                "name": "source/employee",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "container", "value": "source"},
                                        {"name": "fileSystem", "value": "source"},
                                        {"name": "folderPath", "value": "employee"},
                                    ],
                                    "schema": [],
                                },
                            },
                            {
                                "name": "lookup",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "container", "value": "lookup"},
                                        {"name": "fileSystem", "value": "lookup"},
                                        {"name": "allowSchemaDrift", "value": False},
                                        {"name": "inferDriftedColumnTypes", "value": False},
                                    ],
                                    "schema": [
                                        {"dataType": "short", "name": "EmpId"},
                                        {"dataType": "string", "name": "EmpName"},
                                        {"dataType": "string", "name": "HomeAddress"},
                                        {"dataType": "string", "name": "OfficeAddress"},
                                        {"dataType": "integer", "name": "EmpPhoneNumber"},
                                        {"dataType": "string", "name": "DepName"},
                                        {"dataType": "string", "name": "DepLoc"},
                                        {"dataType": "double", "name": "DecimalCol"},
                                    ],
                                },
                            },
                            {
                                "name": "source/justSchema",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "container", "value": "source"},
                                        {"name": "fileSystem", "value": "source"},
                                        {"name": "folderPath", "value": "justSchema"},
                                        {"name": "allowSchemaDrift", "value": False},
                                        {"name": "inferDriftedColumnTypes", "value": False},
                                    ],
                                    "schema": [
                                        {"dataType": "string", "name": "CustId"},
                                        {"dataType": "string", "name": "CustName"},
                                        {"dataType": "string", "name": "CustAddres"},
                                        {"dataType": "string", "name": "CustDepName"},
                                        {"dataType": "string", "name": "CustDepLoc"},
                                    ],
                                },
                            },
                        ],
                    }
                ],
                "TargetConnectionsInfo": [
                    {
                        "Connection": {
                            "commonDslConnectorProperties": [
                                {"name": "allowSchemaDrift", "value": True},
                                {"name": "inferDriftedColumnTypes", "value": True},
                                {"name": "format", "value": "table"},
                                {"name": "store", "value": "sqlserver"},
                                {"name": "databaseType", "value": "databaseType"},
                                {"name": "database", "value": "database"},
                                {"name": "deletable", "value": False},
                                {"name": "insertable", "value": True},
                                {"name": "updateable", "value": False},
                                {"name": "upsertable", "value": False},
                                {"name": "skipDuplicateMapInputs", "value": True},
                                {"name": "skipDuplicateMapOutputs", "value": True},
                            ],
                            "isInlineDataset": True,
                            "linkedService": {"referenceName": "amjaSql", "type": "LinkedServiceReference"},
                            "linkedServiceType": "AzureSqlDatabase",
                            "type": "linkedservicetype",
                        },
                        "DataMapperMappings": [
                            {
                                "attributeMappingInfo": {"attributeMappings": []},
                                "sourceConnectionReference": {
                                    "connectionName": "amjaAdls03",
                                    "type": "linkedservicetype",
                                },
                                "sourceEntityName": "source/customer",
                                "targetEntityName": "dbo.customer",
                            },
                            {
                                "attributeMappingInfo": {
                                    "attributeMappings": [
                                        {
                                            "attributeReferences": [
                                                {
                                                    "entity": "lookup",
                                                    "entityConnectionReference": {
                                                        "connectionName": "amjaAdls03",
                                                        "type": "linkedservicetype",
                                                    },
                                                    "name": "EmpName",
                                                }
                                            ],
                                            "expression": "upper(EmpName)",
                                            "functionName": "upper",
                                            "name": "Name",
                                            "type": "Derived",
                                        },
                                        {
                                            "attributeReference": {
                                                "entity": "lookup",
                                                "entityConnectionReference": {
                                                    "connectionName": "amjaAdls03",
                                                    "type": "linkedservicetype",
                                                },
                                                "name": "EmpId",
                                            },
                                            "functionName": "",
                                            "name": "PersonID",
                                            "type": "Direct",
                                        },
                                    ]
                                },
                                "sourceConnectionReference": {
                                    "connectionName": "amjaAdls03",
                                    "type": "linkedservicetype",
                                },
                                "sourceEntityName": "lookup",
                                "targetEntityName": "dbo.data_source_table",
                            },
                            {
                                "attributeMappingInfo": {"attributeMappings": []},
                                "sourceConnectionReference": {
                                    "connectionName": "amjaAdls03",
                                    "type": "linkedservicetype",
                                },
                                "sourceEntityName": "source/employee",
                                "targetEntityName": "dbo.employee",
                            },
                            {
                                "attributeMappingInfo": {
                                    "attributeMappings": [
                                        {
                                            "attributeReferences": [
                                                {
                                                    "entity": "source/justSchema",
                                                    "entityConnectionReference": {
                                                        "connectionName": "amjaAdls03",
                                                        "type": "linkedservicetype",
                                                    },
                                                    "name": "CustAddres",
                                                }
                                            ],
                                            "expression": "trim(CustAddres)",
                                            "functionName": "trim",
                                            "name": "CustAddres",
                                            "type": "Derived",
                                        },
                                        {
                                            "attributeReference": {
                                                "entity": "source/justSchema",
                                                "entityConnectionReference": {
                                                    "connectionName": "amjaAdls03",
                                                    "type": "linkedservicetype",
                                                },
                                                "name": "CustDepLoc",
                                            },
                                            "name": "CustDepLoc",
                                            "type": "Direct",
                                        },
                                        {
                                            "attributeReferences": [
                                                {
                                                    "entity": "source/justSchema",
                                                    "entityConnectionReference": {
                                                        "connectionName": "amjaAdls03",
                                                        "type": "linkedservicetype",
                                                    },
                                                    "name": "CustName",
                                                },
                                                {
                                                    "entity": "source/justSchema",
                                                    "entityConnectionReference": {
                                                        "connectionName": "amjaAdls03",
                                                        "type": "linkedservicetype",
                                                    },
                                                    "name": "CustDepName",
                                                },
                                            ],
                                            "expression": 'concat(CustName, " -> ", CustDepName)',
                                            "functionName": "",
                                            "name": "CustDepName",
                                            "type": "Derived",
                                        },
                                        {
                                            "attributeReference": {
                                                "entity": "source/justSchema",
                                                "entityConnectionReference": {
                                                    "connectionName": "amjaAdls03",
                                                    "type": "linkedservicetype",
                                                },
                                                "name": "CustId",
                                            },
                                            "functionName": "",
                                            "name": "CustId",
                                            "type": "Direct",
                                        },
                                        {
                                            "attributeReference": {
                                                "entity": "source/justSchema",
                                                "entityConnectionReference": {
                                                    "connectionName": "amjaAdls03",
                                                    "type": "linkedservicetype",
                                                },
                                                "name": "CustName",
                                            },
                                            "name": "CustName",
                                            "type": "Direct",
                                        },
                                    ]
                                },
                                "sourceConnectionReference": {
                                    "connectionName": "amjaAdls03",
                                    "type": "linkedservicetype",
                                },
                                "sourceEntityName": "source/justSchema",
                                "targetEntityName": "dbo.justSchema",
                            },
                        ],
                        "Relationships": [],
                        "TargetEntities": [
                            {
                                "name": "dbo.employee",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "schemaName", "value": "dbo"},
                                        {"name": "tableName", "value": "employee"},
                                    ],
                                    "schema": [],
                                },
                            },
                            {
                                "name": "dbo.justSchema",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "schemaName", "value": "dbo"},
                                        {"name": "tableName", "value": "justSchema"},
                                        {"name": "allowSchemaDrift", "value": True},
                                        {"name": "inferDriftedColumnTypes", "value": True},
                                    ],
                                    "schema": [],
                                },
                            },
                            {
                                "name": "dbo.customer",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "schemaName", "value": "dbo"},
                                        {"name": "tableName", "value": "customer"},
                                        {"name": "allowSchemaDrift", "value": False},
                                        {"name": "inferDriftedColumnTypes", "value": False},
                                    ],
                                    "schema": [
                                        {"dataType": "integer", "name": "CustId"},
                                        {"dataType": "string", "name": "CustName"},
                                        {"dataType": "string", "name": "CustAddres"},
                                        {"dataType": "string", "name": "CustDeptName"},
                                        {"dataType": "string", "name": "CustEmail"},
                                    ],
                                },
                            },
                            {
                                "name": "dbo.data_source_table",
                                "properties": {
                                    "dslConnectorProperties": [
                                        {"name": "schemaName", "value": "dbo"},
                                        {"name": "tableName", "value": "data_source_table"},
                                        {"name": "allowSchemaDrift", "value": False},
                                        {"name": "inferDriftedColumnTypes", "value": False},
                                        {"name": "defaultToUpsert", "value": False},
                                    ],
                                    "schema": [
                                        {"dataType": "integer", "name": "PersonID"},
                                        {"dataType": "string", "name": "Name"},
                                        {"dataType": "timestamp", "name": "LastModifytime"},
                                    ],
                                },
                            },
                        ],
                    }
                ],
                "allowVNetOverride": False,
                "description": "Sample demo change data capture to transfer data from delimited (csv) to Azure SQL Database with automapped and non-automapped mappings.",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/ChangeDataCapture_Create.json
if __name__ == "__main__":
    main()