public class

SQLServerDialect

extends Dialect
java.lang.Object
   ↳ org.hibernate.dialect.Dialect
     ↳ org.hibernate.dialect.SQLServerDialect
Known Direct Subclasses

Class Overview

A dialect for Microsoft SQL Server 2000

Summary

[Expand]
Inherited Constants
From class org.hibernate.dialect.Dialect
Public Constructors
SQLServerDialect()
Public Methods
String appendIdentitySelectToInsert(String insertSQL)
Use insert table(...) values(...) select SCOPE_IDENTITY()
String appendLockHint(LockMode mode, String tableName)
Some dialects support an alternative means to SELECT FOR UPDATE, whereby a "lock hint" is appends to the table name in the from clause.
String applyLocksToSql(String sql, LockOptions aliasedLockOptions, Map keyColumnNames)
Modifies the given SQL by applying the appropriate updates for the specified lock modes and key columns.
boolean areStringComparisonsCaseInsensitive()
Are string comparisons implicitly case insensitive.
char closeQuote()
The character specific to this dialect used to close a quoted identifier.
boolean doesReadCommittedCauseWritersToBlockReaders()
For the underlying database, is READ_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?
boolean doesRepeatableReadCauseReadersToBlockWriters()
For the underlying database, is REPEATABLE_READ isolation implemented by forcing writers to wait for read locks to be released?
boolean dropTemporaryTableAfterUse()
Do we need to drop the temporary table after use?
String generateTemporaryTableName(String baseTableName)
Generate a temporary table name given the base table.
String getAddColumnString()
The syntax used to add a column to a table (optional).
String getCurrentTimestampSelectString()
Retrieve the command used to retrieve the current timestamp from the database.
String getForUpdateString()
Get the string to append to SELECT statements to acquire locks for this dialect.
String getIdentityColumnString()
The syntax used during DDL to define a column as being an IDENTITY.
String getIdentitySelectString()
Get the select command to use to retrieve the last generated IDENTITY value.
String getLimitString(String querySelect, int offset, int limit)
Given a limit and an offset, apply the limit clause to the query.
String getNoColumnsInsertString()
The fragment used to insert a row without specifying any column values.
String getNullColumnString()
The keyword used to specify a nullable column.
ResultSet getResultSet(CallableStatement ps)
Given a callable statement previously processed by registerResultSetOutParameter(CallableStatement, int), extract the ResultSet from the OUT parameter.
String getSelectGUIDString()
Get the command used to select a GUID from the underlying database.
boolean isCurrentTimestampSelectStringCallable()
Should the value returned by getCurrentTimestampSelectString() be treated as callable.
char openQuote()
The character specific to this dialect used to begin a quoted identifier.
boolean qualifyIndexName()
Do we need to qualify index names with the schema name?
int registerResultSetOutParameter(CallableStatement statement, int col)
Registers an OUT parameter which will be returning a ResultSet.
boolean supportsCircularCascadeDeleteConstraints()
Does this dialect support definition of cascade delete constraints which can cause circular chains?
boolean supportsCurrentTimestampSelection()
Does this dialect support a way to retrieve the database's current timestamp value?
boolean supportsEmptyInList()
Does this dialect support empty IN lists?

For example, is [where XYZ in ()] a supported construct?

boolean supportsExistsInSelect()
Does the dialect support an exists statement in the select clause?
boolean supportsIdentityColumns()
Does this dialect support identity column key generation?
boolean supportsInsertSelectIdentity()
Does the dialect support some form of inserting and selecting the generated IDENTITY value all in the same statement.
boolean supportsLimit()
Does this dialect support some form of limiting query results via a SQL clause?
boolean supportsLimitOffset()
Does this dialect's LIMIT support (if any) additionally support specifying an offset?
boolean supportsLobValueChangePropogation()
Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator as opposed to supplying a new locator instance...
boolean supportsResultSetPositionQueryMethodsOnForwardOnlyCursor()
Does this dialect support asking the result set its positioning information on forward only cursors.
boolean supportsTemporaryTables()
Does this dialect support temporary tables?
boolean supportsTupleDistinctCounts()
Does this dialect support `count(distinct a,b)`?
boolean supportsUnionAll()
Does this dialect support UNION ALL, which is generally a faster variant of UNION?
boolean supportsVariableLimit()
Does this dialect support bind variables (i.e., prepared statement parameters) for its limit/offset?
boolean useMaxForLimit()
Does the LIMIT clause take a "maximum" row number instead of a total number of returned rows?

This is easiest understood via an example.

[Expand]
Inherited Methods
From class org.hibernate.dialect.Dialect
From class java.lang.Object

Public Constructors

public SQLServerDialect ()

Public Methods

public String appendIdentitySelectToInsert (String insertSQL)

Use insert table(...) values(...) select SCOPE_IDENTITY()

Parameters
insertSQL The insert command
Returns
  • The insert command with any necessary identity select clause attached.

public String appendLockHint (LockMode mode, String tableName)

Some dialects support an alternative means to SELECT FOR UPDATE, whereby a "lock hint" is appends to the table name in the from clause.

contributed by Helge Schulz

Parameters
mode The lock mode to apply
tableName The name of the table to which to apply the lock hint.
Returns
  • The table with any required lock hints.

public String applyLocksToSql (String sql, LockOptions aliasedLockOptions, Map keyColumnNames)

Modifies the given SQL by applying the appropriate updates for the specified lock modes and key columns.

The behavior here is that of an ANSI SQL SELECT FOR UPDATE. This method is really intended to allow dialects which do not support SELECT FOR UPDATE to achieve this in their own fashion.

Parameters
sql the SQL string to modify
aliasedLockOptions lock options indexed by aliased table names.
keyColumnNames a map of key columns indexed by aliased table names.
Returns
  • the modified SQL string.

public boolean areStringComparisonsCaseInsensitive ()

Are string comparisons implicitly case insensitive.

In other words, does [where 'XYZ' = 'xyz'] resolve to true?

Returns
  • True if comparisons are case insensitive.

public char closeQuote ()

The character specific to this dialect used to close a quoted identifier.

Returns
  • The dialect's specific close quote character.

public boolean doesReadCommittedCauseWritersToBlockReaders ()

For the underlying database, is READ_COMMITTED isolation implemented by forcing readers to wait for write locks to be released?

Returns
  • True if writers block readers to achieve READ_COMMITTED; false otherwise.

public boolean doesRepeatableReadCauseReadersToBlockWriters ()

For the underlying database, is REPEATABLE_READ isolation implemented by forcing writers to wait for read locks to be released?

Returns
  • True if readers block writers to achieve REPEATABLE_READ; false otherwise.

public boolean dropTemporaryTableAfterUse ()

Do we need to drop the temporary table after use?

Returns
  • True if the table should be dropped.

public String generateTemporaryTableName (String baseTableName)

Generate a temporary table name given the base table.

Parameters
baseTableName The table name from which to base the temp table name.
Returns
  • The generated temp table name.

public String getAddColumnString ()

The syntax used to add a column to a table (optional).

Returns
  • The "add column" fragment.

public String getCurrentTimestampSelectString ()

Retrieve the command used to retrieve the current timestamp from the database.

Returns
  • The command.

public String getForUpdateString ()

Get the string to append to SELECT statements to acquire locks for this dialect.

Returns
  • The appropriate FOR UPDATE clause string.

public String getIdentityColumnString ()

The syntax used during DDL to define a column as being an IDENTITY.

Returns
  • The appropriate DDL fragment.

public String getIdentitySelectString ()

Get the select command to use to retrieve the last generated IDENTITY value.

Returns
  • The appropriate select command

public String getLimitString (String querySelect, int offset, int limit)

Given a limit and an offset, apply the limit clause to the query.

Parameters
querySelect The query to which to apply the limit.
offset The offset of the limit
limit The limit of the limit ;)
Returns
  • The modified query statement with the limit applied.

public String getNoColumnsInsertString ()

The fragment used to insert a row without specifying any column values. This is not possible on some databases.

Returns
  • The appropriate empty values clause.

public String getNullColumnString ()

The keyword used to specify a nullable column.

Returns
  • String

public ResultSet getResultSet (CallableStatement ps)

Given a callable statement previously processed by registerResultSetOutParameter(CallableStatement, int), extract the ResultSet from the OUT parameter.

Parameters
ps The callable statement.
Returns
  • The extracted result set.
Throws
SQLException

public String getSelectGUIDString ()

Get the command used to select a GUID from the underlying database.

Optional operation.

Returns
  • The appropriate command.

public boolean isCurrentTimestampSelectStringCallable ()

Should the value returned by getCurrentTimestampSelectString() be treated as callable. Typically this indicates that JDBC escape syntax is being used...

Returns

public char openQuote ()

The character specific to this dialect used to begin a quoted identifier.

Returns
  • The dialect's specific open quote character.

public boolean qualifyIndexName ()

Do we need to qualify index names with the schema name?

Returns
  • boolean

public int registerResultSetOutParameter (CallableStatement statement, int col)

Registers an OUT parameter which will be returning a ResultSet. How this is accomplished varies greatly from DB to DB, hence its inclusion (along with getResultSet(CallableStatement)) here.

Parameters
statement The callable statement.
col The bind position at which to register the OUT param.
Returns
  • The number of (contiguous) bind positions used.
Throws
SQLException

public boolean supportsCircularCascadeDeleteConstraints ()

Does this dialect support definition of cascade delete constraints which can cause circular chains?

Returns
  • True if circular cascade delete constraints are supported; false otherwise.

public boolean supportsCurrentTimestampSelection ()

Does this dialect support a way to retrieve the database's current timestamp value?

Returns
  • True if the current timestamp can be retrieved; false otherwise.

public boolean supportsEmptyInList ()

Does this dialect support empty IN lists?

For example, is [where XYZ in ()] a supported construct?

Returns
  • True if empty in lists are supported; false otherwise.

public boolean supportsExistsInSelect ()

Does the dialect support an exists statement in the select clause?

Returns
  • True if exists checks are allowed in the select clause; false otherwise.

public boolean supportsIdentityColumns ()

Does this dialect support identity column key generation?

Returns
  • True if IDENTITY columns are supported; false otherwise.

public boolean supportsInsertSelectIdentity ()

Does the dialect support some form of inserting and selecting the generated IDENTITY value all in the same statement.

Returns
  • True if the dialect supports selecting the just generated IDENTITY in the insert statement.

public boolean supportsLimit ()

Does this dialect support some form of limiting query results via a SQL clause?

Returns
  • True if this dialect supports some form of LIMIT.

public boolean supportsLimitOffset ()

Does this dialect's LIMIT support (if any) additionally support specifying an offset?

Returns
  • True if the dialect supports an offset within the limit support.

public boolean supportsLobValueChangePropogation ()

Does the dialect support propagating changes to LOB values back to the database? Talking about mutating the internal value of the locator as opposed to supplying a new locator instance...

For BLOBs, the internal value might be changed by: setBinaryStream(long), setBytes(long, byte[]), setBytes(long, byte[], int, int), or truncate(long).

For CLOBs, the internal value might be changed by: setAsciiStream(long), setCharacterStream(long), setString(long, String), setString(long, String, int, int), or truncate(long).

NOTE : I do not know the correct answer currently for databases which (1) are not part of the cruise control process or (2) do not supportsExpectedLobUsagePattern().

Returns
  • True if the changes are propagated back to the database; false otherwise.

public boolean supportsResultSetPositionQueryMethodsOnForwardOnlyCursor ()

Does this dialect support asking the result set its positioning information on forward only cursors. Specifically, in the case of scrolling fetches, Hibernate needs to use isAfterLast() and isBeforeFirst(). Certain drivers do not allow access to these methods for forward only cursors.

NOTE : this is highly driver dependent!

Returns

public boolean supportsTemporaryTables ()

Does this dialect support temporary tables?

Returns
  • True if temp tables are supported; false otherwise.

public boolean supportsTupleDistinctCounts ()

Does this dialect support `count(distinct a,b)`?

Returns
  • True if the database supports counting disintct tuples; false otherwise.

public boolean supportsUnionAll ()

Does this dialect support UNION ALL, which is generally a faster variant of UNION?

Returns
  • True if UNION ALL is supported; false otherwise.

public boolean supportsVariableLimit ()

Does this dialect support bind variables (i.e., prepared statement parameters) for its limit/offset?

Returns
  • True if bind variables can be used; false otherwise.

public boolean useMaxForLimit ()

Does the LIMIT clause take a "maximum" row number instead of a total number of returned rows?

This is easiest understood via an example. Consider you have a table with 20 rows, but you only want to retrieve rows number 11 through 20. Generally, a limit with offset would say that the offset = 11 and the limit = 10 (we only want 10 rows at a time); this is specifying the total number of returned rows. Some dialects require that we instead specify offset = 11 and limit = 20, where 20 is the "last" row we want relative to offset (i.e. total number of rows = 20 - 11 = 9)

So essentially, is limit relative from offset? Or is limit absolute?

Returns
  • True if limit is relative from offset; false otherwise.