io.debezium.connector.mysql

Class MySqlValueConverters

java.lang.Object

io.debezium.jdbc.JdbcValueConverters

io.debezium.connector.mysql.MySqlValueConverters

All Implemented Interfaces:

ValueConverterProvider

@Immutable
public class MySqlValueConverters
extends JdbcValueConverters

MySQL-specific customization of the conversions from JDBC values obtained from the MySQL binlog client library.

This class always uses UTC for the default time zone when converting values without timezone information to values that require timezones. This is because MySQL TIMESTAMP values are always stored in UTC (unlike DATETIME values) and are replicated in this form. Meanwhile, the MySQL Binlog Client library will deserialize these as Timestamp values that have no timezone and, therefore, are presumed to be in UTC. When the column is properly marked with a Types.TIMESTAMP_WITH_TIMEZONE type, the converters will need to convert that Timestamp value into an OffsetDateTime using the default time zone, which always is UTC.

Author:

Randall Hauch

See Also:

AbstractRowsEventDataDeserializer

Field Summary

Fields inherited from class io.debezium.jdbc.JdbcValueConverters

logger

Constructor Summary

Constructors

Constructor and Description
MySqlValueConverters(boolean adaptiveTimePrecision) Create a new instance that always uses UTC for the default time zone when converting values without timezone information to values that require timezones.
MySqlValueConverters(boolean adaptiveTimePrecision, ZoneOffset defaultOffset) Create a new instance, and specify the time zone offset that should be used only when converting values without timezone information to values that require timezones.

Method Summary

Modifier and Type	Method and Description
protected ByteOrder	byteOrderOfBitType()
protected Charset	charsetFor(Column column) Return the Charset instance with the MySQL-specific character set name used by the given column.
protected Object	convertEnumToString(List<String> options, Column column, org.apache.kafka.connect.data.Field fieldDefn, Object data) Converts a value object for a MySQL ENUM, which is represented in the binlog events as an integer value containing the index of the enum option.
ValueConverter	converter(Column column, org.apache.kafka.connect.data.Field fieldDefn)
protected Object	convertSetToString(List<String> options, Column column, org.apache.kafka.connect.data.Field fieldDefn, Object data) Converts a value object for a MySQL SET, which is represented in the binlog events contain a long number in which every bit corresponds to a different option.
protected String	convertSetValue(Column column, long indexes, List<String> options)
protected Object	convertString(Column column, org.apache.kafka.connect.data.Field fieldDefn, Charset columnCharset, Object data) Convert the String or byte[] value to a string value used in a SourceRecord.
protected Object	convertYearToInt(Column column, org.apache.kafka.connect.data.Field fieldDefn, Object data) Converts a value object for a MySQL YEAR, which appear in the binlog as an integer though returns from the MySQL JDBC driver as either a short or a Date.
protected List<String>	extractEnumAndSetOptions(Column column)
protected String	extractEnumAndSetOptionsAsString(Column column)
protected boolean	matches(String upperCaseTypeName, String upperCaseMatch) Determine if the uppercase form of a column's type exactly matches or begins with the specified prefix.
org.apache.kafka.connect.data.SchemaBuilder	schemaBuilder(Column column)

Methods inherited from class io.debezium.jdbc.JdbcValueConverters

convertBigInt, convertBinary, convertBit, convertBits, convertBoolean, convertDateToEpochDays, convertDateToEpochDaysAsDate, convertDecimal, convertDouble, convertFloat, convertInteger, convertNumeric, convertReal, convertRowId, convertSmallInt, convertString, convertTimestampToEpochMicros, convertTimestampToEpochMillis, convertTimestampToEpochMillisAsDate, convertTimestampToEpochNanos, convertTimestampWithZone, convertTimeToMicrosPastMidnight, convertTimeToMillisPastMidnight, convertTimeToMillisPastMidnightAsDate, convertTimeToNanosPastMidnight, convertTimeWithZone, convertTinyInt, handleUnknownData, padLittleEndian, unexpectedBinary

Methods inherited from class java.lang.Object

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

Constructor Detail

MySqlValueConverters

public MySqlValueConverters(boolean adaptiveTimePrecision)

Create a new instance that always uses UTC for the default time zone when converting values without timezone information to values that require timezones.

Parameters:

adaptiveTimePrecision - true if the time, date, and timestamp values should be based upon the precision of the database columns using io.debezium.time semantic types, or false if they should be fixed to millisecond precision using Kafka Connect org.apache.kafka.connect.data logical types.

MySqlValueConverters

public MySqlValueConverters(boolean adaptiveTimePrecision,
                            ZoneOffset defaultOffset)

Create a new instance, and specify the time zone offset that should be used only when converting values without timezone information to values that require timezones. This default offset should not be needed when values are highly-correlated with the expected SQL/JDBC types.

Parameters:

adaptiveTimePrecision - true if the time, date, and timestamp values should be based upon the precision of the database columns using io.debezium.time semantic types, or false if they should be fixed to millisecond precision using Kafka Connect org.apache.kafka.connect.data logical types.

defaultOffset - the zone offset that is to be used when converting non-timezone related values to values that do have timezones; may be null if UTC is to be used

Method Detail

byteOrderOfBitType

protected ByteOrder byteOrderOfBitType()

Overrides:

byteOrderOfBitType in class JdbcValueConverters

schemaBuilder

public org.apache.kafka.connect.data.SchemaBuilder schemaBuilder(Column column)

Specified by:

schemaBuilder in interface ValueConverterProvider

Overrides:

schemaBuilder in class JdbcValueConverters

converter

public ValueConverter converter(Column column,
                                org.apache.kafka.connect.data.Field fieldDefn)

Specified by:

converter in interface ValueConverterProvider

Overrides:

converter in class JdbcValueConverters

charsetFor

protected Charset charsetFor(Column column)

Return the Charset instance with the MySQL-specific character set name used by the given column.

Parameters:

column - the column in which the character set is used; never null

Returns:

the Java Charset, or null if there is no mapping

convertString

protected Object convertString(Column column,
                               org.apache.kafka.connect.data.Field fieldDefn,
                               Charset columnCharset,
                               Object data)

Convert the String or byte[] value to a string value used in a SourceRecord.

Parameters:

column - the column in which the value appears

fieldDefn - the field definition for the SourceRecord's Schema; never null

columnCharset - the Java character set in which column byte[] values are encoded; may not be null

data - the data; may be null

Returns:

the converted value, or null if the conversion could not be made and the column allows nulls

Throws:

IllegalArgumentException - if the value could not be converted but the column does not allow nulls

convertYearToInt

protected Object convertYearToInt(Column column,
                                  org.apache.kafka.connect.data.Field fieldDefn,
                                  Object data)

Converts a value object for a MySQL YEAR, which appear in the binlog as an integer though returns from the MySQL JDBC driver as either a short or a Date.

Parameters:

column - the column definition describing the data value; never null

fieldDefn - the field definition; never null

data - the data object to be converted into a year literal integer value; never null

Returns:

the converted value, or null if the conversion could not be made and the column allows nulls

Throws:

IllegalArgumentException - if the value could not be converted but the column does not allow nulls

convertEnumToString

protected Object convertEnumToString(List<String> options,
                                     Column column,
                                     org.apache.kafka.connect.data.Field fieldDefn,
                                     Object data)

Converts a value object for a MySQL ENUM, which is represented in the binlog events as an integer value containing the index of the enum option. The MySQL JDBC driver returns a string containing the option, so this method calculates the same.

Parameters:

options - the characters that appear in the same order as defined in the column; may not be null

column - the column definition describing the data value; never null

fieldDefn - the field definition; never null

data - the data object to be converted into an ENUM literal String value

Returns:

the converted value, or null if the conversion could not be made and the column allows nulls

Throws:

IllegalArgumentException - if the value could not be converted but the column does not allow nulls

convertSetToString

protected Object convertSetToString(List<String> options,
                                    Column column,
                                    org.apache.kafka.connect.data.Field fieldDefn,
                                    Object data)

Converts a value object for a MySQL SET, which is represented in the binlog events contain a long number in which every bit corresponds to a different option. The MySQL JDBC driver returns a string containing the comma-separated options, so this method calculates the same.

Parameters:

options - the characters that appear in the same order as defined in the column; may not be null

column - the column definition describing the data value; never null

fieldDefn - the field definition; never null

data - the data object to be converted into an SET literal String value; never null

Returns:

the converted value, or null if the conversion could not be made and the column allows nulls

Throws:

IllegalArgumentException - if the value could not be converted but the column does not allow nulls

matches

protected boolean matches(String upperCaseTypeName,
                          String upperCaseMatch)

Determine if the uppercase form of a column's type exactly matches or begins with the specified prefix. Note that this logic works when the column's type contains the type name followed by parentheses.

Parameters:

upperCaseTypeName - the upper case form of the column's type name

upperCaseMatch - the upper case form of the expected type or prefix of the type; may not be null

Returns:

true if the type matches the specified type, or false otherwise

extractEnumAndSetOptions

protected List<String> extractEnumAndSetOptions(Column column)

extractEnumAndSetOptionsAsString

protected String extractEnumAndSetOptionsAsString(Column column)

convertSetValue

protected String convertSetValue(Column column,
                                 long indexes,
                                 List<String> options)