SqlMISource Class

public final class SqlMISource
extends TabularSource

A copy activity Azure SQL Managed Instance source.

Constructor Summary

Constructor Description
SqlMISource()

Creates an instance of SqlMISource class.

Method Summary

Modifier and Type Method and Description
static SqlMISource fromJson(JsonReader jsonReader)

Reads an instance of SqlMISource from the JsonReader.

Object isolationLevel()

Get the isolationLevel property: Specifies the transaction locking behavior for the SQL source.

Object partitionOption()

Get the partitionOption property: The partition mechanism that will be used for Sql read in parallel.

SqlPartitionSettings partitionSettings()

Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.

Object produceAdditionalTypes()

Get the produceAdditionalTypes property: Which additional types to produce.

Object sqlReaderQuery()

Get the sqlReaderQuery property: SQL reader query.

Object sqlReaderStoredProcedureName()

Get the sqlReaderStoredProcedureName property: Name of the stored procedure for a Azure SQL Managed Instance source.

Object storedProcedureParameters()

Get the storedProcedureParameters property: Value and type setting for stored procedure parameters.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: Copy source type.

void validate()

Validates the instance.

SqlMISource withAdditionalColumns(Object additionalColumns)

Set the additionalColumns property: Specifies the additional columns to be added to source data.

SqlMISource withDisableMetricsCollection(Object disableMetricsCollection)

Set the disableMetricsCollection property: If true, disable data store metrics collection.

SqlMISource withIsolationLevel(Object isolationLevel)

Set the isolationLevel property: Specifies the transaction locking behavior for the SQL source.

SqlMISource withMaxConcurrentConnections(Object maxConcurrentConnections)

Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store.

SqlMISource withPartitionOption(Object partitionOption)

Set the partitionOption property: The partition mechanism that will be used for Sql read in parallel.

SqlMISource withPartitionSettings(SqlPartitionSettings partitionSettings)

Set the partitionSettings property: The settings that will be leveraged for Sql source partitioning.

SqlMISource withProduceAdditionalTypes(Object produceAdditionalTypes)

Set the produceAdditionalTypes property: Which additional types to produce.

SqlMISource withQueryTimeout(Object queryTimeout)

Set the queryTimeout property: Query timeout.

SqlMISource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count.

SqlMISource withSourceRetryWait(Object sourceRetryWait)

Set the sourceRetryWait property: Source retry wait.

SqlMISource withSqlReaderQuery(Object sqlReaderQuery)

Set the sqlReaderQuery property: SQL reader query.

SqlMISource withSqlReaderStoredProcedureName(Object sqlReaderStoredProcedureName)

Set the sqlReaderStoredProcedureName property: Name of the stored procedure for a Azure SQL Managed Instance source.

SqlMISource withStoredProcedureParameters(Object storedProcedureParameters)

Set the storedProcedureParameters property: Value and type setting for stored procedure parameters.

Methods inherited from CopySource

Methods inherited from TabularSource

Methods inherited from java.lang.Object

Constructor Details

SqlMISource

public SqlMISource()

Creates an instance of SqlMISource class.

Method Details

fromJson

public static SqlMISource fromJson(JsonReader jsonReader)

Reads an instance of SqlMISource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SqlMISource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the SqlMISource.

isolationLevel

public Object isolationLevel()

Get the isolationLevel property: 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).

Returns:

the isolationLevel value.

partitionOption

public Object partitionOption()

Get the partitionOption property: 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).

Returns:

the partitionOption value.

partitionSettings

public SqlPartitionSettings partitionSettings()

Get the partitionSettings property: The settings that will be leveraged for Sql source partitioning.

Returns:

the partitionSettings value.

produceAdditionalTypes

public Object produceAdditionalTypes()

Get the produceAdditionalTypes property: Which additional types to produce.

Returns:

the produceAdditionalTypes value.

sqlReaderQuery

public Object sqlReaderQuery()

Get the sqlReaderQuery property: SQL reader query. Type: string (or Expression with resultType string).

Returns:

the sqlReaderQuery value.

sqlReaderStoredProcedureName

public Object sqlReaderStoredProcedureName()

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

Returns:

the sqlReaderStoredProcedureName value.

storedProcedureParameters

public Object storedProcedureParameters()

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

Returns:

the storedProcedureParameters value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SqlMISource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: Copy source type.

Overrides:

SqlMISource.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

SqlMISource.validate()

withAdditionalColumns

public SqlMISource withAdditionalColumns(Object additionalColumns)

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

Overrides:

SqlMISource.withAdditionalColumns(Object additionalColumns)

Parameters:

additionalColumns

withDisableMetricsCollection

public SqlMISource 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:

SqlMISource.withDisableMetricsCollection(Object disableMetricsCollection)

Parameters:

disableMetricsCollection

withIsolationLevel

public SqlMISource withIsolationLevel(Object isolationLevel)

Set the isolationLevel property: 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).

Parameters:

isolationLevel - the isolationLevel value to set.

Returns:

the SqlMISource object itself.

withMaxConcurrentConnections

public SqlMISource withMaxConcurrentConnections(Object maxConcurrentConnections)

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

Overrides:

SqlMISource.withMaxConcurrentConnections(Object maxConcurrentConnections)

Parameters:

maxConcurrentConnections

withPartitionOption

public SqlMISource withPartitionOption(Object partitionOption)

Set the partitionOption property: 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).

Parameters:

partitionOption - the partitionOption value to set.

Returns:

the SqlMISource object itself.

withPartitionSettings

public SqlMISource withPartitionSettings(SqlPartitionSettings partitionSettings)

Set the partitionSettings property: The settings that will be leveraged for Sql source partitioning.

Parameters:

partitionSettings - the partitionSettings value to set.

Returns:

the SqlMISource object itself.

withProduceAdditionalTypes

public SqlMISource withProduceAdditionalTypes(Object produceAdditionalTypes)

Set the produceAdditionalTypes property: Which additional types to produce.

Parameters:

produceAdditionalTypes - the produceAdditionalTypes value to set.

Returns:

the SqlMISource object itself.

withQueryTimeout

public SqlMISource withQueryTimeout(Object queryTimeout)

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

Overrides:

SqlMISource.withQueryTimeout(Object queryTimeout)

Parameters:

queryTimeout

withSourceRetryCount

public SqlMISource withSourceRetryCount(Object sourceRetryCount)

Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).

Overrides:

SqlMISource.withSourceRetryCount(Object sourceRetryCount)

Parameters:

sourceRetryCount

withSourceRetryWait

public SqlMISource withSourceRetryWait(Object sourceRetryWait)

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

Overrides:

SqlMISource.withSourceRetryWait(Object sourceRetryWait)

Parameters:

sourceRetryWait

withSqlReaderQuery

public SqlMISource withSqlReaderQuery(Object sqlReaderQuery)

Set the sqlReaderQuery property: SQL reader query. Type: string (or Expression with resultType string).

Parameters:

sqlReaderQuery - the sqlReaderQuery value to set.

Returns:

the SqlMISource object itself.

withSqlReaderStoredProcedureName

public SqlMISource withSqlReaderStoredProcedureName(Object sqlReaderStoredProcedureName)

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

Parameters:

sqlReaderStoredProcedureName - the sqlReaderStoredProcedureName value to set.

Returns:

the SqlMISource object itself.

withStoredProcedureParameters

public SqlMISource withStoredProcedureParameters(Object storedProcedureParameters)

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

Parameters:

storedProcedureParameters - the storedProcedureParameters value to set.

Returns:

the SqlMISource object itself.

Applies to