org.datanucleus.store.rdbms.adapter
Class MSSQLServerAdapter

java.lang.Object
  org.datanucleus.store.rdbms.adapter.DatabaseAdapter
      org.datanucleus.store.rdbms.adapter.MSSQLServerAdapter

All Implemented Interfaces:

org.datanucleus.store.mapped.DatastoreAdapter, RDBMSAdapter

public class MSSQLServerAdapter
extends DatabaseAdapter

Provides methods for adapting SQL language elements to the Microsoft SQL Server database.

See Also:

DatabaseAdapter

Field Summary

Fields inherited from class org.datanucleus.store.rdbms.adapter.DatabaseAdapter

catalogSeparator, datastoreMajorVersion, datastoreMinorVersion, datastoreProductName, datastoreProductVersion, datastoreRevisionVersion, driverMajorVersion, driverMinorVersion, driverName, driverVersion, identifierQuoteString, LOCALISER, LOCALISER_BASE, maxColumnNameLength, maxConstraintNameLength, maxIndexNameLength, maxTableNameLength, properties, reservedKeywords, supportedOptions

Fields inherited from interface org.datanucleus.store.rdbms.adapter.RDBMSAdapter

ACCESS_PARENTQUERY_IN_SUBQUERY_JOINED, ALTER_TABLE_DROP_CONSTRAINT_SYNTAX, ALTER_TABLE_DROP_FOREIGN_KEY_CONSTRAINT, ANSI_CROSSJOIN_SYNTAX, ANSI_JOIN_SYNTAX, AUTO_INCREMENT_COLUMN_TYPE_SPECIFICATION, AUTO_INCREMENT_KEYS_NULL_SPECIFICATION, AUTO_INCREMENT_PK_IN_CREATE_TABLE_COLUMN_DEF, BLOB_SET_USING_SETSTRING, CHAR_COLUMNS_PADDED_WITH_SPACES, CHECK_IN_CREATE_STATEMENTS, CHECK_IN_END_CREATE_STATEMENTS, CLOB_SET_USING_SETSTRING, CREATE_INDEXES_BEFORE_FOREIGN_KEYS, CROSSJOIN_ASINNER11_SYNTAX, DATETIME_STORES_MILLISECS, DEFAULT_BEFORE_NULL_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_IN_COLUMN_OPTIONS, DEFAULT_KEYWORD_WITH_NOT_NULL_IN_COLUMN_OPTIONS, DEFERRED_CONSTRAINTS, DISTINCT_WITH_SELECT_FOR_UPDATE, EXISTS_SYNTAX, FK_DELETE_ACTION_CASCADE, FK_DELETE_ACTION_DEFAULT, FK_DELETE_ACTION_NULL, FK_DELETE_ACTION_RESTRICT, FK_IN_END_CREATE_STATEMENTS, FK_UPDATE_ACTION_CASCADE, FK_UPDATE_ACTION_DEFAULT, FK_UPDATE_ACTION_NULL, FK_UPDATE_ACTION_RESTRICT, GET_GENERATED_KEYS_STATEMENT, INCLUDE_ORDERBY_COLS_IN_SELECT, LOCK_OPTION_PLACED_AFTER_FROM, LOCK_OPTION_PLACED_WITHIN_JOIN, LOCK_WITH_SELECT_FOR_UPDATE, NULL_EQUALS_EMPTY_STRING, NULLS_IN_CANDIDATE_KEYS, NULLS_KEYWORD_IN_COLUMN_OPTIONS, ORDERBY_USING_SELECT_COLUMN_INDEX, PERSIST_OF_UNASSIGNED_CHAR, PRIMARYKEY_IN_CREATE_STATEMENTS, STATEMENT_BATCHING, STORED_PROCEDURES, TX_ISOLATION_NONE, TX_ISOLATION_READ_COMMITTED, TX_ISOLATION_READ_UNCOMMITTED, TX_ISOLATION_REPEATABLE_READ, TX_ISOLATION_SERIALIZABLE, UNION_SYNTAX, UNIQUE_IN_END_CREATE_STATEMENTS, UPDATE_MULTITABLE, USE_UNION_ALL, VIEWS

Fields inherited from interface org.datanucleus.store.mapped.DatastoreAdapter

ANALYSIS_METHODS, BIT_IS_REALLY_BOOLEAN, BOOLEAN_COMPARISON, CATALOGS_IN_TABLE_DEFINITIONS, ESCAPE_EXPRESSION_IN_LIKE_PREDICATE, IDENTIFIERS_LOWERCASE, IDENTIFIERS_LOWERCASE_QUOTED, IDENTIFIERS_MIXEDCASE, IDENTIFIERS_MIXEDCASE_QUOTED, IDENTIFIERS_MIXEDCASE_QUOTED_SENSITIVE, IDENTIFIERS_MIXEDCASE_SENSITIVE, IDENTIFIERS_UPPERCASE, IDENTIFIERS_UPPERCASE_QUOTED, IDENTITY_COLUMNS, PROJECTION_IN_TABLE_REFERENCE_JOINS, SCHEMAS_IN_TABLE_DEFINITIONS, SEQUENCES

Constructor Summary

MSSQLServerAdapter(DatabaseMetaData metadata)
Constructs a Microsoft SQL Server adapter based on the given JDBC metadata.

Method Summary

String	getAutoIncrementKeyword() Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).
String	getAutoIncrementStmt(Table table, String columnName) Accessor for the auto-increment sql statement for this datastore.
String	getCatalogName(Connection conn) Accessor for the catalog name.
String	getCreateIndexStatement(Index idx, org.datanucleus.store.mapped.IdentifierFactory factory) Returns the appropriate DDL to create an index.
String	getDropTableStatement(org.datanucleus.store.mapped.DatastoreContainerObject table) Returns the appropriate SQL to drop the given table.
String	getInsertStatementForNoColumns(Table table) Method to return the INSERT statement to use when inserting into a table that has no columns specified.
String	getNewUUIDFunction() The function to creates a unique value of type uniqueidentifier.
String	getOperatorConcat() An operator in a string expression that concatenates two or more character or binary strings, columns, or a combination of strings and column names into one expression (a string operator).
String	getSchemaName(Connection conn) Accessor for the Schema Name for this datastore.
String	getSelectNewUUIDStmt() The function to creates a unique value of type uniqueidentifier.
String	getSelectWithLockOption() The option to specify in "SELECT ...
String	getVendorID()
void	initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler, org.datanucleus.store.connection.ManagedConnection mconn) Initialise the types for this datastore.
boolean	isIdentityFieldDataType(String columnDef) Verifies if the given columnDef is auto incremented by the datastore.
boolean	isReservedKeyword(String word) Tests if a given string is a SQL keyword.
boolean	isStatementTimeout(SQLException sqle) return whether this exception represents a timed out statement.
RDBMSColumnInfo	newRDBMSColumnInfo(ResultSet rs) Method to create a column info for the current row.
SQLTypeInfo	newSQLTypeInfo(ResultSet rs) Create a new SQL type info from the current row of the passed ResultSet.
boolean	supportsQueryFetchSize(int size) Whether the datastore will support setting the query fetch size to the supplied value.
boolean	validToSelectMappingInStatement(SQLStatement stmt, org.datanucleus.store.mapped.mapping.JavaTypeMapping m) Method to return if it is valid to select the specified mapping for the specified statement for this datastore adapter.

Methods inherited from class org.datanucleus.store.rdbms.adapter.DatabaseAdapter

addSQLTypeForJDBCType, getAdapterTime, getAddCandidateKeyStatement, getAddColumnStatement, getAddForeignKeyStatement, getAddPrimaryKeyStatement, getCatalogSeparator, getCheckConstraintForValues, getColumns, getContinuationString, getCreateTableStatement, getDatastoreDateStatement, getDatastoreDriverName, getDatastoreDriverVersion, getDatastoreIdentifierMaxLength, getDatastoreProductName, getDatastoreProductVersion, getDeleteTableStatement, getDriverMajorVersion, getDriverMinorVersion, getDropViewStatement, getEscapeCharacter, getEscapePatternExpression, getExistingIndexes, getIdentifierQuoteString, getMappingManager, getMaxForeignKeys, getMaxIndexes, getMiliseconds, getNumericConversionFunction, getOrderString, getPatternExpressionAnyCharacter, getPatternExpressionZeroMoreCharacters, getRangeByLimitEndOfStatementClause, getRangeByRowNumberColumn, getRangeByRowNumberColumn2, getRequiredTransactionIsolationLevel, getSelectForUpdateText, getSequenceCreateStmt, getSequenceNextStmt, getSQLTypeInfoForJdbcType, getSupportedOptions, getSurrogateForEmptyStrings, getTime, getTransactionIsolationForSchemaCreation, getUnlimitedLengthPrecisionValue, getValueForProperty, initialiseDatastore, isKeyword, isStatementCancel, isValidPrimaryKeyType, iteratorReservedWords, newFKInfo, parseKeywordList, removeUnsupportedMappings, setProperties, supportsOption, supportsTransactionIsolation, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MSSQLServerAdapter

public MSSQLServerAdapter(DatabaseMetaData metadata)

Constructs a Microsoft SQL Server adapter based on the given JDBC metadata.

Parameters:

metadata - the database metadata.

Method Detail

initialiseTypes

public void initialiseTypes(org.datanucleus.store.schema.StoreSchemaHandler handler,
                            org.datanucleus.store.connection.ManagedConnection mconn)

Initialise the types for this datastore.

Specified by:

initialiseTypes in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

initialiseTypes in class DatabaseAdapter

Parameters:

handler - SchemaHandler that we initialise the types for

mconn - Managed connection to use

getVendorID

public String getVendorID()

Specified by:

getVendorID in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

getVendorID in class DatabaseAdapter

getCatalogName

public String getCatalogName(Connection conn)
                      throws SQLException

Accessor for the catalog name.

Specified by:

getCatalogName in interface RDBMSAdapter

Overrides:

getCatalogName in class DatabaseAdapter

Parameters:

conn - The Connection to use

Returns:

The catalog name used by this connection

Throws:

SQLException

getSchemaName

public String getSchemaName(Connection conn)
                     throws SQLException

Description copied from class: DatabaseAdapter

Accessor for the Schema Name for this datastore.

Specified by:

getSchemaName in interface RDBMSAdapter

Overrides:

getSchemaName in class DatabaseAdapter

Parameters:

conn - Connection to the datastore

Returns:

The schema name

Throws:

SQLException - Thrown if error occurs in determining the schema name.

isReservedKeyword

public boolean isReservedKeyword(String word)

Description copied from class: DatabaseAdapter

Tests if a given string is a SQL keyword.

The list of key words tested against is defined to contain all SQL/92 keywords, plus any additional key words reported by the JDBC driver for this adapter via DatabaseMetaData.getSQLKeywords().

In general, use of a SQL key word as an identifier should be avoided. SQL/92 key words are divided into reserved and non-reserved words. If a reserved word is used as an identifier it must be quoted with double quotes. Strictly speaking, the same is not true of non-reserved words. However, as C.J. Date writes in A Guide To The SQL Standard :

The rule by which it is determined within the standard that one key word needs to be reserved while another need not is not clear to this writer. In practice, it is probably wise to treat all key words as reserved.

Specified by:

isReservedKeyword in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

isReservedKeyword in class DatabaseAdapter

Parameters:

word - The word to test.

Returns:

true if word is a SQL key word for this DBMS. The comparison is case-insensitive.

See Also:

SQLConstants

getCreateIndexStatement

public String getCreateIndexStatement(Index idx,
                                      org.datanucleus.store.mapped.IdentifierFactory factory)

Returns the appropriate DDL to create an index. Overrides the superclass variant since Postgresql doesn't support having index names specified in a particular schema (i.e "{schema}.{indexName}").

Specified by:

getCreateIndexStatement in interface RDBMSAdapter

Overrides:

getCreateIndexStatement in class DatabaseAdapter

Parameters:

idx - An object describing the index.

factory - Identifier factory

Returns:

The text of the SQL statement.

getSelectNewUUIDStmt

public String getSelectNewUUIDStmt()

The function to creates a unique value of type uniqueidentifier.

Specified by:

getSelectNewUUIDStmt in interface RDBMSAdapter

Overrides:

getSelectNewUUIDStmt in class DatabaseAdapter

Returns:

The function. e.g. "SELECT NEWID()"

getNewUUIDFunction

public String getNewUUIDFunction()

The function to creates a unique value of type uniqueidentifier.

Overrides:

getNewUUIDFunction in class DatabaseAdapter

Returns:

The function. e.g. "NEWID()"

supportsQueryFetchSize

public boolean supportsQueryFetchSize(int size)

Whether the datastore will support setting the query fetch size to the supplied value.

Specified by:

supportsQueryFetchSize in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

supportsQueryFetchSize in class DatabaseAdapter

Parameters:

size - The value to set to

Returns:

Whether it is supported.

newRDBMSColumnInfo

public RDBMSColumnInfo newRDBMSColumnInfo(ResultSet rs)

Method to create a column info for the current row. Overrides the dataType/columnSize/decimalDigits to cater for MSSQL particularities.

Specified by:

newRDBMSColumnInfo in interface RDBMSAdapter

Overrides:

newRDBMSColumnInfo in class DatabaseAdapter

Parameters:

rs - ResultSet from DatabaseMetaData.getColumns()

Returns:

column info

newSQLTypeInfo

public SQLTypeInfo newSQLTypeInfo(ResultSet rs)

Description copied from interface: RDBMSAdapter

Create a new SQL type info from the current row of the passed ResultSet. Allows an adapter to override particular types where the JDBC driver is known to be buggy.

Specified by:

newSQLTypeInfo in interface RDBMSAdapter

Overrides:

newSQLTypeInfo in class DatabaseAdapter

Parameters:

rs - ResultSet

Returns:

The SQL type info

getDropTableStatement

public String getDropTableStatement(org.datanucleus.store.mapped.DatastoreContainerObject table)

Description copied from class: DatabaseAdapter

Returns the appropriate SQL to drop the given table. It should return something like:

 DROP TABLE FOO CASCADE
 

Specified by:

getDropTableStatement in interface RDBMSAdapter

Overrides:

getDropTableStatement in class DatabaseAdapter

Parameters:

table - The table to drop.

Returns:

The text of the SQL statement.

getAutoIncrementStmt

public String getAutoIncrementStmt(Table table,
                                   String columnName)

Accessor for the auto-increment sql statement for this datastore.

Specified by:

getAutoIncrementStmt in interface RDBMSAdapter

Overrides:

getAutoIncrementStmt in class DatabaseAdapter

Parameters:

table - Name of the table that the autoincrement is for

columnName - Name of the column that the autoincrement is for

Returns:

The statement for getting the latest auto-increment key

getAutoIncrementKeyword

public String getAutoIncrementKeyword()

Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).

Specified by:

getAutoIncrementKeyword in interface RDBMSAdapter

Overrides:

getAutoIncrementKeyword in class DatabaseAdapter

Returns:

The keyword for a column using auto-increment

isIdentityFieldDataType

public boolean isIdentityFieldDataType(String columnDef)

Verifies if the given columnDef is auto incremented by the datastore.

Specified by:

isIdentityFieldDataType in interface org.datanucleus.store.mapped.DatastoreAdapter

Overrides:

isIdentityFieldDataType in class DatabaseAdapter

Parameters:

columnDef - the datastore type name

Returns:

true when the columnDef has values auto incremented by the datastore

getInsertStatementForNoColumns

public String getInsertStatementForNoColumns(Table table)

Method to return the INSERT statement to use when inserting into a table that has no columns specified. This is the case when we have a single column in the table and that column is autoincrement/identity (and so is assigned automatically in the datastore).

Specified by:

getInsertStatementForNoColumns in interface RDBMSAdapter

Overrides:

getInsertStatementForNoColumns in class DatabaseAdapter

Parameters:

table - The table

Returns:

The statement for the INSERT

getOperatorConcat

public String getOperatorConcat()

An operator in a string expression that concatenates two or more character or binary strings, columns, or a combination of strings and column names into one expression (a string operator).

Overrides:

getOperatorConcat in class DatabaseAdapter

Returns:

the operator SQL String

getSelectWithLockOption

public String getSelectWithLockOption()

Description copied from class: DatabaseAdapter

The option to specify in "SELECT ... FROM TABLE ... WITH (option)" to lock instances Null if not supported.

Specified by:

getSelectWithLockOption in interface RDBMSAdapter

Overrides:

getSelectWithLockOption in class DatabaseAdapter

Returns:

The option to specify with "SELECT ... FROM TABLE ... WITH (option)"

validToSelectMappingInStatement

public boolean validToSelectMappingInStatement(SQLStatement stmt,
                                               org.datanucleus.store.mapped.mapping.JavaTypeMapping m)

Method to return if it is valid to select the specified mapping for the specified statement for this datastore adapter. Sometimes, dependent on the type of the column(s), and what other components are present in the statement, it may be invalid to select the mapping. This implementation returns true, so override in database-specific subclass as required.

Specified by:

validToSelectMappingInStatement in interface RDBMSAdapter

Overrides:

validToSelectMappingInStatement in class DatabaseAdapter

Parameters:

stmt - The statement

m - The mapping that we want to select

Returns:

Whether it is valid

isStatementTimeout

public boolean isStatementTimeout(SQLException sqle)

Description copied from class: DatabaseAdapter

return whether this exception represents a timed out statement.

Specified by:

isStatementTimeout in interface RDBMSAdapter

Overrides:

isStatementTimeout in class DatabaseAdapter

Parameters:

sqle - the exception

Returns:

whether it is a timeout