sirius.db.jdbc.schema

Class BasicDatabaseDialect

java.lang.Object

sirius.db.jdbc.schema.BasicDatabaseDialect

All Implemented Interfaces:

DatabaseDialect

Direct Known Subclasses:

ClickhouseDatabaseDialect, MySQLDatabaseDialect

public abstract class BasicDatabaseDialect
extends Object
implements DatabaseDialect

Provides a base implementation of DatabaseDialect.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_MAX_CONSTRAINT_NAME_LENGTH
protected static String	KEY_CURRENT
protected static String	KEY_TARGET

Constructor Summary

Constructors

Constructor and Description
BasicDatabaseDialect()

Method Summary

Modifier and Type	Method and Description
String	areColumnsEqual(TableColumn target, TableColumn current) Determines if two given column are equal or not.
protected boolean	areDefaultsDifferent(TableColumn target, TableColumn current)
protected boolean	areTypesEqual(int type, int other)
protected String	checkColumnSettings(TableColumn target, TableColumn current)
protected boolean	checkForEquality(String left, String right)
Table	completeTableInfos(Table table) Performs DB-specific functions after a Table was read from the DB-metadata.
protected int	ensurePositiveLength(TableColumn column, int defaultValue)
protected boolean	equalValue(String left, String right)
String	generateAddForeignKey(Table table, ForeignKey key) Alters the table so that the given foreign key is added
String	generateAddKey(Table table, Key key) Alters the table so that the given key is added
List<String>	generateAlterForeignKey(Table table, ForeignKey from, ForeignKey to) Alters the table so that the given foreign key is updated * @param table the table to alter
List<String>	generateAlterKey(Table table, Key from, Key to) Alters the table so that the given key is updated
List<String>	generateAlterPrimaryKey(Table table) Alters the table so that the PK is updated.
String	generateDropColumn(Table table, TableColumn col) Generates an alter statement to drop the given column.
String	generateDropForeignKey(Table table, ForeignKey key) Alters the table so that the given foreign key is dropped
String	generateDropKey(Table table, Key key) Alters the table so that the given key is dropped
String	generateDropTable(Table table) Builds a DROP TABLE statement.
protected int	getConstraintCharacterLimit() Determines the length a constraint should have.
protected String	getDefaultValueAsString(TableColumn col)
String	getEffectiveKeyName(Table targetTable, Key key) Computes the effective name used for a key.
protected sirius.kernel.commons.Value	getEngine(Table table)
int	getJDBCType(Class<?> clazz) Converts the given class into the JDBC-Value (@see Types).
protected String	getTypeName(TableColumn column)
protected boolean	hasEscapedDefaultValue(TableColumn col)
protected boolean	in(int type, int other, int... types)
protected boolean	isNeedsQuotation(TableColumn col)
protected int	resolveType(Class<?> clazz)
String	translateColumnName(String name) Converts the name (casing) to the one, used by the DB.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sirius.db.jdbc.schema.DatabaseDialect

generateAddColumn, generateAlterColumnTo, generateCreateTable, isColumnCaseSensitive, shouldDropKey

Field Detail

KEY_TARGET

protected static final String KEY_TARGET

See Also:

Constant Field Values

KEY_CURRENT

protected static final String KEY_CURRENT

See Also:

Constant Field Values

DEFAULT_MAX_CONSTRAINT_NAME_LENGTH

protected static final int DEFAULT_MAX_CONSTRAINT_NAME_LENGTH

See Also:

Constant Field Values

Constructor Detail

BasicDatabaseDialect

public BasicDatabaseDialect()

Method Detail

getJDBCType

public int getJDBCType(Class<?> clazz)

Description copied from interface: DatabaseDialect

Converts the given class into the JDBC-Value (@see Types).

Specified by:

getJDBCType in interface DatabaseDialect

Parameters:

clazz - the type to convert

Returns:

the appropiate type from Types

completeTableInfos

public Table completeTableInfos(Table table)

Description copied from interface: DatabaseDialect

Performs DB-specific functions after a Table was read from the DB-metadata. This can be used to change column types or default values.

Specified by:

completeTableInfos in interface DatabaseDialect

Parameters:

table - the table object to enhance

Returns:

the enhanced table object

hasEscapedDefaultValue

protected boolean hasEscapedDefaultValue(TableColumn col)

generateAddForeignKey

public String generateAddForeignKey(Table table,
                                    ForeignKey key)

Description copied from interface: DatabaseDialect

Alters the table so that the given foreign key is added

Specified by:

generateAddForeignKey in interface DatabaseDialect

Parameters:

table - the table to alter

key - the key to add

Returns:

the generated SQL statement

generateAddKey

public String generateAddKey(Table table,
                             Key key)

Description copied from interface: DatabaseDialect

Alters the table so that the given key is added

Specified by:

generateAddKey in interface DatabaseDialect

Parameters:

table - the table to alter

key - the key to add

Returns:

the generated SQL statement

generateAlterForeignKey

public List<String> generateAlterForeignKey(Table table,
                                            ForeignKey from,
                                            ForeignKey to)

Description copied from interface: DatabaseDialect

Alters the table so that the given foreign key is updated * @param table the table to alter

Specified by:

generateAlterForeignKey in interface DatabaseDialect

Parameters:

table - the table to alter

from - the key as currently present in the database

to - the key as defined in the schema

Returns:

the generated SQL statements

generateAlterKey

public List<String> generateAlterKey(Table table,
                                     Key from,
                                     Key to)

Description copied from interface: DatabaseDialect

Alters the table so that the given key is updated

Specified by:

generateAlterKey in interface DatabaseDialect

Parameters:

table - the table to alter

from - the key as currently present in the database

to - the key as defined in the schema

Returns:

the generated SQL statement

generateAlterPrimaryKey

public List<String> generateAlterPrimaryKey(Table table)

Description copied from interface: DatabaseDialect

Alters the table so that the PK is updated.

Specified by:

generateAlterPrimaryKey in interface DatabaseDialect

Parameters:

table - the table to alter

Returns:

the generated SQL statement

generateDropColumn

public String generateDropColumn(Table table,
                                 TableColumn col)

Description copied from interface: DatabaseDialect

Generates an alter statement to drop the given column.

Specified by:

generateDropColumn in interface DatabaseDialect

Parameters:

table - the table to alter

col - the column to drop

Returns:

the generated SQL statement

generateDropForeignKey

public String generateDropForeignKey(Table table,
                                     ForeignKey key)

Description copied from interface: DatabaseDialect

Alters the table so that the given foreign key is dropped

Specified by:

generateDropForeignKey in interface DatabaseDialect

Parameters:

table - the table to alter

key - the key to drop

Returns:

the generated SQL statement

generateDropKey

public String generateDropKey(Table table,
                              Key key)

Description copied from interface: DatabaseDialect

Alters the table so that the given key is dropped

Specified by:

generateDropKey in interface DatabaseDialect

Parameters:

table - the table to alter

key - the key to drop

Returns:

the generated SQL statement

generateDropTable

public String generateDropTable(Table table)

Description copied from interface: DatabaseDialect

Builds a DROP TABLE statement.

Specified by:

generateDropTable in interface DatabaseDialect

Parameters:

table - the table to drop

Returns:

the generated SQL statement

translateColumnName

public String translateColumnName(String name)

Description copied from interface: DatabaseDialect

Converts the name (casing) to the one, used by the DB.

Specified by:

translateColumnName in interface DatabaseDialect

Parameters:

name - the name of the column

Returns:

the name written as the DB expects it

resolveType

protected int resolveType(Class<?> clazz)

areColumnsEqual

public String areColumnsEqual(TableColumn target,
                              TableColumn current)

Description copied from interface: DatabaseDialect

Determines if two given column are equal or not. This can gracefully handle questions like is VARCHAR == CHAR etc.

Specified by:

areColumnsEqual in interface DatabaseDialect

Parameters:

target - the target column as expected by the schema

current - the current database column was read from the metadata

Returns:

null if they are equal or a string which contains a reason why they are not.

areDefaultsDifferent

protected boolean areDefaultsDifferent(TableColumn target,
                                       TableColumn current)

checkColumnSettings

protected String checkColumnSettings(TableColumn target,
                                     TableColumn current)

equalValue

protected boolean equalValue(String left,
                             String right)

checkForEquality

protected boolean checkForEquality(String left,
                                   String right)

getDefaultValueAsString

protected String getDefaultValueAsString(TableColumn col)

isNeedsQuotation

protected boolean isNeedsQuotation(TableColumn col)

areTypesEqual

protected boolean areTypesEqual(int type,
                                int other)

in

protected boolean in(int type,
                     int other,
                     int... types)

getTypeName

protected String getTypeName(TableColumn column)

ensurePositiveLength

protected int ensurePositiveLength(TableColumn column,
                                   int defaultValue)

getEffectiveKeyName

public String getEffectiveKeyName(Table targetTable,
                                  Key key)

Description copied from interface: DatabaseDialect

Computes the effective name used for a key.

Specified by:

getEffectiveKeyName in interface DatabaseDialect

Parameters:

targetTable - the table which contains the key

key - the key itself

Returns:

the effective name for the key

getEngine

protected sirius.kernel.commons.Value getEngine(Table table)

getConstraintCharacterLimit

protected int getConstraintCharacterLimit()

Determines the length a constraint should have.

Returns:

the maximum allowed length of a constraint