SalesforceSink interface

A copy activity Salesforce sink.

Extends

Properties

externalIdFieldName

The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).

ignoreNullValues

The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

type

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

writeBehavior

The write behavior for the operation. Default is Insert.

Inherited Properties

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

maxConcurrentConnections

The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

sinkRetryCount

Sink retry count. Type: integer (or Expression with resultType integer).

sinkRetryWait

Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

writeBatchSize

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

writeBatchTimeout

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

Property Details

externalIdFieldName

The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string).

externalIdFieldName?: any

Property Value

any

ignoreNullValues

The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean).

ignoreNullValues?: any

Property Value

any

type

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

type: "SalesforceSink"

Property Value

"SalesforceSink"

writeBehavior

The write behavior for the operation. Default is Insert.

writeBehavior?: string

Property Value

string

Inherited Property Details

disableMetricsCollection

If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).

disableMetricsCollection?: any

Property Value

any

Inherited From CopySink.disableMetricsCollection

maxConcurrentConnections

The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer).

maxConcurrentConnections?: any

Property Value

any

Inherited From CopySink.maxConcurrentConnections

sinkRetryCount

Sink retry count. Type: integer (or Expression with resultType integer).

sinkRetryCount?: any

Property Value

any

Inherited From CopySink.sinkRetryCount

sinkRetryWait

Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

sinkRetryWait?: any

Property Value

any

Inherited From CopySink.sinkRetryWait

writeBatchSize

Write batch size. Type: integer (or Expression with resultType integer), minimum: 0.

writeBatchSize?: any

Property Value

any

Inherited From CopySink.writeBatchSize

writeBatchTimeout

Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

writeBatchTimeout?: any

Property Value

any

Inherited From CopySink.writeBatchTimeout