Class SQLServerAdapter

java.lang.Object
org.datanucleus.store.rdbms.adapter.BaseDatastoreAdapter
org.datanucleus.store.rdbms.adapter.SQLServerAdapter
All Implemented Interfaces:
DatastoreAdapter

public class SQLServerAdapter extends BaseDatastoreAdapter
Provides methods for adapting SQL language elements to the Microsoft SQL Server database. Note that majorVersion from JDBC doesn't align to version number of SQLServer. 1995 = "6", 1998 = "7", 2000/2003 = "8", 2005 = "9", 2008 = "10", 2012 = "11", 2014 = "12", ...
See Also:
  • Field Details

    • MSSQL_RESERVED_WORDS

      private static final String MSSQL_RESERVED_WORDS
      Microsoft SQL Server 2000 uses reserved keywords for defining, manipulating, and accessing databases. Reserved keywords are part of the grammar of the Transact-SQL language used by SQL Server to parse and understand Transact-SQL statements and batches. Although it is syntactically possible to use SQL Server reserved keywords as identifiers and object names in Transact-SQL scripts, this can be done only using delimited identifiers.
      See Also:
  • Constructor Details

    • SQLServerAdapter

      public SQLServerAdapter(DatabaseMetaData metadata)
      Constructs a SQL Server adapter based on the given JDBC metadata.
      Parameters:
      metadata - the database metadata.
  • Method Details

    • 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 DatastoreAdapter
      Overrides:
      initialiseTypes in class BaseDatastoreAdapter
      Parameters:
      handler - SchemaHandler that we initialise the types for
      mconn - Managed connection to use
    • getVendorID

      public String getVendorID()
      Description copied from interface: DatastoreAdapter
      Accessor for the Vendor ID for this datastore.
      Specified by:
      getVendorID in interface DatastoreAdapter
      Overrides:
      getVendorID in class BaseDatastoreAdapter
      Returns:
      Vendor id for this datastore
    • getCatalogName

      public String getCatalogName(Connection conn) throws SQLException
      Accessor for the catalog name.
      Specified by:
      getCatalogName in interface DatastoreAdapter
      Overrides:
      getCatalogName in class BaseDatastoreAdapter
      Parameters:
      conn - The Connection to use
      Returns:
      The catalog name used by this connection
      Throws:
      SQLException - if an error occurs
    • getSchemaName

      public String getSchemaName(Connection conn) throws SQLException
      Description copied from class: BaseDatastoreAdapter
      Accessor for the Schema Name for this datastore.
      Specified by:
      getSchemaName in interface DatastoreAdapter
      Overrides:
      getSchemaName in class BaseDatastoreAdapter
      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: BaseDatastoreAdapter
      Tests if a given string is an 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 DatastoreAdapter
      Overrides:
      isReservedKeyword in class BaseDatastoreAdapter
      Parameters:
      word - The word to test.
      Returns:
      true if word is a SQL key word for this DBMS. The comparison is case-insensitive.
    • getDropDatabaseStatement

      public String getDropDatabaseStatement(String catalogName, String schemaName)
      Description copied from interface: DatastoreAdapter
      Method to return the statement necessary to drop a database with this RDBMS. Note that some RDBMS don't support this.
      Specified by:
      getDropDatabaseStatement in interface DatastoreAdapter
      Overrides:
      getDropDatabaseStatement in class BaseDatastoreAdapter
      Parameters:
      catalogName - Name of the catalog
      schemaName - Name of the schema
      Returns:
      The DDL statement
    • getCreateIndexStatement

      public String getCreateIndexStatement(Index idx, 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 DatastoreAdapter
      Overrides:
      getCreateIndexStatement in class BaseDatastoreAdapter
      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 DatastoreAdapter
      Overrides:
      getSelectNewUUIDStmt in class BaseDatastoreAdapter
      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 BaseDatastoreAdapter
      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 DatastoreAdapter
      Overrides:
      supportsQueryFetchSize in class BaseDatastoreAdapter
      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 SQLServer particularities.
      Specified by:
      newRDBMSColumnInfo in interface DatastoreAdapter
      Overrides:
      newRDBMSColumnInfo in class BaseDatastoreAdapter
      Parameters:
      rs - ResultSet from DatabaseMetaData.getColumns()
      Returns:
      column info
    • newSQLTypeInfo

      public SQLTypeInfo newSQLTypeInfo(ResultSet rs)
      Description copied from interface: DatastoreAdapter
      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 DatastoreAdapter
      Overrides:
      newSQLTypeInfo in class BaseDatastoreAdapter
      Parameters:
      rs - ResultSet
      Returns:
      The SQL type info
    • getDropTableStatement

      public String getDropTableStatement(Table table)
      Description copied from class: BaseDatastoreAdapter
      Returns the appropriate SQL to drop the given table. It should return something like:
       DROP TABLE FOO CASCADE
       
      Specified by:
      getDropTableStatement in interface DatastoreAdapter
      Overrides:
      getDropTableStatement in class BaseDatastoreAdapter
      Parameters:
      table - The table to drop.
      Returns:
      The text of the SQL statement.
    • getDeleteTableStatement

      public String getDeleteTableStatement(SQLTable tbl)
      Method to return the basic SQL for a DELETE TABLE statement. Returns the String as DELETE MYTABLE FROM MYTABLE t1.
      Specified by:
      getDeleteTableStatement in interface DatastoreAdapter
      Overrides:
      getDeleteTableStatement in class BaseDatastoreAdapter
      Parameters:
      tbl - The SQLTable to delete
      Returns:
      The delete table string
    • getUpdateTableStatement

      public SQLText getUpdateTableStatement(SQLTable tbl, SQLText setSQL)
      Method to return the SQLText for an UPDATE TABLE statement. Returns the SQLText for UPDATE T1 SET x1 = val1, x2 = val2 FROM MYTBL T1. Override if the datastore doesn't support that standard syntax.
      Specified by:
      getUpdateTableStatement in interface DatastoreAdapter
      Overrides:
      getUpdateTableStatement in class BaseDatastoreAdapter
      Parameters:
      tbl - The primary table
      setSQL - The SQLText for the SET component
      Returns:
      SQLText for the update statement
    • getIdentityLastValueStmt

      public String getIdentityLastValueStmt(Table table, String columnName)
      Accessor for the auto-increment sql statement for this datastore.
      Specified by:
      getIdentityLastValueStmt in interface DatastoreAdapter
      Overrides:
      getIdentityLastValueStmt in class BaseDatastoreAdapter
      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
    • getIdentityKeyword

      public String getIdentityKeyword(org.datanucleus.store.StoreManager storeMgr)
      Accessor for the auto-increment keyword for generating DDLs (CREATE TABLEs...).
      Specified by:
      getIdentityKeyword in interface DatastoreAdapter
      Overrides:
      getIdentityKeyword in class BaseDatastoreAdapter
      Parameters:
      storeMgr - The Store Manager
      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 DatastoreAdapter
      Overrides:
      isIdentityFieldDataType in class BaseDatastoreAdapter
      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 DatastoreAdapter
      Overrides:
      getInsertStatementForNoColumns in class BaseDatastoreAdapter
      Parameters:
      table - The table
      Returns:
      The statement for the INSERT
    • getSelectWithLockOption

      public String getSelectWithLockOption()
      Description copied from class: BaseDatastoreAdapter
      The option to specify in "SELECT ... FROM TABLE ... WITH (option)" to lock instances Returns null if not supported.
      Specified by:
      getSelectWithLockOption in interface DatastoreAdapter
      Overrides:
      getSelectWithLockOption in class BaseDatastoreAdapter
      Returns:
      The option to specify with "SELECT ... FROM TABLE ... WITH (option)"
    • validToSelectMappingInStatement

      public boolean validToSelectMappingInStatement(SelectStatement stmt, 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 DatastoreAdapter
      Overrides:
      validToSelectMappingInStatement in class BaseDatastoreAdapter
      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: BaseDatastoreAdapter
      return whether this exception represents a timed out statement.
      Specified by:
      isStatementTimeout in interface DatastoreAdapter
      Overrides:
      isStatementTimeout in class BaseDatastoreAdapter
      Parameters:
      sqle - the exception
      Returns:
      whether it is a timeout
    • getRangeByLimitEndOfStatementClause

      public String getRangeByLimitEndOfStatementClause(long offset, long count, boolean hasOrdering)
      Method to return the SQL to append to the WHERE clause of a SELECT statement to handle restriction of ranges using the OFFSET/FETCH keywords.
      Specified by:
      getRangeByLimitEndOfStatementClause in interface DatastoreAdapter
      Overrides:
      getRangeByLimitEndOfStatementClause in class BaseDatastoreAdapter
      Parameters:
      offset - The offset to return from
      count - The number of items to return
      hasOrdering - Whether there is ordering present
      Returns:
      The SQL to append to allow for ranges using OFFSET/FETCH.
    • getSequenceCreateStmt

      public String getSequenceCreateStmt(String sequenceName, Integer min, Integer max, Integer start, Integer increment, Integer cacheSize)
      Accessor for the sequence statement to create the sequence.
      Specified by:
      getSequenceCreateStmt in interface DatastoreAdapter
      Overrides:
      getSequenceCreateStmt in class BaseDatastoreAdapter
      Parameters:
      sequenceName - Name of the sequence
      min - Minimum value for the sequence
      max - Maximum value for the sequence
      start - Start value for the sequence
      increment - Increment value for the sequence
      cacheSize - Cache size for the sequence
      Returns:
      The statement for getting the next id from the sequence
    • getSequenceNextStmt

      public String getSequenceNextStmt(String sequenceName)
      Accessor for the statement for getting the next id from the sequence for this datastore.
      Specified by:
      getSequenceNextStmt in interface DatastoreAdapter
      Overrides:
      getSequenceNextStmt in class BaseDatastoreAdapter
      Parameters:
      sequenceName - Name of the sequence
      Returns:
      The statement for getting the next id for the sequence
    • getSQLOperationClass

      public Class<? extends SQLOperation> getSQLOperationClass(String operationName)
      Description copied from interface: DatastoreAdapter
      Accessor for the SQLOperation class for the specified operation (if available for this datastore).
      Specified by:
      getSQLOperationClass in interface DatastoreAdapter
      Overrides:
      getSQLOperationClass in class BaseDatastoreAdapter
      Parameters:
      operationName - operation name
      Returns:
      SQLOperation class (or null if none available)
    • getSQLMethodClass

      public Class<? extends SQLMethod> getSQLMethodClass(String className, String methodName, org.datanucleus.ClassLoaderResolver clr)
      Description copied from interface: DatastoreAdapter
      Accessor for the SQLMethod class for the query invocation of specified class + method name (if available for this datastore).
      Specified by:
      getSQLMethodClass in interface DatastoreAdapter
      Overrides:
      getSQLMethodClass in class BaseDatastoreAdapter
      Parameters:
      className - Name of the class (or null if this is a STATIC method)
      methodName - Method name
      clr - ClassLoader resolver, in case className is a subclass of a supported type
      Returns:
      The SQLMethod class (or null if not defined for this datastore).
    • loadColumnMappings

      protected void loadColumnMappings(org.datanucleus.plugin.PluginManager mgr, org.datanucleus.ClassLoaderResolver clr)
      Load all datastore mappings for this RDBMS database.
      Overrides:
      loadColumnMappings in class BaseDatastoreAdapter
      Parameters:
      mgr - the PluginManager
      clr - the ClassLoaderResolver