Share via


SqlServerSink Class

Definition

A copy activity SQL server sink.

public class SqlServerSink : Azure.ResourceManager.DataFactory.Models.CopySink, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataFactory.Models.SqlServerSink>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataFactory.Models.SqlServerSink>
public class SqlServerSink : Azure.ResourceManager.DataFactory.Models.CopySink
Inheritance
SqlServerSink
Implements

Constructors

SqlServerSink()

Initializes a new instance of SqlServerSink.

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)
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)
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)
SqlWriterStoredProcedureName

SQL writer stored procedure name. Type: string (or Expression with resultType string).

SqlWriterTableType

SQL writer table type. Type: string (or Expression with resultType string).

SqlWriterUseTableLock

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

StoredProcedureParameters

SQL stored procedure parameters.

To assign an object to 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" }.

StoredProcedureTableTypeParameterName

The stored procedure parameter name of the table type. Type: string (or Expression with resultType string).

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 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 sql server. Type: string (or Expression with resultType string).

Methods

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<SqlServerSink>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<SqlServerSink>.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<SqlServerSink>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SqlServerSink>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<SqlServerSink>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to

Product Versions
Azure SDK for .NET Latest, Preview