Class DBAdapter

Method Details

• getName

  public String getName()

  Description copied from interface: IDBAdapter

  Returns the provider's adapter name. Registry registration and lookup compare this value case-insensitively; the value returned by this method is not lowercased for the caller.

  Specified by:

  getName in interface IDBAdapter

  Specified by:

  getName in interface IDBAdapterID

  Returns:

  the adapter name

• getVersion

  public String getVersion()

  Description copied from interface: IDBAdapter

  Returns the provider's adapter version. Registry registration and lookup compare dot-separated numeric components and ignore trailing zero components, while the original representation returned here remains available to callers.

  Specified by:

  getVersion in interface IDBAdapter

  Specified by:

  getVersion in interface IDBAdapterID

  Returns:

  the adapter version

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• isCaseSensitive

  public boolean isCaseSensitive()

  Specified by:

  isCaseSensitive in interface IDBAdapter

• getDefaultSchemaName

  public String getDefaultSchemaName(Connection connection)

  Specified by:

  getDefaultSchemaName in interface IDBAdapter

• createConnectionProvider

  public IDBConnectionProvider createConnectionProvider(DataSource dataSource)

  Specified by:

  createConnectionProvider in interface IDBAdapter

  Since:

  4.3

• modifyConnection

  public Connection modifyConnection(Connection connection)

  Specified by:

  modifyConnection in interface IDBAdapter

  Since:

  4.5

• createSchema

  public void createSchema(Connection connection, String schemaName)

  Specified by:

  createSchema in interface IDBAdapter

• openSchemaTransaction

  public IDBSchemaTransaction openSchemaTransaction(IDBDatabase database, IDBConnection currentConnection)

  Description copied from interface: IDBAdapter

  Opens a schema transaction through the adapter extension point.

  Specified by:

  openSchemaTransaction in interface IDBAdapter

  Since:

  4.9

• readSchema

  public IDBSchema readSchema(Connection connection, String name)

  Specified by:

  readSchema in interface IDBAdapter

  Since:

  4.2

• readSchema

  public void readSchema(Connection connection, IDBSchema schema)

  Specified by:

  readSchema in interface IDBAdapter

  Since:

  4.2

• forEachTable

  protected void forEachTable(Connection connection, String schemaName, boolean caseSensitive, org.eclipse.net4j.util.ConsumerWithException<String,SQLException> tableNameConsumer)

  Enumerates the tables that belong to a schema while reading a database schema.

  Since:

  4.14

• readTables

  protected ResultSet readTables(Connection connection, DatabaseMetaData metaData, String schemaName) throws SQLException

  Throws:

  SQLException

  Since:

  4.3

• readFields

  protected void readFields(Connection connection, IDBTable table) throws SQLException

  Throws:

  SQLException

  Since:

  4.2

• readIndices

  protected void readIndices(Connection connection, DatabaseMetaData metaData, IDBTable table, String schemaName) throws SQLException

  Throws:

  SQLException

  Since:

  4.2

• addIndex

  protected void addIndex(Connection connection, IDBTable table, String name, IDBIndex.Type type, List<DBAdapter.FieldInfo> fieldInfos)

  Since:

  4.2

• isPrimaryKeyShadow

  protected boolean isPrimaryKeyShadow(Connection connection, IDBTable table, String name, IDBIndex.Type type, IDBField[] fields)

  Since:

  4.2

• updateSchema

  public void updateSchema(Connection connection, IDBSchema schema, IDBSchemaDelta delta) throws DBException

  Specified by:

  updateSchema in interface IDBAdapter

  Throws:

  DBException

  Since:

  4.2

• createTable

  protected void createTable(Connection connection, IDBTable table, IDBTableDelta delta)

  Since:

  4.2

• dropTable

  protected void dropTable(Connection connection, IDBTable table, IDBTableDelta delta)

  Since:

  4.2

• alterTable

  protected void alterTable(Connection connection, IDBTable table, IDBTableDelta delta)

  Since:

  4.2

• createField

  protected void createField(Connection connection, IDBField field)

  Since:

  4.13

• dropField

  protected void dropField(Connection connection, IDBField field)

  Since:

  4.13

• createIndex

  protected void createIndex(Connection connection, IDBIndex index, IDBIndexDelta delta)

  Since:

  4.2

• createPrimaryKey

  protected void createPrimaryKey(IDBIndex index, StringBuilder builder)

  Since:

  4.2

• createIndex

  protected void createIndex(IDBIndex index, StringBuilder builder)

  Since:

  4.2

• createIndexFields

  protected void createIndexFields(IDBIndex index, StringBuilder builder)

  Since:

  4.2

• dropIndex

  protected void dropIndex(Connection connection, IDBIndex index, IDBIndexDelta delta)

  Since:

  4.2

• dropPrimaryKey

  protected void dropPrimaryKey(IDBIndex index, StringBuilder builder)

  Since:

  4.2

• dropIndex

  protected void dropIndex(IDBIndex index, StringBuilder builder)

  Since:

  4.2

• createTables

  public Set<IDBTable> createTables(Iterable<? extends IDBTable> tables, Connection connection) throws DBException

  Specified by:

  createTables in interface IDBAdapter

  Throws:

  DBException

• createTable

  public boolean createTable(IDBTable table, Statement statement) throws DBException

  Specified by:

  createTable in interface IDBAdapter

  Throws:

  DBException

• dropTables

  public Collection<IDBTable> dropTables(Iterable<? extends IDBTable> tables, Connection connection) throws DBException

  Specified by:

  dropTables in interface IDBAdapter

  Throws:

  DBException

• dropTable

  public boolean dropTable(IDBTable table, Statement statement)

  Specified by:

  dropTable in interface IDBAdapter

• getDropTableSQL

  protected String getDropTableSQL(IDBTable table)

• getMaxTableNameLength

  public int getMaxTableNameLength()

  Specified by:

  getMaxTableNameLength in interface IDBAdapter

  Since:

  2.0

• getMaxFieldNameLength

  public int getMaxFieldNameLength()

  Specified by:

  getMaxFieldNameLength in interface IDBAdapter

  Since:

  2.0

• getFieldLength

  public int getFieldLength(DBType type)

  Description copied from interface: IDBAdapter

  Returns the column length for the given database type.

  Specified by:

  getFieldLength in interface IDBAdapter

  Parameters:

  type - the DBType to check.

  Returns:

  the supported column length for the type.

  Since:

  4.2

• isTypeIndexable

  public boolean isTypeIndexable(DBType type)

  Specified by:

  isTypeIndexable in interface IDBAdapter

• toString

  public String toString()

  Overrides:

  toString in class Object

• convertString

  public String convertString(PreparedStatement preparedStatement, int parameterIndex, String value)

  Description copied from interface: IDBAdapter

  Converts a string before it is bound to a prepared statement.

  Specified by:

  convertString in interface IDBAdapter

  Since:

  4.3

• convertString

  public String convertString(ResultSet resultSet, int columnIndex, String value)

  Description copied from interface: IDBAdapter

  Converts a string read from a result-set column.

  Specified by:

  convertString in interface IDBAdapter

  Since:

  4.3

• convertString

  public String convertString(ResultSet resultSet, String columnLabel, String value)

  Description copied from interface: IDBAdapter

  Converts a string read from a named result-set column.

  Specified by:

  convertString in interface IDBAdapter

  Since:

  4.3

• doCreateTable

  protected void doCreateTable(IDBTable table, Statement statement) throws SQLException

  Throws:

  SQLException

  Since:

  2.0

• createIndex

  protected void createIndex(IDBIndex index, Statement statement, int num) throws SQLException

  Throws:

  SQLException

  Since:

  2.0

• addIndexField

  protected void addIndexField(StringBuilder builder, IDBField field)

• createConstraints

  protected String createConstraints(IDBTable table)

  Since:

  2.0

• createFieldDefinition

  protected String createFieldDefinition(IDBField field)

  Since:

  2.0

• getNullableConstraint

  protected String getNullableConstraint()

  Since:

  4.12

• getTypeName

  protected String getTypeName(IDBField field)

• getSQL92ReservedWords

  public String[] getSQL92ReservedWords()

  Description copied from interface: IDBAdapter

  Returns the SQL-92 reserved words used by the adapter implementation.

  Specified by:

  getSQL92ReservedWords in interface IDBAdapter

• isReservedWord

  public boolean isReservedWord(String word)

  Specified by:

  isReservedWord in interface IDBAdapter

• validateTable

  protected void validateTable(IDBTable table, Statement statement) throws DBException

  Throws:

  DBException

  Since:

  2.0

• createFieldDefinitions

  protected String[] createFieldDefinitions(IDBTable table)

  Since:

  4.2

• appendFieldNames

  public void appendFieldNames(Appendable appendable, IDBTable table)

  Description copied from interface: IDBAdapter

  Appends the field names used by the adapter's table SQL generation.

  Specified by:

  appendFieldNames in interface IDBAdapter

• appendFieldDefs

  protected void appendFieldDefs(Appendable appendable, IDBTable table, String[] defs)

  Since:

  4.2

• adaptType

  public DBType adaptType(DBType type)

  Description copied from interface: IDBAdapter

  Provide a way for the DBAdapter to override unsupported DB types with replacements. The default implementation just returns the given type. Subclasses may override single types with replacements.

  Specified by:

  adaptType in interface IDBAdapter

  Since:

  3.0

• getJDBCTypeForNull

  public int getJDBCTypeForNull(DBType type)

  Description copied from interface: IDBAdapter

  Returns the JDBC type to use when binding a null value for the given database type.

  Specified by:

  getJDBCTypeForNull in interface IDBAdapter

  Since:

  4.14

• useJavaTypeForUnknownParameterType

  public boolean useJavaTypeForUnknownParameterType()

  Description copied from interface: IDBAdapter

  Returns whether a Java value's type may select a specialized JDBC setter when its logical database type is unknown. If this method returns false, unknown non-null values use PreparedStatement.setObject(int, Object). If it returns true, supported scalar Java types may use their corresponding typed setter; unsupported values still use setObject. This policy does not affect parameters with an inferred database type.

  Specified by:

  useJavaTypeForUnknownParameterType in interface IDBAdapter

  Returns:

  true to use supported Java scalar types for unknown parameters; otherwise false

  Since:

  4.15

• bindParameter

  public void bindParameter(PreparedStatement stmt, int index, DBType type, Object value) throws SQLException

  Description copied from interface: IDBAdapter

  Binds a converted value using the JDBC operation selected by this adapter for its logical database type and Java value type. The value may be null. Implementations may specialize compatible scalar types; values without a supported specialization use PreparedStatement.setObject(int, Object). A null value with a known type uses this adapter's IDBAdapter.getJDBCTypeForNull(DBType) mapping. A null value with an unknown type may use generic object binding. The default preserves generic binding for adapters that do not override this operation.

  Specified by:

  bindParameter in interface IDBAdapter

  Parameters:

  stmt - the prepared statement

  index - the one-based JDBC parameter index

  type - the inferred logical database type, or null if it cannot be inferred

  value - the converted Java value, possibly null

  Throws:

  SQLException - if JDBC reports a binding failure

  Since:

  4.15

• bindParameterBoolean

  protected void bindParameterBoolean(PreparedStatement stmt, int index, boolean value) throws SQLException

  Binds a boolean parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the boolean value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterByte

  protected void bindParameterByte(PreparedStatement stmt, int index, byte value) throws SQLException

  Binds a byte parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the byte value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterShort

  protected void bindParameterShort(PreparedStatement stmt, int index, short value) throws SQLException

  Binds a short parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the short value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterInt

  protected void bindParameterInt(PreparedStatement stmt, int index, int value) throws SQLException

  Binds an integer parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the integer value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterLong

  protected void bindParameterLong(PreparedStatement stmt, int index, long value) throws SQLException

  Binds a long parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the long value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterFloat

  protected void bindParameterFloat(PreparedStatement stmt, int index, float value) throws SQLException

  Binds a float parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the float value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterDouble

  protected void bindParameterDouble(PreparedStatement stmt, int index, double value) throws SQLException

  Binds a double parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the double value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterBigDecimal

  protected void bindParameterBigDecimal(PreparedStatement stmt, int index, BigDecimal value) throws SQLException

  Binds a decimal parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the decimal value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterString

  protected void bindParameterString(PreparedStatement stmt, int index, String value) throws SQLException

  Binds a string parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the string value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterBytes

  protected void bindParameterBytes(PreparedStatement stmt, int index, byte[] value) throws SQLException

  Binds a byte array parameter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the byte array value

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterObject

  protected void bindParameterObject(PreparedStatement stmt, int index, Object value) throws SQLException

  Binds a parameter using JDBC's generic object setter.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  value - the value, which may be null

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• bindParameterNull

  protected void bindParameterNull(PreparedStatement stmt, int index, DBType type) throws SQLException

  Binds a null parameter using the JDBC type associated with a database type.

  Parameters:

  stmt - the JDBC statement

  index - the one-based JDBC parameter index

  type - the non-null database type

  Throws:

  SQLException - if the JDBC operation fails

  Since:

  4.15

• isValidFirstChar

  public boolean isValidFirstChar(char ch)

  Description copied from interface: IDBAdapter

  Check if a character is valid as first character. (e.g., underscores are forbidden as first character in Derby elements.

  Specified by:

  isValidFirstChar in interface IDBAdapter

  Since:

  4.0

• isDuplicateKeyException

  public boolean isDuplicateKeyException(SQLException ex)

  Description copied from interface: IDBAdapter

  Check if an exception indicates a constraint violation (duplicate key)

  Specified by:

  isDuplicateKeyException in interface IDBAdapter

  Since:

  4.0

• isDuplicateKeyTransactionAbort

  public boolean isDuplicateKeyTransactionAbort()

  Description copied from interface: IDBAdapter

  Returns whether a duplicate-key exception aborts the current JDBC transaction and therefore requires a savepoint to recover from it.

  Specified by:

  isDuplicateKeyTransactionAbort in interface IDBAdapter

• isTableNotFoundException

  public boolean isTableNotFoundException(SQLException ex)

  Specified by:

  isTableNotFoundException in interface IDBAdapter

  Since:

  4.2

• isColumnNotFoundException

  public boolean isColumnNotFoundException(SQLException ex)

  Specified by:

  isColumnNotFoundException in interface IDBAdapter

  Since:

  4.2

• quoteIdentifier

  public final String quoteIdentifier(String identifier)

  Description copied from interface: IDBAdapter

  Quotes one SQL identifier using the adapter's identifier delimiter. Qualified names must be split into their individual components before calling this method. Quoting can be disabled globally with DBUtil.DISABLE_QUOTED_NAMES.

  Specified by:

  quoteIdentifier in interface IDBAdapter

  Parameters:

  identifier - one unqualified SQL identifier

  Returns:

  the identifier, quoted and escaped according to this adapter

• getIdentifierQuote

  protected String getIdentifierQuote()

  Returns the identifier delimiter used by quoteIdentifier(String). Subclasses override this method to provide a dialect-specific delimiter. The returned value is used only when quoted names have not been globally disabled.

  Returns:

  the identifier delimiter, or an empty string when the dialect does not quote identifiers

  Since:

  4.15

• escapeQuote

  protected String escapeQuote(String identifier, String quote)

  Escapes occurrences of the identifier delimiter inside an identifier. Subclasses may override this method when their dialect uses an escaping rule other than doubling the delimiter.

  Parameters:

  identifier - the unquoted identifier

  quote - the delimiter returned by getIdentifierQuote()

  Returns:

  the identifier with delimiter occurrences escaped

  Since:

  4.15

• sqlRenameField

  public String sqlRenameField(IDBField field, String oldName)

  Specified by:

  sqlRenameField in interface IDBAdapter

  Since:

  4.2

• sqlModifyField

  public String sqlModifyField(IDBField field)

  Specified by:

  sqlModifyField in interface IDBAdapter

  Since:

  4.2

• sqlModifyField

  protected String sqlModifyField(String tableName, String fieldName, String definition)

  Since:

  4.2

• sqlCharIndex

  public String sqlCharIndex(Object substring, Object string)

  Specified by:

  sqlCharIndex in interface IDBAdapter

• sqlCharIndexFunction

  protected String sqlCharIndexFunction()

  Since:

  4.13

• sqlSubstring

  public String sqlSubstring(Object string, Object startIndex, Object length)

  Specified by:

  sqlSubstring in interface IDBAdapter

• sqlSubstring

  public String sqlSubstring(Object string, Object startIndex)

  Specified by:

  sqlSubstring in interface IDBAdapter

• sqlSubstringFunction

  protected String sqlSubstringFunction()

  Since:

  4.13

• sqlConcat

  public String sqlConcat(Object... strings)

  Specified by:

  sqlConcat in interface IDBAdapter

• format

  public String format(PreparedStatement stmt)

  Description copied from interface: IDBAdapter

  Formats a prepared statement for diagnostic output.

  Specified by:

  format in interface IDBAdapter

  Since:

  4.2

• format

  public String format(ResultSet resultSet)

  Description copied from interface: IDBAdapter

  Formats a result set for diagnostic output.

  Specified by:

  format in interface IDBAdapter

  Since:

  4.2

• convertToSQL

  public Object convertToSQL(Object value)

  Description copied from interface: IDBAdapter

  Converts a Java value to the value used by SQL query execution.

  Specified by:

  convertToSQL in interface IDBAdapter

  Since:

  4.9

• getIndexInfos

  public static void getIndexInfos(DatabaseMetaData metaData, String schemaName, String tableName, Consumer<DBAdapter.IndexInfo> consumer) throws SQLException

  Throws:

  SQLException

  Since:

  4.13

• getDefaultDBLength

  public static int getDefaultDBLength(DBType type)

  Since:

  4.2

• generateReservedWords

  protected static void generateReservedWords(Connection connection, String[] words) throws SQLException

  Throws:

  SQLException

  Since:

  4.9

• readIndices

  @Deprecated protected void readIndices(Connection connection, ResultSet resultSet, IDBTable table, int indexNameColumn, int indexTypeColumn, int fieldNameColumn, int fieldPositionColumn) throws SQLException

  Deprecated.

  As of 4.13 no longer supported. Use getIndexInfos(DatabaseMetaData, String, String, Consumer) instead.

  Throws:

  SQLException

  Since:

  4.2

• createField

  @Deprecated protected void createField(Connection connection, String tableName, IDBField field)

  Deprecated.

  As of 4.13 use createField(Connection, IDBField) instead.

  Since:

  4.6

• dropField

  @Deprecated protected void dropField(Connection connection, String tableName, String fieldName)

  Deprecated.

  As of 4.13 use dropField(Connection, IDBField) instead.

  Since:

  4.6

• getJDBCDriver

  @Deprecated public Driver getJDBCDriver()

  Deprecated.

  As of 4.2 no longer supported because of IP issues for external build dependencies (the vendor driver libs).

  Specified by:

  getJDBCDriver in interface IDBAdapter

  Since:

  4.2

• createJDBCDataSource

  @Deprecated public DataSource createJDBCDataSource()

  Deprecated.

  As of 4.2 no longer supported because of IP issues for external build dependencies (the vendor driver libs).

  Specified by:

  createJDBCDataSource in interface IDBAdapter

  Since:

  4.2