SqlSource Class

Definition

A copy activity SQL source.

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

Constructors

SqlSource()

Initializes a new instance of SqlSource.

Properties

AdditionalColumns

Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).

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" }.
(Inherited from TabularSource)
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 CopyActivitySource)
DisableMetricsCollection

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

(Inherited from CopyActivitySource)
IsolationLevel

Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).

MaxConcurrentConnections

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

(Inherited from CopyActivitySource)
PartitionOption

The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string).

PartitionSettings

The settings that will be leveraged for Sql source partitioning.

QueryTimeout

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

(Inherited from TabularSource)
SourceRetryCount

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

(Inherited from CopyActivitySource)
SourceRetryWait

Source 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 CopyActivitySource)
SqlReaderQuery

SQL reader query. Type: string (or Expression with resultType string).

SqlReaderStoredProcedureName

Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string).

StoredProcedureParameters

Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

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" }.

Explicit Interface Implementations

IJsonModel<CopyActivitySource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from CopyActivitySource)
IJsonModel<SqlSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<SqlSource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<TabularSource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from TabularSource)
IPersistableModel<CopyActivitySource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from CopyActivitySource)
IPersistableModel<SqlSource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SqlSource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<SqlSource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<TabularSource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from TabularSource)

Applies to