io.debezium.connector.mysql

Class MySqlDdlParser

java.lang.Object

io.debezium.relational.ddl.DdlParser

io.debezium.connector.mysql.MySqlDdlParser

@NotThreadSafe
public class MySqlDdlParser
extends DdlParser

A parser for DDL statements.

See the MySQL SQL Syntax documentation for the grammar supported by this parser.

Author:

Randall Hauch

Nested Class Summary

Nested classes/interfaces inherited from class io.debezium.relational.ddl.DdlParser

DdlParser.TokenSet

Field Summary

Fields

Modifier and Type	Field and Description
private ConcurrentMap<String,String>	charsetNameForDatabase
private static String	SERVER_CHARSET_NAME The system variable name for the name of the character set that the server uses by default.
private MySqlSystemVariables	systemVariables

Fields inherited from class io.debezium.relational.ddl.DdlParser

databaseTables, dataTypeParser, logger, skipViews, tokens

Constructor Summary

Constructors

Constructor and Description
MySqlDdlParser() Create a new DDL parser for MySQL that does not include view definitions.
MySqlDdlParser(boolean includeViews) Create a new DDL parser for MySQL.

Method Summary

Modifier and Type	Method and Description
protected void	consumeBeginStatement(TokenStream.Marker start) Consume the entire BEGIN...END block that appears next in the token stream.
protected void	consumeCommaSeparatedValueList(TokenStream.Marker start)
protected void	consumeExpression(TokenStream.Marker start) Consume an expression surrounded by parentheses.
protected void	consumeValueList(TokenStream.Marker start)
protected String	currentDatabaseCharset() Get the name of the character set for the current database, via the "character_set_database" system property.
protected String	getPrecedingBlockLabel() Get the label that appears with a colon character just prior to the current position.
protected void	initializeDataTypes(DataTypeParser dataTypes)
protected void	initializeKeywords(DdlParser.TokenSet keywords)
protected void	initializeStatementStarts(DdlParser.TokenSet statementStartTokens)
protected void	parseAlter(TokenStream.Marker marker)
protected void	parseAlterDatabase(TokenStream.Marker start)
protected void	parseAlterSpecification(TokenStream.Marker start, TableEditor table, Consumer<TableId> newTableName)
protected void	parseAlterSpecificationList(TokenStream.Marker start, TableEditor table, Consumer<TableId> newTableName)
protected void	parseAlterTable(TokenStream.Marker start)
protected void	parseAlterUnknown(TokenStream.Marker start)
protected void	parseAsSelectStatement(TokenStream.Marker start, TableEditor table)
protected void	parseColumnDefinition(TokenStream.Marker start, String columnName, TokenStream tokens, TableEditor table, ColumnEditor column, AtomicBoolean isPrimaryKey)
protected String	parseColumnName()
protected List<String>	parseColumnNameList(TokenStream.Marker start)
protected void	parseCreate(TokenStream.Marker marker)
protected Column	parseCreateColumn(TokenStream.Marker start, TableEditor table, String columnName, String newColumnName)
protected void	parseCreateDatabase(TokenStream.Marker start)
protected void	parseCreateDefinition(TokenStream.Marker start, TableEditor table)
protected void	parseCreateDefinitionList(TokenStream.Marker start, TableEditor table)
protected void	parseCreateEvent(TokenStream.Marker start)
protected void	parseCreateIndex(TokenStream.Marker start)
protected void	parseCreateProcedure(TokenStream.Marker start)
protected void	parseCreateTable(TokenStream.Marker start)
protected void	parseCreateTrigger(TokenStream.Marker start)
protected void	parseCreateUnknown(TokenStream.Marker start)
protected void	parseCreateView(TokenStream.Marker start)
private void	parseCurrentTimestampOrNow()
protected void	parseDatabaseOptions(TokenStream.Marker start, String dbName)
protected void	parseDefaultClause(TokenStream.Marker start) Parse and consume the DEFAULT clause.
protected void	parseDefiner(TokenStream.Marker start)
protected String	parseDomainName(TokenStream.Marker start)
protected void	parseDrop(TokenStream.Marker marker)
protected void	parseDropDatabase(TokenStream.Marker start)
protected void	parseDropIndex(TokenStream.Marker start)
protected void	parseDropTable(TokenStream.Marker start)
protected void	parseDropUnknown(TokenStream.Marker start)
protected void	parseDropView(TokenStream.Marker start)
private void	parseIndexColumnName(Consumer<String> name)
protected List<String>	parseIndexColumnNames(TokenStream.Marker start)
protected void	parseIndexOptions(TokenStream.Marker start)
protected void	parseIndexType(TokenStream.Marker start)
protected void	parseNextStatement(TokenStream.Marker marker)
protected void	parseOnUpdateOrDelete(TokenStream.Marker start)
protected void	parsePartitionDefinition(TokenStream.Marker start, TableEditor table)
protected void	parsePartitionNames(TokenStream.Marker start)
protected void	parsePartitionOptions(TokenStream.Marker start, TableEditor table)
protected void	parseReferenceDefinition(TokenStream.Marker start)
protected void	parseReferenceOption(TokenStream.Marker start)
protected void	parseRename(TokenStream.Marker start)
protected void	parseRenameTable(TokenStream.Marker start)
protected void	parseSet(TokenStream.Marker start)
static List<String>	parseSetAndEnumOptions(String typeExpression) Parse the ENUM or SET data type expression to extract the character options, where the index(es) appearing in the ENUM or SET values can be used to identify the acceptable characters.
protected void	parseSetVariable(TokenStream.Marker start, AtomicReference<MySqlSystemVariables.Scope> scope)
protected void	parseSubpartitionDefinition(TokenStream.Marker start, TableEditor table)
protected boolean	parseTableOption(TokenStream.Marker start, TableEditor table)
protected void	parseTableOptions(TokenStream.Marker start, TableEditor table)
protected void	parseUse(TokenStream.Marker marker)
protected String	parseVariableName()
protected String	parseVariableValue()
protected void	sequentially(Consumer<TokenStream.Marker>... functions) Try calling the supplied functions in sequence, stopping as soon as one of them succeeds.
protected MySqlSystemVariables	systemVariables()
protected static String	withoutQuotes(String possiblyQuoted)

Methods inherited from class io.debezium.relational.ddl.DdlParser

accumulateParsingFailure, accumulateParsingFailure, addListener, canConsumeJoin, canConsumeJoinCondition, consumeDoubleQuotedString, consumeQuotedString, consumeRemainingStatement, consumeSingleQuotedString, consumeStatement, createColumnFromConstant, currentSchema, debugParsed, debugSkipped, determineTokenType, determineTypeNameForConstant, determineTypeNameForConstant, determineTypeNameForConstant, determineTypeNameForConstant, isNextTokenQuotedIdentifier, parse, parse, parseBitFieldLiteral, parseCharacterLiteral, parseCharacterSetName, parseColumnName, parseColumnsInSelectClause, parseComment, parseDateLiteral, parseLiteral, parseNumericLiteral, parseQualifiedTableName, parseQualifiedTableNames, parseSchemaQualifiedName, parseSelectFromClause, parseTimeLiteral, parseTimestampLiteral, parseUnknownStatement, parsingFailed, parsingFailed, parsingFailed, removeListener, removeListeners, resolveTableId, setCurrentSchema, setTypeInfoForConstant, signalAlterDatabase, signalAlterTable, signalAlterTable, signalAlterView, signalCreateDatabase, signalCreateIndex, signalCreateTable, signalCreateView, signalDropDatabase, signalDropIndex, signalDropTable, signalDropTable, signalDropView, signalDropView, signalEvent, skipComments, statement, terminator

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_CHARSET_NAME

private static final String SERVER_CHARSET_NAME

The system variable name for the name of the character set that the server uses by default. See http://dev.mysql.com/doc/refman/5.7/en/server-options.html#option_mysqld_character-set-server

See Also:

Constant Field Values

systemVariables

private final MySqlSystemVariables systemVariables

charsetNameForDatabase

private final ConcurrentMap<String,String> charsetNameForDatabase

Constructor Detail

MySqlDdlParser

public MySqlDdlParser()

Create a new DDL parser for MySQL that does not include view definitions.

MySqlDdlParser

public MySqlDdlParser(boolean includeViews)

Create a new DDL parser for MySQL.

Parameters:

includeViews - true if view definitions should be included, or false if they should be skipped

Method Detail

systemVariables

protected MySqlSystemVariables systemVariables()

initializeDataTypes

protected void initializeDataTypes(DataTypeParser dataTypes)

Overrides:

initializeDataTypes in class DdlParser

initializeKeywords

protected void initializeKeywords(DdlParser.TokenSet keywords)

Overrides:

initializeKeywords in class DdlParser

initializeStatementStarts

protected void initializeStatementStarts(DdlParser.TokenSet statementStartTokens)

Overrides:

initializeStatementStarts in class DdlParser

parseNextStatement

protected void parseNextStatement(TokenStream.Marker marker)

Overrides:

parseNextStatement in class DdlParser

parseSet

protected void parseSet(TokenStream.Marker start)

parseSetVariable

protected void parseSetVariable(TokenStream.Marker start,
                                AtomicReference<MySqlSystemVariables.Scope> scope)

parseVariableName

protected String parseVariableName()

parseVariableValue

protected String parseVariableValue()

parseCreate

protected void parseCreate(TokenStream.Marker marker)

Overrides:

parseCreate in class DdlParser

parseCreateDatabase

protected void parseCreateDatabase(TokenStream.Marker start)

parseAlterDatabase

protected void parseAlterDatabase(TokenStream.Marker start)

parseDropDatabase

protected void parseDropDatabase(TokenStream.Marker start)

parseDatabaseOptions

protected void parseDatabaseOptions(TokenStream.Marker start,
                                    String dbName)

parseCreateTable

protected void parseCreateTable(TokenStream.Marker start)

parseTableOptions

protected void parseTableOptions(TokenStream.Marker start,
                                 TableEditor table)

parseTableOption

protected boolean parseTableOption(TokenStream.Marker start,
                                   TableEditor table)

parsePartitionOptions

protected void parsePartitionOptions(TokenStream.Marker start,
                                     TableEditor table)

parsePartitionDefinition

protected void parsePartitionDefinition(TokenStream.Marker start,
                                        TableEditor table)

parseSubpartitionDefinition

protected void parseSubpartitionDefinition(TokenStream.Marker start,
                                           TableEditor table)

parseAsSelectStatement

protected void parseAsSelectStatement(TokenStream.Marker start,
                                      TableEditor table)

parseCreateDefinitionList

protected void parseCreateDefinitionList(TokenStream.Marker start,
                                         TableEditor table)

parseCreateDefinition

protected void parseCreateDefinition(TokenStream.Marker start,
                                     TableEditor table)

parseCreateColumn

protected Column parseCreateColumn(TokenStream.Marker start,
                                   TableEditor table,
                                   String columnName,
                                   String newColumnName)

parseSetAndEnumOptions

public static List<String> parseSetAndEnumOptions(String typeExpression)

Parse the ENUM or SET data type expression to extract the character options, where the index(es) appearing in the ENUM or SET values can be used to identify the acceptable characters.

Parameters:

typeExpression - the data type expression

Returns:

the string containing the character options allowed by the ENUM or SET; never null

withoutQuotes

protected static String withoutQuotes(String possiblyQuoted)

parseColumnDefinition

protected void parseColumnDefinition(TokenStream.Marker start,
                                     String columnName,
                                     TokenStream tokens,
                                     TableEditor table,
                                     ColumnEditor column,
                                     AtomicBoolean isPrimaryKey)

parseDomainName

protected String parseDomainName(TokenStream.Marker start)

parseIndexColumnNames

protected List<String> parseIndexColumnNames(TokenStream.Marker start)

parseIndexColumnName

private void parseIndexColumnName(Consumer<String> name)

parseIndexType

protected void parseIndexType(TokenStream.Marker start)

parseIndexOptions

protected void parseIndexOptions(TokenStream.Marker start)

parseReferenceDefinition

protected void parseReferenceDefinition(TokenStream.Marker start)

parseReferenceOption

protected void parseReferenceOption(TokenStream.Marker start)

parseCreateView

protected void parseCreateView(TokenStream.Marker start)

parseCreateIndex

protected void parseCreateIndex(TokenStream.Marker start)

parseDefiner

protected void parseDefiner(TokenStream.Marker start)

parseCreateProcedure

protected void parseCreateProcedure(TokenStream.Marker start)

parseCreateTrigger

protected void parseCreateTrigger(TokenStream.Marker start)

parseCreateEvent

protected void parseCreateEvent(TokenStream.Marker start)

parseCreateUnknown

protected void parseCreateUnknown(TokenStream.Marker start)

parseAlter

protected void parseAlter(TokenStream.Marker marker)

Overrides:

parseAlter in class DdlParser

parseAlterTable

protected void parseAlterTable(TokenStream.Marker start)

parseAlterSpecificationList

protected void parseAlterSpecificationList(TokenStream.Marker start,
                                           TableEditor table,
                                           Consumer<TableId> newTableName)

parseAlterSpecification

protected void parseAlterSpecification(TokenStream.Marker start,
                                       TableEditor table,
                                       Consumer<TableId> newTableName)

parseAlterUnknown

protected void parseAlterUnknown(TokenStream.Marker start)

parseDrop

protected void parseDrop(TokenStream.Marker marker)

Overrides:

parseDrop in class DdlParser

parseDropTable

protected void parseDropTable(TokenStream.Marker start)

parseDropView

protected void parseDropView(TokenStream.Marker start)

parseDropIndex

protected void parseDropIndex(TokenStream.Marker start)

parseDropUnknown

protected void parseDropUnknown(TokenStream.Marker start)

parseRename

protected void parseRename(TokenStream.Marker start)

parseRenameTable

protected void parseRenameTable(TokenStream.Marker start)

parseUse

protected void parseUse(TokenStream.Marker marker)

currentDatabaseCharset

protected String currentDatabaseCharset()

Get the name of the character set for the current database, via the "character_set_database" system property.

Returns:

the name of the character set for the current database, or null if not known ...

parseColumnNameList

protected List<String> parseColumnNameList(TokenStream.Marker start)

parseColumnName

protected String parseColumnName()

parsePartitionNames

protected void parsePartitionNames(TokenStream.Marker start)

consumeCommaSeparatedValueList

protected void consumeCommaSeparatedValueList(TokenStream.Marker start)

consumeValueList

protected void consumeValueList(TokenStream.Marker start)

consumeExpression

protected void consumeExpression(TokenStream.Marker start)

Consume an expression surrounded by parentheses.

Parameters:

start - the start of the statement

consumeBeginStatement

protected void consumeBeginStatement(TokenStream.Marker start)

Consume the entire BEGIN...END block that appears next in the token stream. This handles nested BEGIN...END blocks, labeled statements, and control blocks.

Overrides:

consumeBeginStatement in class DdlParser

Parameters:

start - the marker at which the statement was begun

getPrecedingBlockLabel

protected String getPrecedingBlockLabel()

Get the label that appears with a colon character just prior to the current position. Some MySQL DDL statements can be labeled, and this label can then appear at the end of a block.

Returns:

the label for the block starting at the current position; null if there is no such label

Throws:

NoSuchElementException - if there is no previous token

sequentially

protected void sequentially(Consumer<TokenStream.Marker>... functions)

Try calling the supplied functions in sequence, stopping as soon as one of them succeeds.

Parameters:

functions - the functions

parseDefaultClause

protected void parseDefaultClause(TokenStream.Marker start)

Parse and consume the DEFAULT clause. Currently, this method does not capture the default in any way, since that will likely require parsing the default clause into a useful value (e.g., dealing with hexadecimals, bit-set literals, date-time literals, etc.).

Parameters:

start - the marker at the beginning of the clause

parseOnUpdateOrDelete

protected void parseOnUpdateOrDelete(TokenStream.Marker start)

parseCurrentTimestampOrNow

private void parseCurrentTimestampOrNow()