org.sodeac.common.jdbc

Interface IDBSchemaUtilsDriver

All Superinterfaces:

Driver.IDriver

All Known Implementing Classes:

H2DBUtilDriver, PGDBUtilDriver

public interface IDBSchemaUtilsDriver
extends Driver.IDriver

Field Summary

Fields

Modifier and Type	Field and Description
static int	HANDLE_DEFAULT
static int	HANDLE_FALLBACK
static int	HANDLE_NONE
static String	REQUIRED_DEFAULT_COLUMN

Fields inherited from interface org.sodeac.common.misc.Driver.IDriver

APPLICABLE_DEFAULT, APPLICABLE_FALLBACK, APPLICABLE_NONE

Method Summary

Modifier and Type	Method and Description
default String	catalogSearchPattern(BranchNode<?,DBSchemaNodeType> schema, Connection connection, String catalog)
static void	cleanColumnForeignKeys(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, IDBSchemaUtilsDriver dbSchemaUtilsDriver)
default boolean	columnExists(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, Map<String,Object> columnProperties) check existence of column by columnSpec.
static boolean	confirmDropSchema(Connection connection, String schemaName, Map<String,Object> properties)
default void	createColumn(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, Map<String,Object> columnProperties) create column
default void	createSchema(Connection connection, String schemaName, Map<String,Object> properties) create a new schema
default void	createTable(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, Map<String,Object> tableProperties) create a table object in database
default String	determineColumnType(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, Map<String,Object> columnProperties) determine type of column
default void	dropColumn(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, String columnName, boolean quoted) drop column
default void	dropDummyColumns(Connection connection, BranchNode<?,DBSchemaNodeType> schema) clean schema from columns created with table-objects by dbms can not create tables without columns
default void	dropForeignKey(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, String keyName, boolean quoted) drop foreign key
default void	dropIndex(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, String indexName, boolean quoted) drop index with indexName
default void	dropSchema(Connection connection, String schemaName, Map<String,Object> properties) drops a schema
default String	getFunctionExpression(String function) convert function name to function syntax
default boolean	isValidColumnProperties(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, Map<String,Object> columnProperties) check column properties (default-value, type, nullable)
default boolean	isValidForeignKey(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, Map<String,Object> columnProperties) check valid created foreign key
default boolean	isValidIndex(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,IndexNodeType> index, Map<String,Object> indexProperties) check valid index setup
default String	objectNameGuidelineFormat(BranchNode<?,DBSchemaNodeType> schema, Connection connection, String name, String type) convert object name (e.g.
default String	objectSearchPattern(BranchNode<?,DBSchemaNodeType> schema, Connection connection, String name, boolean quoted, String type)
default boolean	primaryKeyExists(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, Map<String,Object> tableProperties) check existence of tables primary key by tableSpec.
default char	quotedChar()
default boolean	schemaExists(Connection connection, String schemaName) check the schema exists
default String	schemaSearchPattern(BranchNode<?,DBSchemaNodeType> schema, Connection connection, String schemaName)
default void	setPrimaryKey(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, Map<String,Object> tableProperties) create primary key
static void	setPrimaryKeyWithIndex(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, Map<String,Object> tableProperties, IDBSchemaUtilsDriver dbSchemaUtilsDriver)
static void	setPrimaryKeyWithoutIndex(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, Map<String,Object> tableProperties, IDBSchemaUtilsDriver dbSchemaUtilsDriver)
default void	setValidColumnProperties(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, Map<String,Object> columnProperties) set valid column properties (default-value, type, nullable)
default void	setValidForeignKey(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,ColumnNodeType> column, Map<String,Object> columnProperties) create or update foreign key setting for columnSpec
default void	setValidIndex(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, BranchNode<?,IndexNodeType> index, Map<String,Object> indexProperties) setup valid index by indexSpec
default boolean	tableExists(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, Map<String,Object> tableProperties) check existence of table by tableSpec.
default boolean	tableRequiresColumn()
default String	tableSpaceAppendix(Connection connection, BranchNode<?,DBSchemaNodeType> schema, BranchNode<?,TableNodeType> table, Map<String,Object> properties, String tableSpace, String type)

Methods inherited from interface org.sodeac.common.misc.Driver.IDriver

driverIsApplicableFor

Field Detail

HANDLE_NONE

static final int HANDLE_NONE

See Also:

Constant Field Values

HANDLE_FALLBACK

static final int HANDLE_FALLBACK

See Also:

Constant Field Values

HANDLE_DEFAULT

static final int HANDLE_DEFAULT

See Also:

Constant Field Values

REQUIRED_DEFAULT_COLUMN

static final String REQUIRED_DEFAULT_COLUMN

See Also:

Constant Field Values

Method Detail

createSchema

default void createSchema(Connection connection,
                          String schemaName,
                          Map<String,Object> properties)
                   throws SQLException

create a new schema

Parameters:

connection - underlying connection to create schema name

schemaName - name of schema to create

properties - further driver-specific informations

Throws:

SQLException

schemaExists

default boolean schemaExists(Connection connection,
                             String schemaName)
                      throws SQLException

check the schema exists

Parameters:

connection - underlying connection to check the schema

schemaName - name of schema to check

Returns:

true, if schema exists, otherwise false

Throws:

SQLException

dropSchema

default void dropSchema(Connection connection,
                        String schemaName,
                        Map<String,Object> properties)
                 throws SQLException

drops a schema

Parameters:

connection - underlying connection to drop the schema

schemaName - name of schema to drop

properties - informations to confirm drop

Throws:

SQLException

confirmDropSchema

static boolean confirmDropSchema(Connection connection,
                                 String schemaName,
                                 Map<String,Object> properties)
                          throws SQLException

Throws:

SQLException

tableExists

default boolean tableExists(Connection connection,
                            BranchNode<?,DBSchemaNodeType> schema,
                            BranchNode<?,TableNodeType> table,
                            Map<String,Object> tableProperties)
                     throws SQLException

check existence of table by tableSpec.

Parameters:

connection - underlying connection to check existence of table

schema - hole schema specification

table - table specification to check

tableProperties - properties to store working parameter

Returns:

true, if table exists or false if table not exists

Throws:

SQLException

createTable

default void createTable(Connection connection,
                         BranchNode<?,DBSchemaNodeType> schema,
                         BranchNode<?,TableNodeType> table,
                         Map<String,Object> tableProperties)
                  throws SQLException

create a table object in database

Parameters:

connection - underlying connection to create table

schema - hole schema specification

table - table specification to create table

tableProperties - properties to store working parameter

Throws:

SQLException

primaryKeyExists

default boolean primaryKeyExists(Connection connection,
                                 BranchNode<?,DBSchemaNodeType> schema,
                                 BranchNode<?,TableNodeType> table,
                                 Map<String,Object> tableProperties)
                          throws SQLException

check existence of tables primary key by tableSpec.

Parameters:

connection - underlying connection to check existence of primary key

schema - hole schema specification

table - table specification to check

tableProperties - properties to store working parameter

Returns:

true, if primary exists or false if primary key not exists

Throws:

SQLException

setPrimaryKey

default void setPrimaryKey(Connection connection,
                           BranchNode<?,DBSchemaNodeType> schema,
                           BranchNode<?,TableNodeType> table,
                           Map<String,Object> tableProperties)
                    throws SQLException

create primary key

Parameters:

connection - underlying connection to create primary key

schema - hole schema specification

table - table specification to create primary key

tableProperties - properties to store working parameter

Throws:

SQLException

setPrimaryKeyWithIndex

static void setPrimaryKeyWithIndex(Connection connection,
                                   BranchNode<?,DBSchemaNodeType> schema,
                                   BranchNode<?,TableNodeType> table,
                                   Map<String,Object> tableProperties,
                                   IDBSchemaUtilsDriver dbSchemaUtilsDriver)
                            throws SQLException

Throws:

SQLException

setPrimaryKeyWithoutIndex

static void setPrimaryKeyWithoutIndex(Connection connection,
                                      BranchNode<?,DBSchemaNodeType> schema,
                                      BranchNode<?,TableNodeType> table,
                                      Map<String,Object> tableProperties,
                                      IDBSchemaUtilsDriver dbSchemaUtilsDriver)
                               throws SQLException

Throws:

SQLException

columnExists

default boolean columnExists(Connection connection,
                             BranchNode<?,DBSchemaNodeType> schema,
                             BranchNode<?,TableNodeType> table,
                             BranchNode<?,ColumnNodeType> column,
                             Map<String,Object> columnProperties)
                      throws SQLException

check existence of column by columnSpec.

Parameters:

connection - underlying connection to check existence of column

schema - hole schema specification

table - table specification of columns table

column - column specification to check

columnProperties - properties to store working parameter

Returns:

true if column exists, otherwise false

Throws:

SQLException

determineColumnType

default String determineColumnType(Connection connection,
                                   BranchNode<?,DBSchemaNodeType> schema,
                                   BranchNode<?,TableNodeType> table,
                                   BranchNode<?,ColumnNodeType> column,
                                   Map<String,Object> columnProperties)
                            throws SQLException

determine type of column

Parameters:

connection - underlying connection to check valid type of existing column

schema - hole schema specification

table - table specification of columns table

column - column specification to check

columnProperties - properties with working parameter

Returns:

null, if driver can not determine type of column, otherwise type

Throws:

SQLException

createColumn

default void createColumn(Connection connection,
                          BranchNode<?,DBSchemaNodeType> schema,
                          BranchNode<?,TableNodeType> table,
                          BranchNode<?,ColumnNodeType> column,
                          Map<String,Object> columnProperties)
                   throws SQLException

create column

Parameters:

connection - connection underlying connection to create column

schema - hole schema specification

table - table specification of columns table

column - column specification to create

columnProperties - properties to store working parameter

Throws:

SQLException

dropColumn

default void dropColumn(Connection connection,
                        BranchNode<?,DBSchemaNodeType> schema,
                        BranchNode<?,TableNodeType> table,
                        String columnName,
                        boolean quoted)
                 throws SQLException

drop column

Parameters:

connection - underlying connection to drop column

schema - hole schema specification

table - table specification of columns table

columnName - name of column to drop

quoted - use column name as quoted object name

Throws:

SQLException

isValidColumnProperties

default boolean isValidColumnProperties(Connection connection,
                                        BranchNode<?,DBSchemaNodeType> schema,
                                        BranchNode<?,TableNodeType> table,
                                        BranchNode<?,ColumnNodeType> column,
                                        Map<String,Object> columnProperties)
                                 throws SQLException

check column properties (default-value, type, nullable)

Parameters:

connection - underlying connection to check column

schema - hole schema specification

table - table specification of columns table

column - column specification to check

columnProperties - properties to store working parameter

Returns:

return true column setup is valid, otherwise false

Throws:

SQLException

setValidColumnProperties

default void setValidColumnProperties(Connection connection,
                                      BranchNode<?,DBSchemaNodeType> schema,
                                      BranchNode<?,TableNodeType> table,
                                      BranchNode<?,ColumnNodeType> column,
                                      Map<String,Object> columnProperties)
                               throws SQLException

set valid column properties (default-value, type, nullable)

Parameters:

connection - connection underlying connection to setup column

schema - hole schema specification

table - table specification of columns table

column - column specification for setup

columnProperties - properties to store working parameter

Throws:

SQLException

isValidForeignKey

default boolean isValidForeignKey(Connection connection,
                                  BranchNode<?,DBSchemaNodeType> schema,
                                  BranchNode<?,TableNodeType> table,
                                  BranchNode<?,ColumnNodeType> column,
                                  Map<String,Object> columnProperties)
                           throws SQLException

check valid created foreign key

Parameters:

connection - underlying connection to check foreign key

schema - hole schema specification

table - table specification of columns table

column - column specification to check foreign key

columnProperties - properties to store working parameter

Returns:

true, if foreign key is created

Throws:

SQLException

setValidForeignKey

default void setValidForeignKey(Connection connection,
                                BranchNode<?,DBSchemaNodeType> schema,
                                BranchNode<?,TableNodeType> table,
                                BranchNode<?,ColumnNodeType> column,
                                Map<String,Object> columnProperties)
                         throws SQLException

create or update foreign key setting for columnSpec

Parameters:

connection - underlying connection to set foreign key

schema - hole schema specification

table - table specification of columns table

column - column specification to set foreign key

columnProperties - properties to store working parameter

Throws:

SQLException

cleanColumnForeignKeys

static void cleanColumnForeignKeys(Connection connection,
                                   BranchNode<?,DBSchemaNodeType> schema,
                                   BranchNode<?,TableNodeType> table,
                                   BranchNode<?,ColumnNodeType> column,
                                   IDBSchemaUtilsDriver dbSchemaUtilsDriver)
                            throws SQLException

Throws:

SQLException

dropForeignKey

default void dropForeignKey(Connection connection,
                            BranchNode<?,DBSchemaNodeType> schema,
                            BranchNode<?,TableNodeType> table,
                            String keyName,
                            boolean quoted)
                     throws SQLException

drop foreign key

Parameters:

connection - underlying connection to drop foreign key

schema - hole schema specification

table - table specification of columns table

keyName - name of foreign key to drop

quoted - use key name as quoted object name

Throws:

SQLException

isValidIndex

default boolean isValidIndex(Connection connection,
                             BranchNode<?,DBSchemaNodeType> schema,
                             BranchNode<?,TableNodeType> table,
                             BranchNode<?,IndexNodeType> index,
                             Map<String,Object> indexProperties)
                      throws SQLException

check valid index setup

Parameters:

connection - underlying connection to check index

schema - hole schema specification

table - table specification of index

index - index specification

indexProperties - properties to store working parameter

Returns:

true, if index has valid setup, otherwise false

Throws:

SQLException

setValidIndex

default void setValidIndex(Connection connection,
                           BranchNode<?,DBSchemaNodeType> schema,
                           BranchNode<?,TableNodeType> table,
                           BranchNode<?,IndexNodeType> index,
                           Map<String,Object> indexProperties)
                    throws SQLException

setup valid index by indexSpec

Parameters:

connection - underlying connection to setup index

schema - hole schema specification

table - table specification of index

index - index specification

indexProperties - properties to store working parameter

Throws:

SQLException

dropIndex

default void dropIndex(Connection connection,
                       BranchNode<?,DBSchemaNodeType> schema,
                       BranchNode<?,TableNodeType> table,
                       String indexName,
                       boolean quoted)
                throws SQLException

drop index with indexName

Parameters:

connection - underlying connection to drop index

schema - hole schema specification

table - table specification of index

indexName - name of index to drop

quoted - use index name as quoted object name

Throws:

SQLException

dropDummyColumns

default void dropDummyColumns(Connection connection,
                              BranchNode<?,DBSchemaNodeType> schema)
                       throws SQLException

clean schema from columns created with table-objects by dbms can not create tables without columns

Parameters:

connection - underlying connection to clean from dummy columns

schema - hole schema specification

Throws:

SQLException

getFunctionExpression

default String getFunctionExpression(String function)

convert function name to function syntax

Parameters:

function - name of function

Returns:

valid function syntax

tableRequiresColumn

default boolean tableRequiresColumn()

Returns:

true, of dbms requires a column on table creation, otherwise false

catalogSearchPattern

default String catalogSearchPattern(BranchNode<?,DBSchemaNodeType> schema,
                                    Connection connection,
                                    String catalog)

Parameters:

schema - hole schema specification

connection - underlying connection

catalog - catalog name

Returns:

catalog filter object for jdbc meta api

schemaSearchPattern

default String schemaSearchPattern(BranchNode<?,DBSchemaNodeType> schema,
                                   Connection connection,
                                   String schemaName)

Parameters:

schema - hole schema specification

connection - underlying connection

schemaName - schema name

Returns:

schema filter object for jdbc meta api

objectSearchPattern

default String objectSearchPattern(BranchNode<?,DBSchemaNodeType> schema,
                                   Connection connection,
                                   String name,
                                   boolean quoted,
                                   String type)

Parameters:

schema - hole schema specification

connection - underlying connection

name - object's name

quoted - use name as quoted object name

type - object type (TABLE,COLUMN ...)

Returns:

filter object for jdbc meta api

objectNameGuidelineFormat

default String objectNameGuidelineFormat(BranchNode<?,DBSchemaNodeType> schema,
                                         Connection connection,
                                         String name,
                                         String type)

convert object name (e.g. table name, column name, key name ) to dbms conform name

Parameters:

schema - hole schema specification

connection - underlying connection

name - object's name

type - object type

Returns:

jdbc specific object name

quotedChar

default char quotedChar()

Returns:

character to quote an identifier

tableSpaceAppendix

default String tableSpaceAppendix(Connection connection,
                                  BranchNode<?,DBSchemaNodeType> schema,
                                  BranchNode<?,TableNodeType> table,
                                  Map<String,Object> properties,
                                  String tableSpace,
                                  String type)

Parameters:

connection -

schema -

table -

properties -

tableSpace -

type -

Returns: