SqlDWSink Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.0.0-beta.27

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.CopySink
  • • com.azure.resourcemanager.datafactory.models.SqlDWSink

public final class SqlDWSink
extends CopySink

A copy activity SQL Data Warehouse sink.

Constructor Summary

Constructor	Description
SqlDWSink()	Creates an instance of SqlDWSink class.

Method Summary

Modifier and Type	Method and Description
Object	allowCopyCommand() Get the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse.
Object	allowPolyBase() Get the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable.
DWCopyCommandSettings	copyCommandSettings() Get the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.
PolybaseSettings	polyBaseSettings() Get the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.
Object	preCopyScript() Get the preCopyScript property: SQL pre-copy script.
Object	sqlWriterUseTableLock() Get the sqlWriterUseTableLock property: Whether to use table lock during bulk copy.
Object	tableOption() Get the tableOption property: The option to handle sink table, such as autoCreate.
SqlDWUpsertSettings	upsertSettings() Get the upsertSettings property: SQL DW upsert settings.
void	validate() Validates the instance.
SqlDWSink	withAllowCopyCommand(Object allowCopyCommand) Set the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse.
SqlDWSink	withAllowPolyBase(Object allowPolyBase) Set the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable.
SqlDWSink	withCopyCommandSettings(DWCopyCommandSettings copyCommandSettings) Set the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.
SqlDWSink	withDisableMetricsCollection(Object disableMetricsCollection) Set the disableMetricsCollection property: If true, disable data store metrics collection.
SqlDWSink	withMaxConcurrentConnections(Object maxConcurrentConnections) Set the maxConcurrentConnections property: The maximum concurrent connection count for the sink data store.
SqlDWSink	withPolyBaseSettings(PolybaseSettings polyBaseSettings) Set the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.
SqlDWSink	withPreCopyScript(Object preCopyScript) Set the preCopyScript property: SQL pre-copy script.
SqlDWSink	withSinkRetryCount(Object sinkRetryCount) Set the sinkRetryCount property: Sink retry count.
SqlDWSink	withSinkRetryWait(Object sinkRetryWait) Set the sinkRetryWait property: Sink retry wait.
SqlDWSink	withSqlWriterUseTableLock(Object sqlWriterUseTableLock) Set the sqlWriterUseTableLock property: Whether to use table lock during bulk copy.
SqlDWSink	withTableOption(Object tableOption) Set the tableOption property: The option to handle sink table, such as autoCreate.
SqlDWSink	withUpsertSettings(SqlDWUpsertSettings upsertSettings) Set the upsertSettings property: SQL DW upsert settings.
SqlDWSink	withWriteBatchSize(Object writeBatchSize) Set the writeBatchSize property: Write batch size.
SqlDWSink	withWriteBatchTimeout(Object writeBatchTimeout) Set the writeBatchTimeout property: Write batch timeout.
SqlDWSink	withWriteBehavior(Object writeBehavior) Set the writeBehavior property: Write behavior when copying data into azure SQL DW.
Object	writeBehavior() Get the writeBehavior property: Write behavior when copying data into azure SQL DW.

Methods inherited from CopySink

additionalProperties disableMetricsCollection maxConcurrentConnections sinkRetryCount sinkRetryWait validate withAdditionalProperties withDisableMetricsCollection withMaxConcurrentConnections withSinkRetryCount withSinkRetryWait withWriteBatchSize withWriteBatchTimeout writeBatchSize writeBatchTimeout

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlDWSink

public SqlDWSink()

Creates an instance of SqlDWSink class.

Method Details

allowCopyCommand

public Object allowCopyCommand()

Get the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).

Returns:

the allowCopyCommand value.

allowPolyBase

public Object allowPolyBase()

Get the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).

Returns:

the allowPolyBase value.

copyCommandSettings

public DWCopyCommandSettings copyCommandSettings()

Get the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.

Returns:

the copyCommandSettings value.

polyBaseSettings

public PolybaseSettings polyBaseSettings()

Get the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.

Returns:

the polyBaseSettings value.

preCopyScript

public Object preCopyScript()

Get the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).

Returns:

the preCopyScript value.

sqlWriterUseTableLock

public Object sqlWriterUseTableLock()

Get the sqlWriterUseTableLock property: Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).

Returns:

the sqlWriterUseTableLock value.

tableOption

public Object tableOption()

Get the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).

Returns:

the tableOption value.

upsertSettings

public SqlDWUpsertSettings upsertSettings()

Get the upsertSettings property: SQL DW upsert settings.

Returns:

the upsertSettings value.

validate

public void validate()

Validates the instance.

Overrides:

SqlDWSink.validate()

withAllowCopyCommand

public SqlDWSink withAllowCopyCommand(Object allowCopyCommand)

Set the allowCopyCommand property: Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean).

Parameters:

allowCopyCommand - the allowCopyCommand value to set.

Returns:

the SqlDWSink object itself.

withAllowPolyBase

public SqlDWSink withAllowPolyBase(Object allowPolyBase)

Set the allowPolyBase property: Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean).

Parameters:

allowPolyBase - the allowPolyBase value to set.

Returns:

the SqlDWSink object itself.

withCopyCommandSettings

public SqlDWSink withCopyCommandSettings(DWCopyCommandSettings copyCommandSettings)

Set the copyCommandSettings property: Specifies Copy Command related settings when allowCopyCommand is true.

Parameters:

copyCommandSettings - the copyCommandSettings value to set.

Returns:

the SqlDWSink object itself.

withDisableMetricsCollection

public SqlDWSink withDisableMetricsCollection(Object disableMetricsCollection)

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

Overrides:

SqlDWSink.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withMaxConcurrentConnections

public SqlDWSink withMaxConcurrentConnections(Object maxConcurrentConnections)

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

Overrides:

SqlDWSink.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withPolyBaseSettings

public SqlDWSink withPolyBaseSettings(PolybaseSettings polyBaseSettings)

Set the polyBaseSettings property: Specifies PolyBase-related settings when allowPolyBase is true.

Parameters:

polyBaseSettings - the polyBaseSettings value to set.

Returns:

the SqlDWSink object itself.

withPreCopyScript

public SqlDWSink withPreCopyScript(Object preCopyScript)

Set the preCopyScript property: SQL pre-copy script. Type: string (or Expression with resultType string).

Parameters:

preCopyScript - the preCopyScript value to set.

Returns:

the SqlDWSink object itself.

withSinkRetryCount

public SqlDWSink withSinkRetryCount(Object sinkRetryCount)

Set the sinkRetryCount property: Sink retry count. Type: integer (or Expression with resultType integer).

Overrides:

SqlDWSink.withSinkRetryCount(Object sinkRetryCount)

Parameters:

sinkRetryCount

withSinkRetryWait

public SqlDWSink withSinkRetryWait(Object sinkRetryWait)

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

Overrides:

SqlDWSink.withSinkRetryWait(Object sinkRetryWait)

Parameters:

sinkRetryWait

withSqlWriterUseTableLock

public SqlDWSink withSqlWriterUseTableLock(Object sqlWriterUseTableLock)

Set the sqlWriterUseTableLock property: Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean).

Parameters:

sqlWriterUseTableLock - the sqlWriterUseTableLock value to set.

Returns:

the SqlDWSink object itself.

withTableOption

public SqlDWSink withTableOption(Object tableOption)

Set the tableOption property: The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string).

Parameters:

tableOption - the tableOption value to set.

Returns:

the SqlDWSink object itself.

withUpsertSettings

public SqlDWSink withUpsertSettings(SqlDWUpsertSettings upsertSettings)

Set the upsertSettings property: SQL DW upsert settings.

Parameters:

upsertSettings - the upsertSettings value to set.

Returns:

the SqlDWSink object itself.

withWriteBatchSize

public SqlDWSink withWriteBatchSize(Object writeBatchSize)

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

Overrides:

SqlDWSink.withWriteBatchSize(Object writeBatchSize)

Parameters:

writeBatchSize

withWriteBatchTimeout

public SqlDWSink withWriteBatchTimeout(Object writeBatchTimeout)

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

Overrides:

SqlDWSink.withWriteBatchTimeout(Object writeBatchTimeout)

Parameters:

writeBatchTimeout

withWriteBehavior

public SqlDWSink withWriteBehavior(Object writeBehavior)

Set the writeBehavior property: Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum).

Parameters:

writeBehavior - the writeBehavior value to set.

Returns:

the SqlDWSink object itself.

writeBehavior

public Object writeBehavior()

Get the writeBehavior property: Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum).

Returns:

the writeBehavior value.