org.apache.flink.connector.jdbc.databases.sqlserver.dialect

Class SqlServerDialect

java.lang.Object

org.apache.flink.connector.jdbc.dialect.AbstractDialect

org.apache.flink.connector.jdbc.databases.sqlserver.dialect.SqlServerDialect

All Implemented Interfaces:

Serializable, JdbcDialect

@Internal
public class SqlServerDialect
extends AbstractDialect

JDBC dialect for SqlServer.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.connector.jdbc.dialect.AbstractDialect

AbstractDialect.Range

Constructor Summary

Constructors

Constructor and Description
SqlServerDialect()

Method Summary

Modifier and Type	Method and Description
Optional<AbstractDialect.Range>	decimalPrecisionRange() The maximum precision is supported by decimal.
Optional<String>	defaultDriverName()
String	dialectName() Get the name of jdbc dialect.
String	getLimitClause(long limit) Get limit clause to limit the number of emitted row from the jdbc source.
JdbcRowConverter	getRowConverter(org.apache.flink.table.types.logical.RowType rowType) Get converter that convert jdbc object and Flink internal object each other.
Optional<String>	getUpsertStatement(String tableName, String[] fieldNames, String[] uniqueKeyFields) Constructs the dialects upsert statement if supported; such as MySQL's DUPLICATE KEY UPDATE, or PostgreSQL's {@code ON CONFLICT...
String	quoteIdentifier(String identifier) Quotes the identifier.
Set<org.apache.flink.table.types.logical.LogicalTypeRoot>	supportedTypes() Defines the set of supported types for the dialect.
Optional<AbstractDialect.Range>	timestampPrecisionRange() The maximum precision is supported by datetime2.

Methods inherited from class org.apache.flink.connector.jdbc.dialect.AbstractDialect

getDeleteStatement, getInsertIntoStatement, getRowExistsStatement, getSelectFromStatement, getUpdateStatement, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.connector.jdbc.dialect.JdbcDialect

appendDefaultUrlProperties

Constructor Detail

SqlServerDialect

public SqlServerDialect()

Method Detail

dialectName

public String dialectName()

Description copied from interface: JdbcDialect

Get the name of jdbc dialect.

Returns:

the dialect name.

timestampPrecisionRange

public Optional<AbstractDialect.Range> timestampPrecisionRange()

The maximum precision is supported by datetime2. https://docs.microsoft.com/en-us/sql/t-sql/data-types/datetime2-transact-sql?view=sql-server-ver16

Overrides:

timestampPrecisionRange in class AbstractDialect

Returns:

The inclusive range [min,max] of supported precisions for TimestampType columns. None if timestamp type is not supported.

decimalPrecisionRange

public Optional<AbstractDialect.Range> decimalPrecisionRange()

The maximum precision is supported by decimal. https://docs.microsoft.com/en-us/sql/t-sql/data-types/precision-scale-and-length-transact-sql?view=sql-server-ver16

Overrides:

decimalPrecisionRange in class AbstractDialect

Returns:

The inclusive range [min,max] of supported precisions for DecimalType columns. None if decimal type is not supported.

defaultDriverName

public Optional<String> defaultDriverName()

Returns:

the default driver class name, if user has not configured the driver class name, then this one will be used.

quoteIdentifier

public String quoteIdentifier(String identifier)

Description copied from interface: JdbcDialect

Quotes the identifier.

Used to put quotes around the identifier if the column name is a reserved keyword or contains characters requiring quotes (e.g., space).

Returns:

the quoted identifier.

getUpsertStatement

public Optional<String> getUpsertStatement(String tableName,
                                           String[] fieldNames,
                                           String[] uniqueKeyFields)

Description copied from interface: JdbcDialect

Constructs the dialects upsert statement if supported; such as MySQL's DUPLICATE KEY UPDATE, or PostgreSQL's ON CONFLICT... DO UPDATE SET... If supported, the returned string will be used as a PreparedStatement. Fields in the statement must be in the same order as the fieldNames parameter.

If the dialect does not support native upsert statements, the writer will fallback to SELECT + UPDATE/INSERT which may have poor performance.

Returns:

The upsert statement if supported, otherwise None.

getRowConverter

public JdbcRowConverter getRowConverter(org.apache.flink.table.types.logical.RowType rowType)

Description copied from interface: JdbcDialect

Get converter that convert jdbc object and Flink internal object each other.

Parameters:

rowType - the given row type

Returns:

a row converter for the database

getLimitClause

public String getLimitClause(long limit)

Description copied from interface: JdbcDialect

Get limit clause to limit the number of emitted row from the jdbc source.

Parameters:

limit - number of row to emit. The value of the parameter should be non-negative.

Returns:

the limit clause.

supportedTypes

public Set<org.apache.flink.table.types.logical.LogicalTypeRoot> supportedTypes()

Description copied from class: AbstractDialect

Defines the set of supported types for the dialect. If the dialect supports DECIMAL or TIMESTAMP types, be sure to override AbstractDialect.decimalPrecisionRange() and AbstractDialect.timestampPrecisionRange() respectively.

Specified by:

supportedTypes in class AbstractDialect

Returns:

a set of logical type roots.