Package org.apache.flink.connector.jdbc.databases.mysql.dialect

Class MySqlDialect

java.lang.Object

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

org.apache.flink.connector.jdbc.databases.mysql.dialect.MySqlDialect

All Implemented Interfaces:

Serializable, JdbcDialect

@Internal
public class MySqlDialect
extends AbstractDialect

JDBC dialect for MySQL.

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	Description
MySqlDialect()

Method Summary

Modifier and Type	Method	Description
String	appendDefaultUrlProperties(String url)	Appends default JDBC properties to url for current dialect.
Optional<AbstractDialect.Range>	decimalPrecisionRange()
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)	Mysql upsert query use DUPLICATE KEY UPDATE.
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()

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

Constructor Detail

MySqlDialect

public MySqlDialect()

Method Detail

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.

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)

Mysql upsert query use DUPLICATE KEY UPDATE.

NOTE: It requires Mysql's primary key to be consistent with pkFields.

We don't use REPLACE INTO, if there are other fields, we can keep their previous values.

Returns:

The upsert statement if supported, otherwise None.

dialectName

public String dialectName()

Description copied from interface: JdbcDialect

Get the name of jdbc dialect.

Returns:

the dialect name.

decimalPrecisionRange

public Optional<AbstractDialect.Range> decimalPrecisionRange()

Overrides:

decimalPrecisionRange in class AbstractDialect

Returns:

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

timestampPrecisionRange

public Optional<AbstractDialect.Range> timestampPrecisionRange()

Overrides:

timestampPrecisionRange in class AbstractDialect

Returns:

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

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.

appendDefaultUrlProperties

public String appendDefaultUrlProperties(String url)

Description copied from interface: JdbcDialect

Appends default JDBC properties to url for current dialect. Some database dialects will set default JDBC properties for performance or optimization consideration, such as MySQL dialect uses 'rewriteBatchedStatements=true' to enable execute multiple MySQL statements in batch mode.

Returns:

A JDBC url that has appended the default properties.