sirius.db.jdbc.schema

Interface DatabaseDialect

All Known Implementing Classes:

BasicDatabaseDialect, ClickhouseDatabaseDialect, MySQLDatabaseDialect

public interface DatabaseDialect

Contains methods used by SchemaTool to generate SQL which conforms to the dialect of a special database.

Method Summary

Modifier and Type	Method and Description
String	areColumnsEqual(TableColumn target, TableColumn current) Determines if two given column are equal or not.
Table	completeTableInfos(Table table) Performs DB-specific functions after a Table was read from the DB-metadata.
String	generateAddColumn(Table table, TableColumn col) Generates an alter statement to add the given column.
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>	generateAlterColumnTo(Table table, String oldName, TableColumn toColumn) Alters the given column.
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	generateCreateTable(Table table) Builds a CREATE TABLE statement.
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.
String	getEffectiveKeyName(Table targetTable, Key key) Computes the effective name used for a key.
int	getJDBCType(Class<?> clazz) Converts the given class into the JDBC-Value (@see Types).
boolean	isColumnCaseSensitive() Determines whether casing of columns should be fixed.
boolean	shouldDropKey(Table targetTable, Table currentTable, Key key) Determines if the given key should be dropped.
String	translateColumnName(String name) Converts the name (casing) to the one, used by the DB.

Method Detail

completeTableInfos

Table completeTableInfos(Table table)

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

Parameters:

table - the table object to enhance

Returns:

the enhanced table object

getJDBCType

int getJDBCType(Class<?> clazz)

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

Parameters:

clazz - the type to convert

Returns:

the appropiate type from Types

areColumnsEqual

String areColumnsEqual(TableColumn target,
                       TableColumn current)

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

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.

generateCreateTable

String generateCreateTable(Table table)

Builds a CREATE TABLE statement.

Parameters:

table - the table to create

Returns:

the generated SQL statement

generateDropTable

String generateDropTable(Table table)

Builds a DROP TABLE statement.

Parameters:

table - the table to drop

Returns:

the generated SQL statement

generateAlterColumnTo

List<String> generateAlterColumnTo(Table table,
                                   @Nullable
                                   String oldName,
                                   TableColumn toColumn)

Alters the given column.

Parameters:

table - the table to alter

oldName - the old name of the column (if it was renamed)

toColumn - the column as expected in the schema

Returns:

the generated SQL statement

generateAddColumn

String generateAddColumn(Table table,
                         TableColumn col)

Generates an alter statement to add the given column.

Parameters:

table - the table to alter

col - the column to create

Returns:

the generated SQL statement

generateDropColumn

String generateDropColumn(Table table,
                          TableColumn col)

Generates an alter statement to drop the given column.

Parameters:

table - the table to alter

col - the column to drop

Returns:

the generated SQL statement

generateAlterPrimaryKey

List<String> generateAlterPrimaryKey(Table table)

Alters the table so that the PK is updated.

Parameters:

table - the table to alter

Returns:

the generated SQL statement

generateAlterKey

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

Alters the table so that the given key is updated

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

generateAddKey

String generateAddKey(Table table,
                      Key key)

Alters the table so that the given key is added

Parameters:

table - the table to alter

key - the key to add

Returns:

the generated SQL statement

generateDropKey

String generateDropKey(Table table,
                       Key key)

Alters the table so that the given key is dropped

Parameters:

table - the table to alter

key - the key to drop

Returns:

the generated SQL statement

generateAlterForeignKey

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

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

generateAddForeignKey

String generateAddForeignKey(Table table,
                             ForeignKey key)

Alters the table so that the given foreign key is added

Parameters:

table - the table to alter

key - the key to add

Returns:

the generated SQL statement

generateDropForeignKey

String generateDropForeignKey(Table table,
                              ForeignKey key)

Alters the table so that the given foreign key is dropped

Parameters:

table - the table to alter

key - the key to drop

Returns:

the generated SQL statement

translateColumnName

String translateColumnName(String name)

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

Parameters:

name - the name of the column

Returns:

the name written as the DB expects it

isColumnCaseSensitive

boolean isColumnCaseSensitive()

Determines whether casing of columns should be fixed.

Returns:

true if column names are case sensitive

shouldDropKey

boolean shouldDropKey(Table targetTable,
                      Table currentTable,
                      Key key)

Determines if the given key should be dropped.

Parameters:

targetTable - the table being referenced

currentTable - the table referencing another

key - the key which defines the reference

Returns:

true if the key should be dropped, false otherwise

getEffectiveKeyName

String getEffectiveKeyName(Table targetTable,
                           Key key)

Computes the effective name used for a key.

Parameters:

targetTable - the table which contains the key

key - the key itself

Returns:

the effective name for the key