Oracle (Tentackle SQL 2.1.2 API)

java.lang.Object
- org.tentackle.sql.AbstractBackend
- - org.tentackle.sql.AbstractSql92Backend
  - - org.tentackle.sql.AbstractSql2003Backend
    - - org.tentackle.sql.Oracle

All Implemented Interfaces:: Backend

@Service(value=Backend.class)
public class Oracle
extends AbstractSql2003Backend

Backend for Oracle. Contains some Oracle-specific utility methods as well:

Date-conversion: Oracle does not use an index on a DATE-column if passed as a Timestamp-variable via a prepared statement, even if used in conjunction with an SQL-hint /*+ INDEX(...) In such cases the TO_DATE-function must be explicitly used.

 Example:

      if (getDb().isOracle()) {
        query.add(" AND m." + CN_ZEITPUNKT + ">=" + OracleHelper.timestampString(par.vonZeitpunkt));
      }
      else  {
        query.add(" AND m." + CN_ZEITPUNKT + ">=?", par.vonZeitpunkt);
      }


 or:
      if (getDb().isOracle()) {
        query.add(" AND m." + CN_ZEITPUNKT + ">=TO_DATE(?,'" + OracleHelper.ORA_TIMESTAMP_FORMAT + "')",
                  OracleHelper.TIMESTAMP_FORMAT.format(par.vonZeitpunkt));
      }
      else  {
        query.add(" AND m." + CN_ZEITPUNKT + ">=?", par.vonZeitpunkt);
      }

Rule: if possible use TIMESTAMP column type for a Timestamp-java attribute. In such a case at least Oracle 10 uses the correct index and you don't need this workaround.

Author:: harald

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SQL_NESTED_SELECT_1` window function part 1.
`static String`	`SQL_NESTED_SELECT_2` window function part 2.
`static String`	`SQL_NESTED_SELECT_LIMIT` condition for limit and offset.
`static String`	`SQL_NESTED_SELECT_OFFSET` condition for limit and offset.
`static String`	`SQL_NESTED_SELECT_ROWNUM` condition for limit and offset.

Fields inherited from class org.tentackle.sql.AbstractSql2003Backend
RESERVED_WORDS_SQL2003, SQL_WINDOW_1, SQL_WINDOW_2, SQL_WINDOW_LIMIT, SQL_WINDOW_OFFSET

Fields inherited from class org.tentackle.sql.AbstractSql92Backend
RESERVED_WORDS_SQL92, SQL_COALESCE, SQL_FOR_UPDATE

Fields inherited from class org.tentackle.sql.AbstractBackend
EMPTY_STRING, TYPE_BIGINT, TYPE_BIT, TYPE_BLOB, TYPE_BOOL, TYPE_BOOLEAN, TYPE_BYTE, TYPE_BYTEA, TYPE_CHAR_1, TYPE_DATE, TYPE_DATETIME, TYPE_DATETIME_YEAR_TO_SECOND, TYPE_DECIMAL, TYPE_DECIMAL_19, TYPE_DOUBLE, TYPE_FLOAT, TYPE_FLOAT4, TYPE_FLOAT8, TYPE_INT, TYPE_INT2, TYPE_INT4, TYPE_INT8, TYPE_INTEGER, TYPE_NCHAR_1, TYPE_NUMBER, TYPE_NUMBER_1, TYPE_NUMBER_10, TYPE_NUMBER_19, TYPE_NUMBER_5, TYPE_NVARCHAR, TYPE_NVARCHAR_MAX, TYPE_REAL, TYPE_SMALLFLOAT, TYPE_SMALLINT, TYPE_TEXT, TYPE_TIME, TYPE_TIMESTAMP, TYPE_TINYINT, TYPE_VARBINARY_MAX, TYPE_VARCHAR

Constructor Summary

Constructors
Constructor and Description

Oracle()

Constructors
Constructor and Description
`Oracle()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assertValidName(String nameType, String name)` Asserts that given string is a valid name and usage.
`void`	`buildSelectSql(StringBuilder sqlBuilder, boolean writeLock, int limit, int offset)` Creates a select statement string from an inner sql string.
`Connection`	`createConnection(String url, String username, char[] password)` Creates a jdbc connection.
`static String`	`dateString(Date date)` Converts a date to a string.
`protected String`	`extractWhereClause(String sql, int whereOffset)` Extracts the where clause from a given sql.
`String`	`getBackendId(Connection connection)` Determines the unique id or name used by the backend for a given connection.
`String`	`getDriverClassName()` Gets the JDBC driver class name.
`String`	`getEmptyString()` Gets the empty string.
`int`	`getMaxSize(SqlType sqlType)` Returns the maximum size for a given SQL-type.
`String`	`getName()` Gets the name of the backend.
`boolean`	`isMatchingUrl(String url)` Checks whether the backend belongs to the given jdbc url.
`boolean`	`isTemporaryName(String name)` Checks whether this is a temporary name. Returns whether an entity-, attribute- or index-name is temporary and should not be taken into account for migration or even used in the model. Depending on the backend, temporary names start with an underscore or some other lead string.
`SqlType[]`	`jdbcTypeToSqlType(int jdbcType, int size, int scale)` Converts the JDBC data type integer to a tentackle backend SqlTypes.
`String`	`sqlAddColumn(String tableName, String columnName, String comment, SqlType sqlType, int size, int scale, boolean nullable, Object defaultValue)` Generates sql code to add a column.
`String`	`sqlAlterColumnDefault(String tableName, String columnName, SqlType sqlType, Object defaultValue)` Generates sql code to change the default value a column.
`String`	`sqlAlterColumnNullConstraint(String tableName, String columnName, boolean nullable)` Generates sql code to change the null-constraint of a column.
`String`	`sqlAlterColumnType(String tableName, String columnName, String comment, SqlType sqlType, int size, int scale, boolean nullable, Object defaultValue)` Generates sql code to change the datatype of a column.
`String`	`sqlCreateColumnComment(String tableName, String columnName, String comment)` Generates SQL code to create the comment for an attribute.
`String`	`sqlCreateTableComment(String tableName, String comment)` Generates SQL code to create the comment for a table.
`String`	`sqlNextFromSequene(String name)` Creates the SQL string to retrieve the next id from a sequence.
`boolean`	`sqlRequiresExtraCommit()` According to the JDBC-specs `Connection.setAutoCommit(boolean)`(true) should commit, but some backends require an extra `Connection.commit()`.
`String`	`sqlTypeToString(SqlType sqlType, int size)` Converts the java SQL-type to the database type name.
`static String`	`timestampString(Timestamp timestamp)` Converts a timestamp to a string.
`static String`	`timeString(Time time)` Converts a time to a string.
`String`	`valueToLiteral(SqlType sqlType, Object value)` Conberts a type and value to a literal string.

Methods inherited from class org.tentackle.sql.AbstractSql2003Backend
getReservedWords, setLeadingSelectParameters, setTrailingSelectParameters, supportsSequences

Methods inherited from class org.tentackle.sql.AbstractSql92Backend
getCoalesceKeyword, sqlCreateForeignKey, sqlDropForeignKey

Methods inherited from class org.tentackle.sql.AbstractBackend
allowsExpressionsReferringToTablesBeingUpdated, buildSelectSql, columnTypeNullDefaultToString, columnTypeToString, createColumnMetaData, createIndexColumnMetaData, createIndexMetaData, createTableMetaData, getDefaultSchema, getDefaultSize, getMaxScale, getMetaData, getMigrationStrategy, getModelMetaData, getTableMetaData, isCommunicationLinkException, isConstraintException, isDefaultEqual, isMatchingName, isReleaseSavepointSupported, needAliasForSubselect, needSetLongWorkaround, needTxForFetchsize, normalizeDefault, optimizeSql, sqlAlterColumnComment, sqlAlterTableComment, sqlAsBeforeTableAlias, sqlComment, sqlCreateColumn, sqlCreateIndex, sqlCreateTableAttributeWithoutComment, sqlCreateTableClosing, sqlCreateTableIntro, sqlCreateTableIntroWithoutComment, sqlDropColumn, sqlDropIndex, sqlFunction, sqlJoin, sqlJoinSelects, sqlJoinSelects, sqlRenameAndAlterColumnType, sqlRenameColumn, sqlResultSetIsClosedSupported, sqlUpdateToNotNull, toQuotedString, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SQL_NESTED_SELECT_1
```
public static final String SQL_NESTED_SELECT_1
```
    window function part 1.
    
    See Also:
    
    Constant Field Values
  - SQL_NESTED_SELECT_2
```
public static final String SQL_NESTED_SELECT_2
```
    window function part 2.
    
    See Also:
    
    Constant Field Values
  - SQL_NESTED_SELECT_ROWNUM
```
public static final String SQL_NESTED_SELECT_ROWNUM
```
    condition for limit and offset.
    
    See Also:
    
    Constant Field Values
  - SQL_NESTED_SELECT_LIMIT
```
public static final String SQL_NESTED_SELECT_LIMIT
```
    condition for limit and offset.
    
    See Also:
    
    Constant Field Values
  - SQL_NESTED_SELECT_OFFSET
```
public static final String SQL_NESTED_SELECT_OFFSET
```
    condition for limit and offset.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Oracle
```
public Oracle()
```
- Method Detail
  - dateString
```
public static String dateString(Date date)
```
    Converts a date to a string.
    
    Parameters:
    
    date - the date
    
    Returns:
    
    a TO_DATE-date-string
  - timeString
```
public static String timeString(Time time)
```
    Converts a time to a string.
    
    Parameters:
    
    time - the time
    
    Returns:
    
    a TO_DATE-time-string
  - timestampString
```
public static String timestampString(Timestamp timestamp)
```
    Converts a timestamp to a string.
    
    Parameters:
    
    timestamp - the timestamp
    
    Returns:
    
    a TO_DATE-timestamp-string
  - getDriverClassName
```
public String getDriverClassName()
```
    Description copied from interface: Backend
    
    Gets the JDBC driver class name.
    
    Returns:
    
    the class name
  - createConnection
```
public Connection createConnection(String url,
                                   String username,
                                   char[] password)
                            throws SQLException
```
    Description copied from interface: Backend
    
    Creates a jdbc connection.
    
    Specified by:
    
    createConnection in interface Backend
    
    Overrides:
    
    createConnection in class AbstractBackend
    
    Parameters:
    
    url - the jdbc url
    
    username - the username
    
    password - the password
    
    Returns:
    
    the created connection
    
    Throws:
    
    SQLException - if connection could not be established
  - isMatchingUrl
```
public boolean isMatchingUrl(String url)
```
    Description copied from interface: Backend
    
    Checks whether the backend belongs to the given jdbc url.
    
    Parameters:
    
    url - the jdbc url
    
    Returns:
    
    true if matches
  - getName
```
public String getName()
```
    Description copied from interface: Backend
    
    Gets the name of the backend.
    
    Returns:
    
    the name
  - getBackendId
```
public String getBackendId(Connection connection)
```
    Description copied from interface: Backend
    
    Determines the unique id or name used by the backend for a given connection.
    Useful to figure out the corresponding ManagedConnection from the backend's logfiles.
    
    Parameters:
    
    connection - the jdbc connection
    
    Returns:
    
    the backend id, null if none
  - isTemporaryName
```
public boolean isTemporaryName(String name)
```
    Description copied from interface: Backend
    
    Checks whether this is a temporary name.
    Returns whether an entity-, attribute- or index-name is temporary and should not be taken into account for migration or even used in the model.
    Depending on the backend, temporary names start with an underscore or some other lead string.
    
    Specified by:
    
    isTemporaryName in interface Backend
    
    Overrides:
    
    isTemporaryName in class AbstractBackend
    
    Parameters:
    
    name - the name
    
    Returns:
    
    true temporary (invalid) name
  - assertValidName
```
public void assertValidName(String nameType,
                            String name)
```
    Description copied from interface: Backend
    
    Asserts that given string is a valid name and usage.
    
    Specified by:
    
    assertValidName in interface Backend
    
    Overrides:
    
    assertValidName in class AbstractBackend
    
    Parameters:
    
    nameType - the type/usage of the name
    
    name - the name
  - getEmptyString
```
public String getEmptyString()
```
    Description copied from interface: Backend
    
    Gets the empty string.
    Some dbms (most famous: Oracle) handle empty strings as null. In such cases the empty string (e.g. Oracle) may consist of a single blank or whatever.
    
    Specified by:
    
    getEmptyString in interface Backend
    
    Overrides:
    
    getEmptyString in class AbstractBackend
    
    Returns:
    
    the empty string (never null)
  - valueToLiteral
```
public String valueToLiteral(SqlType sqlType,
                             Object value)
```
    Description copied from interface: Backend
    
    Conberts a type and value to a literal string.
    
    Specified by:
    
    valueToLiteral in interface Backend
    
    Overrides:
    
    valueToLiteral in class AbstractBackend
    
    Parameters:
    
    sqlType - the sql type
    
    value - the value
    
    Returns:
    
    the constant
  - sqlRequiresExtraCommit
```
public boolean sqlRequiresExtraCommit()
```
    Description copied from interface: Backend
    
    According to the JDBC-specs Connection.setAutoCommit(boolean)(true) should commit, but some backends require an extra Connection.commit().
    
    Specified by:
    
    sqlRequiresExtraCommit in interface Backend
    
    Overrides:
    
    sqlRequiresExtraCommit in class AbstractBackend
    
    Returns:
    
    true if the database needs an extra commit
  - buildSelectSql
```
public void buildSelectSql(StringBuilder sqlBuilder,
                           boolean writeLock,
                           int limit,
                           int offset)
```
    Description copied from interface: Backend
    
    Creates a select statement string from an inner sql string.
    sqlBuilder is anything as FROM... WHERE... ORDER BY....
    It is decorated with a leading SELECT plus optional clauses like for the given parameters.
    
    Specified by:
    
    buildSelectSql in interface Backend
    
    Overrides:
    
    buildSelectSql in class AbstractSql2003Backend
    
    Parameters:
    
    sqlBuilder - the sql builder, initially containing the inner sql without leading SELECT.
    
    writeLock - true select should write lock
    
    limit - the limit value, ≤ 0 if no limit clause
    
    offset - the offset value, ≤ 0 if no offset clause
  - getMaxSize
```
public int getMaxSize(SqlType sqlType)
```
    Description copied from interface: Backend
    
    Returns the maximum size for a given SQL-type.
    
    Specified by:
    
    getMaxSize in interface Backend
    
    Overrides:
    
    getMaxSize in class AbstractBackend
    
    Parameters:
    
    sqlType - the SQL-type
    
    Returns:
    
    the maximum size, 0 if unlimited, -1 if type without size
  - sqlTypeToString
```
public String sqlTypeToString(SqlType sqlType,
                              int size)
```
    Description copied from interface: Backend
    
    Converts the java SQL-type to the database type name.
    
    Specified by:
    
    sqlTypeToString in interface Backend
    
    Overrides:
    
    sqlTypeToString in class AbstractBackend
    
    Parameters:
    
    sqlType - the java sql type
    
    size - the column's size
    
    Returns:
    
    the corresponding type string
  - jdbcTypeToSqlType
```
public SqlType[] jdbcTypeToSqlType(int jdbcType,
                                   int size,
                                   int scale)
```
    Description copied from interface: Backend
    
    Converts the JDBC data type integer to a tentackle backend SqlTypes.
    There may be more than one sqltype returned!
    
    Specified by:
    
    jdbcTypeToSqlType in interface Backend
    
    Overrides:
    
    jdbcTypeToSqlType in class AbstractBackend
    
    Parameters:
    
    jdbcType - the jdbc data type
    
    size - the column size
    
    scale - the column's scale
    
    Returns:
    
    the SqlTypes, empty array if no mapping available or no exact match (not generated by TT)
    
    See Also:
    
    Types
  - sqlNextFromSequene
```
public String sqlNextFromSequene(String name)
```
    Description copied from interface: Backend
    
    Creates the SQL string to retrieve the next id from a sequence.
    
    Specified by:
    
    sqlNextFromSequene in interface Backend
    
    Overrides:
    
    sqlNextFromSequene in class AbstractSql2003Backend
    
    Parameters:
    
    name - the name of the sequence
    
    Returns:
    
    the SQL code
  - sqlCreateTableComment
```
public String sqlCreateTableComment(String tableName,
                                    String comment)
```
    Description copied from interface: Backend
    
    Generates SQL code to create the comment for a table.
    
    Specified by:
    
    sqlCreateTableComment in interface Backend
    
    Overrides:
    
    sqlCreateTableComment in class AbstractBackend
    
    Parameters:
    
    tableName - the table name
    
    comment - optional comment, null if none
    
    Returns:
    
    the SQL code, empty string if comment is created via Backend.sqlCreateTableIntro(java.lang.String, java.lang.String) or Backend.sqlCreateTableClosing(java.lang.String, java.lang.String)
  - sqlCreateColumnComment
```
public String sqlCreateColumnComment(String tableName,
                                     String columnName,
                                     String comment)
```
    Description copied from interface: Backend
    
    Generates SQL code to create the comment for an attribute.
    
    Specified by:
    
    sqlCreateColumnComment in interface Backend
    
    Overrides:
    
    sqlCreateColumnComment in class AbstractBackend
    
    Parameters:
    
    tableName - the table name
    
    columnName - the column name
    
    comment - optional comment, null if none
    
    Returns:
    
    the SQL code, empty string if comment is created via Backend.sqlCreateColumn(java.lang.String, java.lang.String, org.tentackle.sql.SqlType, int, int, boolean, java.lang.Object, boolean, boolean)
  - sqlAddColumn
```
public String sqlAddColumn(String tableName,
                           String columnName,
                           String comment,
                           SqlType sqlType,
                           int size,
                           int scale,
                           boolean nullable,
                           Object defaultValue)
```
    Description copied from interface: Backend
    
    Generates sql code to add a column.
    
    Specified by:
    
    sqlAddColumn in interface Backend
    
    Overrides:
    
    sqlAddColumn in class AbstractBackend
    
    Parameters:
    
    tableName - the tablename
    
    columnName - the new column name
    
    comment - optional comment, null if none
    
    sqlType - the JDBC sql type
    
    size - the optional size
    
    scale - the optional scale
    
    nullable - true if NULL, else NOT NULL
    
    defaultValue - the optional default value
    
    Returns:
    
    the SQL code
  - sqlAlterColumnNullConstraint
```
public String sqlAlterColumnNullConstraint(String tableName,
                                           String columnName,
                                           boolean nullable)
```
    Description copied from interface: Backend
    
    Generates sql code to change the null-constraint of a column.
    
    Specified by:
    
    sqlAlterColumnNullConstraint in interface Backend
    
    Overrides:
    
    sqlAlterColumnNullConstraint in class AbstractBackend
    
    Parameters:
    
    tableName - the tablename
    
    columnName - the new column name
    
    nullable - true if NULL, else NOT NULL
    
    Returns:
    
    the SQL code, null if need Backend.sqlAlterColumnType(java.lang.String, java.lang.String, java.lang.String, org.tentackle.sql.SqlType, int, int, boolean, java.lang.Object)
  - sqlAlterColumnType
```
public String sqlAlterColumnType(String tableName,
                                 String columnName,
                                 String comment,
                                 SqlType sqlType,
                                 int size,
                                 int scale,
                                 boolean nullable,
                                 Object defaultValue)
```
    Description copied from interface: Backend
    
    Generates sql code to change the datatype of a column.
    
    Specified by:
    
    sqlAlterColumnType in interface Backend
    
    Overrides:
    
    sqlAlterColumnType in class AbstractBackend
    
    Parameters:
    
    tableName - the tablename
    
    columnName - the new column name
    
    comment - optional comment, null if none
    
    sqlType - the JDBC sql type
    
    size - the optional size
    
    scale - the optional scale
    
    nullable - true if NULL, else NOT NULL
    
    defaultValue - the optional default value
    
    Returns:
    
    the SQL code
  - sqlAlterColumnDefault
```
public String sqlAlterColumnDefault(String tableName,
                                    String columnName,
                                    SqlType sqlType,
                                    Object defaultValue)
```
    Description copied from interface: Backend
    
    Generates sql code to change the default value a column.
    
    Specified by:
    
    sqlAlterColumnDefault in interface Backend
    
    Overrides:
    
    sqlAlterColumnDefault in class AbstractBackend
    
    Parameters:
    
    tableName - the tablename
    
    columnName - the new column name
    
    sqlType - the JDBC sql type
    
    defaultValue - the optional default value
    
    Returns:
    
    the SQL code, null if need Backend.sqlAlterColumnType(java.lang.String, java.lang.String, java.lang.String, org.tentackle.sql.SqlType, int, int, boolean, java.lang.Object)
  - extractWhereClause
```
protected String extractWhereClause(String sql,
                                    int whereOffset)
```
    Description copied from class: AbstractBackend
    
    Extracts the where clause from a given sql.
    
    Overrides:
    
    extractWhereClause in class AbstractBackend
    
    Parameters:
    
    sql - the sql statement
    
    whereOffset - the location of WHERE in sql
    
    Returns:
    
    the where clause without the keyword WHERE

Class Oracle

Field Summary

Fields inherited from class org.tentackle.sql.AbstractSql2003Backend

Fields inherited from class org.tentackle.sql.AbstractSql92Backend

Fields inherited from class org.tentackle.sql.AbstractBackend

Fields inherited from interface org.tentackle.sql.Backend

Constructor Summary

Method Summary

Methods inherited from class org.tentackle.sql.AbstractSql2003Backend

Methods inherited from class org.tentackle.sql.AbstractSql92Backend

Methods inherited from class org.tentackle.sql.AbstractBackend

Methods inherited from class java.lang.Object

Field Detail

SQL_NESTED_SELECT_1

SQL_NESTED_SELECT_2

SQL_NESTED_SELECT_ROWNUM

SQL_NESTED_SELECT_LIMIT

SQL_NESTED_SELECT_OFFSET

Constructor Detail

Oracle

Method Detail

dateString

timeString

timestampString

getDriverClassName

createConnection

isMatchingUrl

getName

getBackendId

isTemporaryName

assertValidName

getEmptyString

valueToLiteral

sqlRequiresExtraCommit

buildSelectSql

getMaxSize

sqlTypeToString

jdbcTypeToSqlType

sqlNextFromSequene

sqlCreateTableComment

sqlCreateColumnComment

sqlAddColumn

sqlAlterColumnNullConstraint

sqlAlterColumnType

sqlAlterColumnDefault

extractWhereClause