Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DataFactory & Synapse] Update Oracle Linked Service #32060

Merged
merged 19 commits into from
Jan 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions specification/datafactory/cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ words:
- vsts
- wtgctbg
- xero
- tswtz
overrides:
- filename: >-
**/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/IntegrationRuntime.json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1655,7 +1655,7 @@
},
"OracleLinkedService": {
"x-ms-discriminator-value": "Oracle",
"description": "Oracle database.",
"description": "Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.",
"type": "object",
"allOf": [
{
Expand All @@ -1680,12 +1680,88 @@
"connectionString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference."
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0."
},
"server": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0."
},
"authenticationType": {
"type": "string",
"enum": [
"Basic"
],
"x-ms-enum": {
"name": "OracleAuthenticationType",
"modelAsString": true
},
"description": "Authentication type for connecting to the Oracle database. Only used for Version 2.0."
},
"username": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "The Oracle database username. Type: string. Only used for Version 2.0."
},
"password": {
"$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptionClient": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0."
},
"encryptionTypesClient": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0."
},
"cryptoChecksumClient": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0."
},
"cryptoChecksumTypesClient": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0."
},
"initialLobFetchSize": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0."
},
"fetchSize": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0."
},
"statementCacheSize": {
"type": "object",
"x-ms-format": "dfe-int",
"description": "Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0."
},
"initializationString": {
"type": "object",
"x-ms-format": "dfe-string",
"description": "Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0."
},
"enableBulkLoad": {
"type": "object",
"x-ms-format": "dfe-bool",
"description": "Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0."
},
"supportV1DataTypes": {
"type": "object",
"x-ms-format": "dfe-bool",
"description": "Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0."
},
"fetchTswtzAsTimestamp": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fetchTswtzAsTimestamp

Abbreviations may create ambiguity. Can we remove the abbreviation and instead use something like "fetchTimestampWithTimezoneAsTimestamp" ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of abbreviations is intentional here. This property is used to provide backward compatibility support and the name has been in our service for a long time and has been used extensively by customers. thanks.

"type": "object",
"x-ms-format": "dfe-bool",
"description": "Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0."
},
"encryptedCredential": {
"type": "string",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string."
Expand Down
1 change: 1 addition & 0 deletions specification/synapse/cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ words:
- wtgctbg
- xero
- xlargerc
- tswtz
overrides:
- filename: >-
**/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1412,7 +1412,7 @@
},
"OracleLinkedService": {
"x-ms-discriminator-value": "Oracle",
"description": "Oracle database.",
"description": "Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features.",
"type": "object",
"allOf": [
{
Expand All @@ -1435,13 +1435,76 @@
"type": "object",
"properties": {
"connectionString": {
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.",
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.",
"type": "object"
},
"server": {
"type": "object",
"description": "The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0."
},
"authenticationType": {
"type": "string",
"enum": [
"Basic"
],
"x-ms-enum": {
"name": "OracleAuthenticationType",
"modelAsString": true
},
"description": "Authentication type for connecting to the Oracle database. Only used for Version 2.0."
},
"username": {
"type": "object",
"description": "The Oracle database username. Type: string. Only used for Version 2.0."
},
"password": {
"$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference",
"description": "The Azure key vault secret reference of password in connection string."
},
"encryptionClient": {
"type": "object",
"description": "Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0."
},
"encryptionTypesClient": {
"type": "object",
"description": "Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0."
},
"cryptoChecksumClient": {
"type": "object",
"description": "Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0."
},
"cryptoChecksumTypesClient": {
"type": "object",
"description": "Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0."
},
"initialLobFetchSize": {
"type": "object",
"description": "Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0."
},
"fetchSize": {
"type": "object",
"description": "Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0."
},
"statementCacheSize": {
"type": "object",
"description": "Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0."
},
"initializationString": {
"type": "object",
"description": "Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0."
},
"enableBulkLoad": {
"type": "object",
"description": "Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0."
},
"supportV1DataTypes": {
"type": "object",
"description": "Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0."
},
"fetchTswtzAsTimestamp": {
"type": "object",
"description": "Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0."
},
"encryptedCredential": {
"type": "object",
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)."
Expand Down
Loading