Share via


OracleLinkedService interface

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.

Extends

Properties

authenticationType

Authentication type for connecting to the Oracle database. Only used for Version 2.0.

connectionString

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.

cryptoChecksumClient

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

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.

enableBulkLoad

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.

encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptionClient

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

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.

fetchSize

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.

fetchTswtzAsTimestamp

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.

initializationString

Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0.

initialLobFetchSize

Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0.

password

The Azure key vault secret reference of password in connection string.

server

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.

statementCacheSize

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.

supportV1DataTypes

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.

type

Polymorphic discriminator, which specifies the different types this object can be

username

The Oracle database username. Type: string. Only used for Version 2.0.

Inherited Properties

annotations

List of tags that can be used for describing the linked service.

connectVia

The integration runtime reference.

description

Linked service description.

parameters

Parameters for linked service.

version

Version of the linked service.

Property Details

authenticationType

Authentication type for connecting to the Oracle database. Only used for Version 2.0.

authenticationType?: string

Property Value

string

connectionString

The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0.

connectionString?: any

Property Value

any

cryptoChecksumClient

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.

cryptoChecksumClient?: any

Property Value

any

cryptoChecksumTypesClient

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.

cryptoChecksumTypesClient?: any

Property Value

any

enableBulkLoad

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.

enableBulkLoad?: any

Property Value

any

encryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

encryptedCredential?: string

Property Value

string

encryptionClient

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.

encryptionClient?: any

Property Value

any

encryptionTypesClient

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.

encryptionTypesClient?: any

Property Value

any

fetchSize

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.

fetchSize?: any

Property Value

any

fetchTswtzAsTimestamp

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.

fetchTswtzAsTimestamp?: any

Property Value

any

initializationString

Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0.

initializationString?: any

Property Value

any

initialLobFetchSize

Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0.

initialLobFetchSize?: any

Property Value

any

password

The Azure key vault secret reference of password in connection string.

password?: AzureKeyVaultSecretReference

Property Value

server

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.

server?: any

Property Value

any

statementCacheSize

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.

statementCacheSize?: any

Property Value

any

supportV1DataTypes

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.

supportV1DataTypes?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "Oracle"

Property Value

"Oracle"

username

The Oracle database username. Type: string. Only used for Version 2.0.

username?: any

Property Value

any

Inherited Property Details

annotations

List of tags that can be used for describing the linked service.

annotations?: any[]

Property Value

any[]

Inherited From LinkedService.annotations

connectVia

The integration runtime reference.

connectVia?: IntegrationRuntimeReference

Property Value

Inherited From LinkedService.connectVia

description

Linked service description.

description?: string

Property Value

string

Inherited From LinkedService.description

parameters

Parameters for linked service.

parameters?: {[propertyName: string]: ParameterSpecification}

Property Value

{[propertyName: string]: ParameterSpecification}

Inherited From LinkedService.parameters

version

Version of the linked service.

version?: string

Property Value

string

Inherited From LinkedService.version