SqlPartitionSettings Class

Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.17
  • java.lang.Object
    • com.azure.analytics.synapse.artifacts.models.SqlPartitionSettings

Implements

JsonSerializable<SqlPartitionSettings>

public final class SqlPartitionSettings
implements JsonSerializable<SqlPartitionSettings>

The settings that will be leveraged for Sql source partitioning.

Constructor Summary

Constructor Description
SqlPartitionSettings()

Creates an instance of SqlPartitionSettings class.

Method Summary

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

Reads an instance of SqlPartitionSettings from the JsonReader.
Object getPartitionColumnName()

Get the partitionColumnName property: The name of the column in integer or datetime type that will be used for proceeding partitioning.
Object getPartitionLowerBound()

Get the partitionLowerBound property: The minimum value of the partition column for partition range splitting.
Object getPartitionUpperBound()

Get the partitionUpperBound property: The maximum value of the partition column for partition range splitting.
SqlPartitionSettings setPartitionColumnName(Object partitionColumnName)

Set the partitionColumnName property: The name of the column in integer or datetime type that will be used for proceeding partitioning.
SqlPartitionSettings setPartitionLowerBound(Object partitionLowerBound)

Set the partitionLowerBound property: The minimum value of the partition column for partition range splitting.
SqlPartitionSettings setPartitionUpperBound(Object partitionUpperBound)

Set the partitionUpperBound property: The maximum value of the partition column for partition range splitting.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlPartitionSettings

public SqlPartitionSettings()

Creates an instance of SqlPartitionSettings class.

Method Details

fromJson

public static SqlPartitionSettings fromJson(JsonReader jsonReader)

Reads an instance of SqlPartitionSettings from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SqlPartitionSettings 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 SqlPartitionSettings.

getPartitionColumnName

public Object getPartitionColumnName()

Get the partitionColumnName property: The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string).

Returns:

the partitionColumnName value.

getPartitionLowerBound

public Object getPartitionLowerBound()

Get the partitionLowerBound property: The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

Returns:

the partitionLowerBound value.

getPartitionUpperBound

public Object getPartitionUpperBound()

Get the partitionUpperBound property: The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

Returns:

the partitionUpperBound value.

setPartitionColumnName

public SqlPartitionSettings setPartitionColumnName(Object partitionColumnName)

Set the partitionColumnName property: The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string).

Parameters:

partitionColumnName - the partitionColumnName value to set.

Returns:

the SqlPartitionSettings object itself.

setPartitionLowerBound

public SqlPartitionSettings setPartitionLowerBound(Object partitionLowerBound)

Set the partitionLowerBound property: The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

Parameters:

partitionLowerBound - the partitionLowerBound value to set.

Returns:

the SqlPartitionSettings object itself.

setPartitionUpperBound

public SqlPartitionSettings setPartitionUpperBound(Object partitionUpperBound)

Set the partitionUpperBound property: The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string).

Parameters:

partitionUpperBound - the partitionUpperBound value to set.

Returns:

the SqlPartitionSettings object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to