Share via


SqlDWSink Class

Definition

A copy activity SQL Data Warehouse sink.

public class SqlDWSink : Azure.ResourceManager.DataFactory.Models.CopySink, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.SqlDWSink>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.SqlDWSink>
public class SqlDWSink : Azure.ResourceManager.DataFactory.Models.CopySink
type SqlDWSink = class
    inherit CopySink
    interface IJsonModel<SqlDWSink>
    interface IPersistableModel<SqlDWSink>
type SqlDWSink = class
    inherit CopySink
Public Class SqlDWSink
Inherits CopySink
Implements IJsonModel(Of SqlDWSink), IPersistableModel(Of SqlDWSink)
Public Class SqlDWSink
Inherits CopySink
Inheritance
SqlDWSink
Implements

Constructors

SqlDWSink()

Initializes a new instance of SqlDWSink.

Properties

AdditionalProperties

Additional Properties

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from CopySink)
AllowCopyCommand

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

AllowPolyBase

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

CopyCommandSettings

Specifies Copy Command related settings when allowCopyCommand is true.

DisableMetricsCollection

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

(Inherited from CopySink)
MaxConcurrentConnections

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

(Inherited from CopySink)
PolyBaseSettings

Specifies PolyBase-related settings when allowPolyBase is true.

PreCopyScript

SQL pre-copy script. Type: string (or Expression with resultType string).

SinkRetryCount

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

(Inherited from CopySink)
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])).

(Inherited from CopySink)
SqlWriterUseTableLock

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

TableOption

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

UpsertSettings

SQL DW upsert settings.

WriteBatchSize

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

(Inherited from CopySink)
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])).

(Inherited from CopySink)
WriteBehavior

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from CopySink)

Explicit Interface Implementations

IJsonModel<CopySink>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from CopySink)
IJsonModel<CopySink>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from CopySink)
IJsonModel<SqlDWSink>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SqlDWSink>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CopySink>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from CopySink)
IPersistableModel<CopySink>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from CopySink)
IPersistableModel<CopySink>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from CopySink)
IPersistableModel<SqlDWSink>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SqlDWSink>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SqlDWSink>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to