Module org.tentackle.sql

Package org.tentackle.sql.backends

Class AbstractSql2003Backend

java.lang.Object

org.tentackle.sql.backends.AbstractBackend

org.tentackle.sql.backends.AbstractSql92Backend

org.tentackle.sql.backends.AbstractSql2003Backend

All Implemented Interfaces:

Backend

Direct Known Subclasses:

AbstractSql2008Backend, Db2, MsSql, Oracle8

public abstract class AbstractSql2003Backend
extends AbstractSql92Backend

Common to all SQL2003 backends.

Author:

harald

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	RESERVED_WORDS_SQL2003	array of additional reserved words.
static final String	SQL_WINDOW_1	window function part 1.
static final String	SQL_WINDOW_2	window function part 2.
static final String	SQL_WINDOW_LIMIT	condition for limit and offset.
static final String	SQL_WINDOW_OFFSET	condition for limit and offset.

Fields inherited from class org.tentackle.sql.backends.AbstractSql92Backend

RESERVED_WORDS_SQL92, SQL_COALESCE, SQL_FOR_UPDATE

Fields inherited from class org.tentackle.sql.backends.AbstractBackend

TYPE_BIGINT, TYPE_BIT, TYPE_BLOB, TYPE_BOOL, TYPE_BOOLEAN, TYPE_BYTE, TYPE_BYTEA, TYPE_CHAR_1, TYPE_CLOB, TYPE_DATE, TYPE_DATETIME, TYPE_DATETIME_YEAR_TO_SECOND, TYPE_DECIMAL, TYPE_DECIMAL_19, TYPE_DOUBLE, TYPE_DOUBLE_PRECISION, 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_UUID, TYPE_VARBINARY_MAX, TYPE_VARCHAR

Fields inherited from interface org.tentackle.sql.Backend

SQL_ALLSTAR, SQL_ALTER_COLUMN, SQL_ALTER_INDEX, SQL_ALTER_TABLE, SQL_AND, SQL_ANDNOT, SQL_ARRAY_ALL, SQL_ARRAY_ALL_PAR, SQL_ARRAY_ANY, SQL_ARRAY_ANY_PAR, SQL_ARRAY_IN, SQL_ARRAY_IN_PAR, SQL_ARRAY_NOT_IN, SQL_ARRAY_NOT_IN_PAR, SQL_ARRAY_PAR, SQL_COMMA, SQL_COMMA_PAR, SQL_DELETE, SQL_DOT_STAR, SQL_EQUAL, SQL_EQUAL_PAR, SQL_EQUAL_PAR_COMMA, SQL_EQUAL_ZERO, SQL_EXISTS, SQL_FROM, SQL_GREATER, SQL_GREATER_PAR, SQL_GREATEROREQUAL, SQL_GREATEROREQUAL_PAR, SQL_GROUPBY, SQL_IF_EXISTS, SQL_INSERT_INTO, SQL_INSERT_VALUES, SQL_ISNOTNULL, SQL_ISNULL, SQL_LEFT_PARENTHESIS, SQL_LESS, SQL_LESS_PAR, SQL_LESSOREQUAL, SQL_LESSOREQUAL_PAR, SQL_LIKE, SQL_LIKE_PAR, SQL_MAX, SQL_MIN, SQL_NOT, SQL_NOTEQUAL, SQL_NOTEQUAL_PAR, SQL_NOTEQUAL_ZERO, SQL_NOTLIKE, SQL_NOTLIKE_PAR, SQL_OR, SQL_ORDERBY, SQL_ORNOT, SQL_PAR, SQL_PAR_COMMA, SQL_PLUS_ONE, SQL_RIGHT_PARENTHESIS, SQL_SELECT, SQL_SELECT_ALL_FROM, SQL_SET, SQL_SORTASC, SQL_SORTDESC, SQL_UPDATE, SQL_WHERE, SQL_WHEREALL, SQL_WHEREAND, SQL_WHERENOTHING, SQL_WHEREOR

Constructor Summary

Constructors

Constructor	Description
AbstractSql2003Backend()	Parent constructor.

Method Summary

Modifier and Type	Method	Description
void	buildSelectSql(StringBuilder sqlBuilder, boolean writeLock, int limit, int offset)	Creates a select statement string from an inner sql string.
Set<String>	getReservedWords()	Gets the list of reserved words for this backend.
boolean	isSequenceSupported()	True if backend provides locking-free sequences. Sequences must not take part in transactions, i.e.
int	setLeadingSelectParameters(BackendPreparedStatement stmt, int limit, int offset)	Sets optional parameters before applying the original parameters.
int	setTrailingSelectParameters(BackendPreparedStatement stmt, int index, int limit, int offset)	Sets optional parameters after applying the original parameters.
String	sqlCreateSequence(String name, Long start, Long increment)	Creates the SQL string to create a sequence.
String	sqlNextFromSequence(String name)	Creates the SQL string to retrieve the next id from a sequence.

Methods inherited from class org.tentackle.sql.backends.AbstractSql92Backend

getCoalesceKeyword, isLeadingSelectMissing, sqlCreateForeignKey, sqlCreateSequenceComment, sqlDropForeignKey

Methods inherited from class org.tentackle.sql.backends.AbstractBackend

assertValidName, buildSelectSql, columnTypeNullDefaultToString, columnTypeToString, createColumnMetaData, createConnection, createIndexColumnMetaData, createIndexMetaData, createPassword, createScriptRunner, createTableMetaData, extractWhereClause, getBlockCommentBegin, getBlockCommentBegins, getBlockCommentEnd, getBlockCommentEnds, getDefaultSchema, getDefaultSize, getEmptyString, getMaxScale, getMaxSize, getMetaData, getMigrationStrategy, getModelMetaData, getSingleLineComment, getSingleLineComments, getStatementSeparator, getStatementSeparators, getTableHeaders, getTableMetaData, isAliasRequiredForSubSelect, isArrayOperatorSupported, isClobSupported, isCommunicationLinkException, isConstraintException, isDatabaseInMemory, isDefaultEqual, isDeprecated, isDropIfExistsEnabled, isDropIfExistsSupported, isExceptionErrorCodeMatching, isExceptionStateMatching, isExceptionStateStartingWith, isExpressionReferringToTableBeingUpdatedSupported, isExtraCommitRequired, isFilteredIndexSupported, isFunctionBasedIndexSupported, isMatchingName, isPosixEscapeSyntaxSupported, isReleaseSavepointSupported, isReservedSchemaName, isReservedTableName, isReservedWord, isSchemaSupported, isTemporaryName, isTransientTransactionException, isTxRequiredForFetchsize, isUUIDSupported, jdbcTypeToSqlType, normalizeDefault, optimizeSql, setArray, setDropIfExistsEnabled, sqlAddColumn, sqlAlterColumnComment, sqlAlterColumnDefault, sqlAlterColumnNullConstraint, sqlAlterColumnType, sqlAlterTableComment, sqlAsBeforeTableAlias, sqlComment, sqlCreateColumn, sqlCreateColumnComment, sqlCreateIndex, sqlCreateSchema, sqlCreateTableAttributeWithoutComment, sqlCreateTableClosing, sqlCreateTableComment, sqlCreateTableIntro, sqlCreateTableIntroWithoutComment, sqlDropColumn, sqlDropIndex, sqlDropTable, sqlFunction, sqlJoin, sqlJoinSelects, sqlJoinSelects, sqlRenameAndAlterColumnType, sqlRenameColumn, sqlRenameIndex, sqlRenameTable, sqlTypeToString, sqlUpdateToNotNull, toInternalType, toQuotedString, toString, validateVersion, valueToLiteral

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.tentackle.sql.Backend

getBackendId, getDriverClassName, getName, isMatchingUrl

Field Details

SQL_WINDOW_1

public static final String SQL_WINDOW_1

window function part 1.

See Also:

• Constant Field Values

SQL_WINDOW_2

public static final String SQL_WINDOW_2

window function part 2.

See Also:

• Constant Field Values

SQL_WINDOW_LIMIT

public static final String SQL_WINDOW_LIMIT

condition for limit and offset.

See Also:

• Constant Field Values

SQL_WINDOW_OFFSET

public static final String SQL_WINDOW_OFFSET

condition for limit and offset.

See Also:

• Constant Field Values

RESERVED_WORDS_SQL2003

public static final String[] RESERVED_WORDS_SQL2003

array of additional reserved words.

Constructor Details

AbstractSql2003Backend

public AbstractSql2003Backend()

Parent constructor.

Method Details

getReservedWords

public Set<String> getReservedWords()

Description copied from interface: Backend

Gets the list of reserved words for this backend.

Specified by:

getReservedWords in interface Backend

Overrides:

getReservedWords in class AbstractSql92Backend

Returns:

the set of reserved words

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 [SELECT] FROM... WHERE... ORDER BY....
It is decorated with a leading SELECT, if missing, plus optional clauses like for the given parameters.

Specified by:

buildSelectSql in interface Backend

Overrides:

buildSelectSql in class AbstractSql92Backend

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

setLeadingSelectParameters

public int setLeadingSelectParameters(BackendPreparedStatement stmt,
 int limit,
 int offset)

Description copied from interface: Backend

Sets optional parameters before applying the original parameters.

Specified by:

setLeadingSelectParameters in interface Backend

Overrides:

setLeadingSelectParameters in class AbstractSql92Backend

Parameters:

stmt - the prepared statement

limit - the limit value, ≤ 0 if no limit clause

offset - the offset value, ≤ 0 if no offset clause

Returns:

the next parameter index

setTrailingSelectParameters

public int setTrailingSelectParameters(BackendPreparedStatement stmt,
 int index,
 int limit,
 int offset)

Description copied from interface: Backend

Sets optional parameters after applying the original parameters.

Specified by:

setTrailingSelectParameters in interface Backend

Overrides:

setTrailingSelectParameters in class AbstractSql92Backend

Parameters:

stmt - the prepared statement

index - the first parameter index

limit - the limit value, ≤ 0 if no limit clause

offset - the offset value, ≤ 0 if no offset clause

Returns:

the next parameter index

isSequenceSupported

public boolean isSequenceSupported()

Description copied from interface: Backend

True if backend provides locking-free sequences.
Sequences must not take part in transactions, i.e. no read- or write-locks!

Specified by:

isSequenceSupported in interface Backend

Overrides:

isSequenceSupported in class AbstractSql92Backend

Returns:

true if database supports sequences

sqlCreateSequence

public String sqlCreateSequence(String name,
 Long start,
 Long increment)

Description copied from interface: Backend

Creates the SQL string to create a sequence.

Specified by:

sqlCreateSequence in interface Backend

Overrides:

sqlCreateSequence in class AbstractSql92Backend

Parameters:

name - the sequence name

start - the optional start value, defaults to 1

increment - the optional increment, defaults to 1

Returns:

the SQL code

sqlNextFromSequence

public String sqlNextFromSequence(String name)

Description copied from interface: Backend

Creates the SQL string to retrieve the next id from a sequence.

Specified by:

sqlNextFromSequence in interface Backend

Overrides:

sqlNextFromSequence in class AbstractSql92Backend

Parameters:

name - the name of the sequence

Returns:

the SQL code