org.tentackle.sql

Class MySql

java.lang.Object

org.tentackle.sql.AbstractBackend

org.tentackle.sql.AbstractSql92Backend

org.tentackle.sql.MySql

All Implemented Interfaces:

Backend

@Service(value=Backend.class)
public class MySql
extends AbstractSql92Backend

Backend for MySQL.

Author:

harald

Field Summary

Fields

Modifier and Type	Field and Description
static String	SQL_LIMIT LIMIT string.
static String	SQL_LIMIT_PAR LIMIT ? string.
static String	SQL_OFFSET OFFSET string.
static String	SQL_OFFSET_PAR OFFSET ? string.

Fields inherited from class org.tentackle.sql.AbstractSql92Backend

SQL_COALESCE, SQL_FOR_UPDATE

Fields inherited from class org.tentackle.sql.AbstractBackend

EMPTY_STRING, TYPE_BIGINT, TYPE_BIT, TYPE_BLOB, TYPE_BOOL, TYPE_BOOLEAN, TYPE_BYTE, TYPE_BYTEA, TYPE_CHAR_1, TYPE_DATE, TYPE_DATETIME, TYPE_DATETIME_YEAR_TO_SECOND, TYPE_DECIMAL, TYPE_DECIMAL_19, TYPE_DOUBLE, TYPE_FLOAT, TYPE_FLOAT4, TYPE_FLOAT8, TYPE_INT, TYPE_INT2, TYPE_INT4, TYPE_INT8, TYPE_INTEGER, TYPE_NCHAR_1, TYPE_NUMBER, TYPE_NUMBER_1, TYPE_NUMBER_10, TYPE_NUMBER_19, TYPE_NUMBER_5, TYPE_NVARCHAR, TYPE_NVARCHAR_MAX, TYPE_REAL, TYPE_SMALLFLOAT, TYPE_SMALLINT, TYPE_TEXT, TYPE_TIME, TYPE_TIMESTAMP, TYPE_TINYINT, TYPE_VARBINARY_MAX, TYPE_VARCHAR

Fields inherited from interface org.tentackle.sql.Backend

SQL_ALLSTAR, SQL_AND, SQL_ANDNOT, SQL_COMMA, SQL_COMMA_PAR, SQL_DELETE, SQL_EQUAL, SQL_EQUAL_PAR, SQL_EQUAL_PAR_COMMA, SQL_EQUAL_ZERO, SQL_FROM, SQL_GREATER, SQL_GREATER_PAR, SQL_GREATEROREQUAL, SQL_GREATEROREQUAL_PAR, SQL_GROUPBY, SQL_INSERT_INTO, SQL_INSERT_VALUES, SQL_ISNOTNULL, SQL_ISNULL, SQL_LEFT_PARENTHESIS, SQL_LESS, SQL_LESS_PAR, SQL_LESSOREQUAL, SQL_LESSOREQUAL_PAR, SQL_LIKE, SQL_LIKE_PAR, SQL_MAX, SQL_MIN, SQL_NOT, SQL_NOTEQUAL, SQL_NOTEQUAL_PAR, SQL_NOTEQUAL_ZERO, SQL_NOTLIKE, SQL_NOTLIKE_PAR, SQL_OR, SQL_ORDERBY, SQL_ORNOT, SQL_PAR, SQL_PAR_COMMA, SQL_PLUS_ONE, SQL_RIGHT_PARENTHESIS, SQL_SELECT, SQL_SELECT_ALL_FROM, SQL_SET, SQL_SORTASC, SQL_SORTDESC, SQL_UPDATE, SQL_WHERE, SQL_WHEREALL, SQL_WHEREAND, SQL_WHERENOTHING, SQL_WHEREOR

Constructor Summary

Constructors

Constructor and Description
MySql()

Method Summary

Modifier and Type	Method and Description
boolean	allowsExpressionsReferringToTablesBeingUpdated() Determines whether backend allows expressions referring to tables being updated.
void	buildSelectSql(StringBuilder sqlBuilder, boolean writeLock, int limit, int offset) Creates a select statement string from an inner sql string.
ColumnMetaData	createColumnMetaData(TableMetaData tableMetaData) Creates a column meta data instance.
protected String	extractWhereClause(String sql, int whereOffset) Extracts the where clause from a given sql.
String	getBackendId(Connection connection) Determines the unique id or name used by the backend for a given connection.
String	getDriverClassName() Gets the JDBC driver class name.
int	getMaxSize(SqlType sqlType) Returns the maximum size for a given SQL-type.
DatabaseMetaData[]	getMetaData(BackendInfo backendInfo) Gets the metadata from the backend.
MigrationStrategy[]	getMigrationStrategy(ColumnMetaData column, String columnName, String comment, SqlType sqlType, int size, int scale, boolean nullable, Object defaultValue) Determines the best migration strategy.
String	getName() Gets the name of the backend.
boolean	isDefaultEqual(ColumnMetaData column, SqlType sqlType, Object defaultValue) Checks whether the column's default corresponds to the model's default value.
boolean	isMatchingUrl(String url) Checks whether the backend belongs to the given jdbc url.
SqlType[]	jdbcTypeToSqlType(int jdbcType, int size, int scale) Converts the JDBC data type integer to a tentackle backend SqlTypes.
int	setLeadingSelectParameters(BackendPreparedStatement stmt, int limit, int offset) Sets optional parameters before applying the original parameters.
int	setTrailingSelectParameters(BackendPreparedStatement stmt, int index, int limit, int offset) Sets optional parameters after applying the original parameters.
String	sqlAddColumn(String tableName, String columnName, String comment, SqlType sqlType, int size, int scale, boolean nullable, Object defaultValue) Generates sql code to add a column.
String	sqlAlterColumnComment(String tableName, String columnName, String comment) Generates SQL code to alter the comment for an attribute.
String	sqlAlterColumnType(String tableName, String columnName, String comment, SqlType sqlType, int size, int scale, boolean nullable, Object defaultValue) Generates sql code to change the datatype of a column.
String	sqlCreateColumn(String columnName, String comment, SqlType sqlType, int size, int scale, boolean nullable, Object defaultValue, boolean primaryKey, boolean withTrailingComma) Generates the attribute definition of a CREATE TABLE statement.
String	sqlCreateTableClosing(String tableName, String comment) Generates the last line of a CREATE TABLE statement.
String	sqlDropIndex(String schemaName, String tableNameWithoutSchema, String indexName) Generates the DROP INDEX statement.
String	sqlRenameAndAlterColumnType(String tableName, String oldColumnName, String newColumnName, String comment, SqlType sqlType, int size, int scale, boolean nullable, Object defaultValue) Generates sql code to rename a column.
String	sqlRenameColumn(String tableName, String oldColumnName, String newColumnName) Generates sql code to rename a column.
String	sqlTypeToString(SqlType sqlType, int size) Converts the java SQL-type to the database type name.

Methods inherited from class org.tentackle.sql.AbstractSql92Backend

getCoalesceKeyword, getReservedWords, sqlCreateForeignKey, sqlDropForeignKey, sqlNextFromSequene, supportsSequences

Methods inherited from class org.tentackle.sql.AbstractBackend

assertValidName, columnTypeNullDefaultToString, columnTypeToString, createConnection, createIndexColumnMetaData, createIndexMetaData, createTableMetaData, getDefaultSize, getEmptyString, getMaxScale, getModelMetaData, getTableMetaData, isCommunicationLinkException, isConstraintException, isMatchingName, needAliasForSubselect, needSetLongWorkaround, needTxForFetchsize, optimizeSql, sqlAlterColumnDefault, sqlAlterColumnNullConstraint, sqlAlterTableComment, sqlAsBeforeTableAlias, sqlComment, sqlCreateColumnComment, sqlCreateIndex, sqlCreateTableAttributeWithoutComment, sqlCreateTableComment, sqlCreateTableIntro, sqlCreateTableIntroWithoutComment, sqlDropColumn, sqlFunction, sqlJoin, sqlJoinSelects, sqlRequiresExtraCommit, sqlResultSetIsClosedSupported, sqlUpdateToNotNull, toQuotedString, toString, valueToLiteral

Methods inherited from class java.lang.Object

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

Field Detail

SQL_LIMIT

public static final String SQL_LIMIT

LIMIT string.

See Also:

Constant Field Values

SQL_OFFSET

public static final String SQL_OFFSET

OFFSET string.

See Also:

Constant Field Values

SQL_LIMIT_PAR

public static final String SQL_LIMIT_PAR

LIMIT ? string.

See Also:

Constant Field Values

SQL_OFFSET_PAR

public static final String SQL_OFFSET_PAR

OFFSET ? string.

See Also:

Constant Field Values

Constructor Detail

MySql

public MySql()

Method Detail

isMatchingUrl

public boolean isMatchingUrl(String url)

Description copied from interface: Backend

Checks whether the backend belongs to the given jdbc url.

Parameters:

url - the jdbc url

Returns:

true if matches

getName

public String getName()

Description copied from interface: Backend

Gets the name of the backend.

Returns:

the name

getDriverClassName

public String getDriverClassName()

Description copied from interface: Backend

Gets the JDBC driver class name.

Returns:

the class name

getBackendId

public String getBackendId(Connection connection)

Description copied from interface: Backend

Determines the unique id or name used by the backend for a given connection.

Useful to figure out the corresponding ManagedConnection from the backend's logfiles.

Parameters:

connection - the jdbc connection

Returns:

the backend id, null if none

allowsExpressionsReferringToTablesBeingUpdated

public boolean allowsExpressionsReferringToTablesBeingUpdated()

Description copied from interface: Backend

Determines whether backend allows expressions referring to tables being updated.

Specified by:

allowsExpressionsReferringToTablesBeingUpdated in interface Backend

Overrides:

allowsExpressionsReferringToTablesBeingUpdated in class AbstractBackend

Returns:

true if allowed

buildSelectSql

public void buildSelectSql(StringBuilder sqlBuilder,
                           boolean writeLock,
                           int limit,
                           int offset)

Description copied from interface: Backend

Creates a select statement string from an inner sql string.

sqlBuilder is anything as FROM... WHERE... ORDER BY....
It is decorated with a leading SELECT plus optional clauses like for the given parameters.

Specified by:

buildSelectSql in interface Backend

Overrides:

buildSelectSql in class AbstractSql92Backend

Parameters:

sqlBuilder - the sql builder, initially containing the inner sql without leading SELECT.

writeLock - true select should write lock

limit - the limit value, ≤ 0 if no limit clause

offset - the offset value, ≤ 0 if no offset clause

setLeadingSelectParameters

public int setLeadingSelectParameters(BackendPreparedStatement stmt,
                                      int limit,
                                      int offset)

Description copied from interface: Backend

Sets optional parameters before applying the original parameters.

Specified by:

setLeadingSelectParameters in interface Backend

Overrides:

setLeadingSelectParameters in class AbstractSql92Backend

Parameters:

stmt - the prepared statement

limit - the limit value, ≤ 0 if no limit clause

offset - the offset value, ≤ 0 if no offset clause

Returns:

the next parameter index

setTrailingSelectParameters

public int setTrailingSelectParameters(BackendPreparedStatement stmt,
                                       int index,
                                       int limit,
                                       int offset)

Description copied from interface: Backend

Sets optional parameters after applying the original parameters.

Specified by:

setTrailingSelectParameters in interface Backend

Overrides:

setTrailingSelectParameters in class AbstractSql92Backend

Parameters:

stmt - the prepared statement

index - the first parameter index

limit - the limit value, ≤ 0 if no limit clause

offset - the offset value, ≤ 0 if no offset clause

Returns:

the next parameter index

getMaxSize

public int getMaxSize(SqlType sqlType)

Description copied from interface: Backend

Returns the maximum size for a given SQL-type.

Specified by:

getMaxSize in interface Backend

Overrides:

getMaxSize in class AbstractBackend

Parameters:

sqlType - the SQL-type

Returns:

the maximum size, 0 if unlimited, -1 if type without size

sqlTypeToString

public String sqlTypeToString(SqlType sqlType,
                              int size)

Description copied from interface: Backend

Converts the java SQL-type to the database type name.

Specified by:

sqlTypeToString in interface Backend

Overrides:

sqlTypeToString in class AbstractBackend

Parameters:

sqlType - the java sql type

size - the column's size

Returns:

the corresponding type string

jdbcTypeToSqlType

public SqlType[] jdbcTypeToSqlType(int jdbcType,
                                   int size,
                                   int scale)

Description copied from interface: Backend

Converts the JDBC data type integer to a tentackle backend SqlTypes.

There may be more than one sqltype returned!

Specified by:

jdbcTypeToSqlType in interface Backend

Overrides:

jdbcTypeToSqlType in class AbstractBackend

Parameters:

jdbcType - the jdbc data type

size - the column size

scale - the column's scale

Returns:

the SqlTypes, null if no mapping available or no exact match (not generated by TT)

See Also:

Types

sqlCreateTableClosing

public String sqlCreateTableClosing(String tableName,
                                    String comment)

Description copied from interface: Backend

Generates the last line of a CREATE TABLE statement.

Specified by:

sqlCreateTableClosing in interface Backend

Overrides:

sqlCreateTableClosing in class AbstractBackend

Parameters:

tableName - the tablename with optional schema separated by a dot

comment - optional comment, null if none

Returns:

the SQL code including the closing bracket

getMetaData

public DatabaseMetaData[] getMetaData(BackendInfo backendInfo)
                               throws SQLException

Description copied from interface: Backend

Gets the metadata from the backend.

Important: the connection of the metadata is open!

Specified by:

getMetaData in interface Backend

Overrides:

getMetaData in class AbstractBackend

Parameters:

backendInfo - the backend info

Returns:

the metadata, may be more than one if schemas set in backendInfo

Throws:

SQLException - if failed

createColumnMetaData

public ColumnMetaData createColumnMetaData(TableMetaData tableMetaData)

Description copied from interface: Backend

Creates a column meta data instance.

Specified by:

createColumnMetaData in interface Backend

Overrides:

createColumnMetaData in class AbstractBackend

Parameters:

tableMetaData - the table meta data this column belongs to

Returns:

the meta data

isDefaultEqual

public boolean isDefaultEqual(ColumnMetaData column,
                              SqlType sqlType,
                              Object defaultValue)

Description copied from interface: Backend

Checks whether the column's default corresponds to the model's default value.

Specified by:

isDefaultEqual in interface Backend

Overrides:

isDefaultEqual in class AbstractBackend

Parameters:

column - the column to inspect

sqlType - the sql type

defaultValue - the model's default value

Returns:

true if same

sqlCreateColumn

public String sqlCreateColumn(String columnName,
                              String comment,
                              SqlType sqlType,
                              int size,
                              int scale,
                              boolean nullable,
                              Object defaultValue,
                              boolean primaryKey,
                              boolean withTrailingComma)

Description copied from interface: Backend

Generates the attribute definition of a CREATE TABLE statement.

Specified by:

sqlCreateColumn in interface Backend

Overrides:

sqlCreateColumn in class AbstractBackend

Parameters:

columnName - the database column name

comment - optional comment, null if none

sqlType - the JDBC sql type

size - the optional size

scale - the optional scale

nullable - true if NULL, else NOT NULL

defaultValue - the optional default value

primaryKey - true if this is a primary key

withTrailingComma - true if append a comma

Returns:

the SQL code

sqlAddColumn

public String sqlAddColumn(String tableName,
                           String columnName,
                           String comment,
                           SqlType sqlType,
                           int size,
                           int scale,
                           boolean nullable,
                           Object defaultValue)

Description copied from interface: Backend

Generates sql code to add a column.

Specified by:

sqlAddColumn in interface Backend

Overrides:

sqlAddColumn in class AbstractBackend

Parameters:

tableName - the tablename

columnName - the new column name

comment - optional comment, null if none

sqlType - the JDBC sql type

size - the optional size

scale - the optional scale

nullable - true if NULL, else NOT NULL

defaultValue - the optional default value

Returns:

the SQL code

sqlRenameColumn

public String sqlRenameColumn(String tableName,
                              String oldColumnName,
                              String newColumnName)

Description copied from interface: Backend

Generates sql code to rename a column.

Specified by:

sqlRenameColumn in interface Backend

Overrides:

sqlRenameColumn in class AbstractBackend

Parameters:

tableName - the tablename

oldColumnName - the old column name

newColumnName - the new column name

Returns:

the SQL code, null if need full spec sqlRenameAndAlterColumnType below

sqlRenameAndAlterColumnType

public String sqlRenameAndAlterColumnType(String tableName,
                                          String oldColumnName,
                                          String newColumnName,
                                          String comment,
                                          SqlType sqlType,
                                          int size,
                                          int scale,
                                          boolean nullable,
                                          Object defaultValue)

Description copied from interface: Backend

Generates sql code to rename a column.

Specified by:

sqlRenameAndAlterColumnType in interface Backend

Overrides:

sqlRenameAndAlterColumnType in class AbstractBackend

Parameters:

tableName - the tablename

oldColumnName - the old column name

newColumnName - the new column name

comment - optional comment, null if none

sqlType - the JDBC sql type

size - the optional size

scale - the optional scale

nullable - true if NULL, else NOT NULL

defaultValue - the optional default value

Returns:

the SQL code

sqlAlterColumnType

public String sqlAlterColumnType(String tableName,
                                 String columnName,
                                 String comment,
                                 SqlType sqlType,
                                 int size,
                                 int scale,
                                 boolean nullable,
                                 Object defaultValue)

Description copied from interface: Backend

Generates sql code to change the datatype of a column.

Specified by:

sqlAlterColumnType in interface Backend

Overrides:

sqlAlterColumnType in class AbstractBackend

Parameters:

tableName - the tablename

columnName - the new column name

comment - optional comment, null if none

sqlType - the JDBC sql type

size - the optional size

scale - the optional scale

nullable - true if NULL, else NOT NULL

defaultValue - the optional default value

Returns:

the SQL code

sqlAlterColumnComment

public String sqlAlterColumnComment(String tableName,
                                    String columnName,
                                    String comment)

Description copied from interface: Backend

Generates SQL code to alter the comment for an attribute.

Specified by:

sqlAlterColumnComment in interface Backend

Overrides:

sqlAlterColumnComment in class AbstractBackend

Parameters:

tableName - the table name

columnName - the column name

comment - optional comment, null to clear

Returns:

the SQL code, null if use Backend.sqlRenameAndAlterColumnType(java.lang.String, java.lang.String, java.lang.String, java.lang.String, org.tentackle.sql.SqlType, int, int, boolean, java.lang.Object) instead

sqlDropIndex

public String sqlDropIndex(String schemaName,
                           String tableNameWithoutSchema,
                           String indexName)

Description copied from interface: Backend

Generates the DROP INDEX statement.

Specified by:

sqlDropIndex in interface Backend

Overrides:

sqlDropIndex in class AbstractBackend

Parameters:

schemaName - the optional schema, null if none

tableNameWithoutSchema - the table name without the schema

indexName - the name of the index

Returns:

the SQL code

getMigrationStrategy

public MigrationStrategy[] getMigrationStrategy(ColumnMetaData column,
                                                String columnName,
                                                String comment,
                                                SqlType sqlType,
                                                int size,
                                                int scale,
                                                boolean nullable,
                                                Object defaultValue)

Description copied from interface: Backend

Determines the best migration strategy.

Specified by:

getMigrationStrategy in interface Backend

Overrides:

getMigrationStrategy in class AbstractBackend

Parameters:

column - old column meta data

columnName - new column name

comment - new comment

sqlType - new sql type

size - new size

scale - new scale

nullable - new nullable

defaultValue - new default

Returns:

the strategies in order to achieve the migration

extractWhereClause

protected String extractWhereClause(String sql,
                                    int whereOffset)

Description copied from class: AbstractBackend

Extracts the where clause from a given sql.

Overrides:

extractWhereClause in class AbstractBackend

Parameters:

sql - the sql statement

whereOffset - the location of WHERE in sql

Returns:

the where clause without the keyword WHERE