Interface IDBAdapter

Method Details

• getName

  String getName()

  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 IDBAdapterID

  Returns:

  the adapter name

• getVersion

  String getVersion()

  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 IDBAdapterID

  Returns:

  the adapter version

• getDatabaseProductNames

  default String[] getDatabaseProductNames()

  Returns the JDBC database product names recognized by this adapter. Product names are trimmed and compared case-insensitively. The default recognizes the adapter's declared name. Implementations may return additional aliases.

  Returns:

  the exact JDBC product names recognized by this adapter

  Since:

  4.15

• getDatabaseProductNamePattern

  default String getDatabaseProductNamePattern()

  Returns an optional regular expression for additional JDBC product-name matching. It is matched case-insensitively against the complete trimmed product name. A matching product name is required even when this pattern is configured.

  Returns:

  a product-name regular expression, or null if none is needed

  Since:

  4.15

• getDatabaseDriverNamePattern

  default String getDatabaseDriverNamePattern()

  Returns an optional regular expression that constrains JDBC driver-name matching. The complete driver name must match case-insensitively; a missing driver name does not match.

  Returns:

  a JDBC driver-name regular expression, or null if no driver constraint applies

  Since:

  4.15

• getDatabaseURLPattern

  default String getDatabaseURLPattern()

  Returns an optional regular expression that constrains JDBC URL matching. The complete URL must match case-insensitively; a missing URL does not match.

  Returns:

  a JDBC URL regular expression, or null if no URL constraint applies

  Since:

  4.15

• isCaseSensitive

  boolean isCaseSensitive()

  Since:

  4.12

• getDefaultSchemaName

  String getDefaultSchemaName(Connection connection)

  Since:

  4.12

• createConnectionProvider

  IDBConnectionProvider createConnectionProvider(DataSource dataSource)

  Since:

  4.3

• modifyConnection

  Connection modifyConnection(Connection connection)

  Since:

  4.5

• createSchema

  void createSchema(Connection connection, String schemaName)

  Since:

  4.12

• openSchemaTransaction

  IDBSchemaTransaction openSchemaTransaction(IDBDatabase database, IDBConnection currentConnection)

  Opens a schema transaction through the adapter extension point.

  Since:

  4.14

• readSchema

  IDBSchema readSchema(Connection connection, String name)

  Since:

  4.2

• readSchema

  void readSchema(Connection connection, IDBSchema schema)

  Since:

  4.2

• updateSchema

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

  Throws:

  DBException

  Since:

  4.2

• createTables

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

  Throws:

  DBException

• createTable

  boolean createTable(IDBTable table, Statement statement) throws DBException

  Throws:

  DBException

• dropTables

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

  Throws:

  DBException

• dropTable

  boolean dropTable(IDBTable table, Statement statement)

• getReservedWords

  String[] getReservedWords()

• isReservedWord

  boolean isReservedWord(String word)

• getMaxTableNameLength

  int getMaxTableNameLength()

  Since:

  2.0

• getMaxFieldNameLength

  int getMaxFieldNameLength()

  Since:

  2.0

• getFieldLength

  int getFieldLength(DBType type)

  Returns the column length for the given database type.

  Parameters:

  type - the DBType to check.

  Returns:

  the supported column length for the type.

  Since:

  4.2

• isTypeIndexable

  boolean isTypeIndexable(DBType type)

• convertString

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

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

  Since:

  4.14

• convertString

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

  Converts a string read from a result-set column.

  Since:

  4.14

• convertString

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

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

  Since:

  4.14

• getSQL92ReservedWords

  String[] getSQL92ReservedWords()

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

  Since:

  4.14

• appendFieldNames

  void appendFieldNames(Appendable appendable, IDBTable table)

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

  Since:

  4.14

• adaptType

  DBType adaptType(DBType type)

  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.

  Since:

  3.0

• getJDBCTypeForNull

  int getJDBCTypeForNull(DBType type)

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

  Since:

  4.14

• useJavaTypeForUnknownParameterType

  default boolean useJavaTypeForUnknownParameterType()

  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.

  Returns:

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

  Since:

  4.15

• bindParameter

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

  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 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.

  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

• isValidFirstChar

  boolean isValidFirstChar(char ch)

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

  Since:

  4.0

• isDuplicateKeyTransactionAbort

  boolean isDuplicateKeyTransactionAbort()

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

  Since:

  4.14

• isDuplicateKeyException

  boolean isDuplicateKeyException(SQLException ex)

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

  Since:

  4.0

• isTableNotFoundException

  boolean isTableNotFoundException(SQLException ex)

  Since:

  4.2

• isColumnNotFoundException

  boolean isColumnNotFoundException(SQLException ex)

  Since:

  4.2

• quoteIdentifier

  String quoteIdentifier(String identifier)

  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.

  Parameters:

  identifier - one unqualified SQL identifier

  Returns:

  the identifier, quoted and escaped according to this adapter

  Since:

  4.15

• quoteTableName

  default String quoteTableName(IDBTable table)

  Quotes the physical name of a table for use in SQL. When the table's schema enables qualified table names, the schema and table names are quoted independently and joined with a dot. This preserves the distinction between identifier components and avoids treating the dot as part of either identifier. Each component is escaped according to this adapter's quoteIdentifier(String) implementation, and the global quoted-name compatibility setting remains in effect.

  Parameters:

  table - the schema table to render

  Returns:

  the adapter-specific table name, including its schema when configured

  Since:

  4.15

• validateSQLLiteral

  default void validateSQLLiteral(Object value)

  Validates whether the given value can be rendered as a SQL literal by this adapter. The default implementation performs no additional validation; adapters with dialect-specific restrictions may reject values during DML compilation.

  Parameters:

  value - the Java value, possibly null

  Throws:

  IllegalArgumentException - if the value is not supported

  Since:

  4.15

• sqlRenameField

  String sqlRenameField(IDBField field, String oldName)

  Since:

  4.2

• sqlModifyField

  String sqlModifyField(IDBField field)

  Since:

  4.2

• sqlCharIndex

  String sqlCharIndex(Object substring, Object string)

  Since:

  4.13

• sqlSubstring

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

  Since:

  4.13

• sqlSubstring

  String sqlSubstring(Object string, Object startIndex)

  Since:

  4.13

• sqlConcat

  String sqlConcat(Object... strings)

  Since:

  4.13

• format

  String format(PreparedStatement stmt)

  Formats a prepared statement for diagnostic output.

  Since:

  4.14

• format

  String format(ResultSet resultSet)

  Formats a result set for diagnostic output.

  Since:

  4.14

• convertToSQL

  Object convertToSQL(Object value)

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

  Since:

  4.14

• getJDBCDriver

  @Deprecated Driver getJDBCDriver()

  Deprecated.

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

• createJDBCDataSource

  @Deprecated DataSource createJDBCDataSource()

  Deprecated.

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