Package org.apache.openjpa.jdbc.sql
Class SQLServerDictionary
- java.lang.Object
-
- org.apache.openjpa.jdbc.sql.DBDictionary
-
- org.apache.openjpa.jdbc.sql.AbstractSQLServerDictionary
-
- org.apache.openjpa.jdbc.sql.SQLServerDictionary
-
- All Implemented Interfaces:
JoinSyntaxes,Configurable,IdentifierConfiguration,ConnectionDecorator,LoggingConnectionDecorator.SQLWarningHandler
public class SQLServerDictionary extends AbstractSQLServerDictionary
Dictionary for Microsoft SQL Server.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
DBDictionary.DateMillisecondBehaviors, DBDictionary.SerializedData
-
-
Field Summary
Fields Modifier and Type Field Description java.lang.BooleansendTimeAsStringSQLServer doesn't like a java.sql.Time as default.booleanuniqueIdentifierAsVarbinaryFlag whether to treat UNIQUEIDENTIFIER as VARBINARY or VARCHARstatic java.lang.StringVENDOR_JTDSstatic java.lang.StringVENDOR_MICROSOFTstatic java.lang.StringVENDOR_NETDIRECT-
Fields inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
_procs, _proxyManager, allowQueryTimeoutOnFindUpdate, allowsAliasInBulkClause, arrayTypeName, autoAssignClause, autoAssignTypeName, batchLimit, bigintTypeName, binaryTypeName, bitLengthFunction, bitTypeName, blobBufferSize, blobTypeName, booleanRepresentation, booleanTypeName, castFunction, catalogSeparator, CENTI, characterColumnSize, charTypeName, clobBufferSize, clobTypeName, closePoolSQL, concatenateDelimiter, concatenateFunction, conf, connected, CONS_NAME_AFTER, CONS_NAME_BEFORE, CONS_NAME_MID, constraintNameMode, createPrimaryKeys, crossJoinClause, currentDateFunction, currentTimeFunction, currentTimestampFunction, databaseProductName, databaseProductVersion, dateFractionDigits, datePrecision, dateTypeName, DECI, decimalTypeName, defaultSchemaName, delimitedCase, disableAlterSeqenceIncrementBy, disableSchemaFactoryColumnTypeErrors, distinctCountColumnSeparator, distinctTypeName, doubleTypeName, driverVendor, dropTableSQL, fixedSizeTypeNames, fixedSizeTypeNameSet, floatTypeName, forUpdateClause, fractionalTypeNameSet, fullResultCollectionInOrderByRelation, getStringVal, inClauseLimit, indexPhysicalForeignKeys, initializationSQL, innerJoinClause, integerTypeName, invalidColumnWordSet, isJDBC3, isJDBC4, javaObjectTypeName, javaToDbColumnNameProcessing, joinSyntax, lastGeneratedKeyQuery, leadingDelimiter, log, longVarbinaryTypeName, longVarcharTypeName, maxAutoAssignNameLength, maxColumnNameLength, maxConstraintNameLength, maxEmbeddedBlobSize, maxEmbeddedClobSize, maxIndexesPerTable, maxIndexNameLength, maxTableNameLength, MICRO, MILLI, NAME_ANY, NAME_SEQUENCE, NAME_TABLE, nameConcatenator, NANO, nativeSequenceType, nextSequenceQuery, NO_BATCH, nullTypeName, numericTypeName, otherTypeName, outerJoinClause, platform, RANGE_POST_DISTINCT, RANGE_POST_LOCK, RANGE_POST_SELECT, RANGE_PRE_DISTINCT, rangePosition, realTypeName, refTypeName, reportsSuccessNoInfoOnBatchUpdates, requiresAliasForSubselect, requiresAutoCommitForMetaData, requiresCastForComparisons, requiresCastForMathFunctions, requiresConditionForCrossJoin, requiresSearchStringEscapeForLike, requiresTargetForDelete, reservedWords, reservedWordSet, roundTimeToMillisec, SCHEMA_CASE_LOWER, SCHEMA_CASE_PRESERVE, SCHEMA_CASE_UPPER, searchStringEscape, SEC, selectWords, selectWordSet, sequenceNameSQL, sequenceSchemaSQL, sequenceSQL, setStringRightTruncationOn, simulateLocking, smallintTypeName, sqlStateCodes, storageLimitationsFatal, storeCharsAsNumbers, storeLargeNumbersAsStrings, stringLengthFunction, structTypeName, substringFunctionName, supportsAlterTableWithAddColumn, supportsAlterTableWithDropColumn, supportsAutoAssign, supportsCascadeDeleteAction, supportsCascadeUpdateAction, supportsCaseConversionForLob, supportsComments, supportsCorrelatedSubselect, supportsDefaultDeleteAction, supportsDefaultUpdateAction, supportsDeferredConstraints, supportsDelimitedIdentifiers, supportsForeignKeys, supportsForeignKeysComposite, supportsGeneralCaseExpression, supportsGetGeneratedKeys, supportsHaving, supportsLockingWithDistinctClause, supportsLockingWithInnerJoin, supportsLockingWithMultipleTables, supportsLockingWithOrderClause, supportsLockingWithOuterJoin, supportsLockingWithSelectRange, supportsModOperator, supportsMultipleNontransactionalResultSets, supportsNullDeleteAction, supportsNullTableForGetColumns, supportsNullTableForGetImportedKeys, supportsNullTableForGetIndexInfo, supportsNullTableForGetPrimaryKeys, supportsNullUniqueColumn, supportsNullUpdateAction, supportsParameterInSelect, supportsQueryTimeout, supportsRestrictDeleteAction, supportsRestrictUpdateAction, supportsSchemaForGetColumns, supportsSchemaForGetTables, supportsSelectEndIndex, supportsSelectForUpdate, supportsSelectFromFinalTable, supportsSelectStartIndex, supportsSimpleCaseExpression, supportsSubselect, supportsUniqueConstraints, supportsXMLColumn, systemSchemas, systemSchemaSet, systemTables, systemTableSet, tableForUpdateClause, tableLengthIncludesSchema, tableTypes, timestampTypeName, timestampWithZoneTypeName, timeTypeName, timeWithZoneTypeName, tinyintTypeName, toLowerCaseFunction, toUpperCaseFunction, trailingDelimiter, trimBothFunction, trimLeadingFunction, trimSchemaName, trimStringColumns, trimTrailingFunction, typeModifierSet, UNLIMITED, useGetBestRowIdentifierForPrimaryKeys, useGetBytesForBlobs, useGetObjectForBlobs, useGetStringForClobs, useJDBC4SetBinaryStream, useNativeSequenceCache, useSchemaName, useSetBytesForBlobs, useSetStringForClobs, useWildCardForCount, validationSQL, varbinaryTypeName, varcharTypeName, VENDOR_DATADIRECT, VENDOR_OTHER, xmlTypeEncoding, xmlTypeName
-
Fields inherited from interface org.apache.openjpa.jdbc.sql.JoinSyntaxes
SYNTAX_DATABASE, SYNTAX_SQL92, SYNTAX_TRADITIONAL
-
-
Constructor Summary
Constructors Constructor Description SQLServerDictionary()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidappendLength(SQLBuffer buf, int type)protected voidappendSelectRange(SQLBuffer buf, long start, long end, boolean subselect)If this dictionary can select ranges, use this method to append the range SQL.voidappendXmlComparison(SQLBuffer buf, java.lang.String op, FilterValue lhs, FilterValue rhs, boolean lhsxml, boolean rhsxml)If this dictionary supports XML type, use this method to append xml predicate.voidconnectedConfiguration(java.sql.Connection conn)This method is called when the dictionary first sees any connection.java.io.ReadergetCharacterStream(java.sql.ResultSet rs, int column)Obtain aReaderby usingResultSet.getClob(int)andClob.getCharacterStream().Column[]getColumns(java.sql.DatabaseMetaData meta, java.lang.String catalog, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection conn)Reflect on the schema to find columns matching the given table and column patterns.Column[]getColumns(java.sql.DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, DBIdentifier columnName, java.sql.Connection conn)Reflect on the schema to find columns matching the given table and column patterns.java.io.InputStreamgetLOBStream(JDBCStore store, java.sql.ResultSet rs, int column)Obtain anInputStreamby usingResultSet.getBlob(int)andBlob.getBinaryStream().java.time.LocalDategetLocalDate(java.sql.ResultSet rs, int column)Retrieve the specified column of the SQL ResultSet to the properLocalDatejava type.java.time.LocalDateTimegetLocalDateTime(java.sql.ResultSet rs, int column)Retrieve the specified column of the SQL ResultSet to the properLocalDateTimejava type.java.time.LocalTimegetLocalTime(java.sql.ResultSet rs, int column)Retrieve the specified column of the SQL ResultSet to the properLocalTimejava type.java.time.OffsetDateTimegetOffsetDateTime(java.sql.ResultSet rs, int column)h2 does intentionally not supportgetTimestamp()for 'TIME WITH TIME ZONE' columns.java.lang.StringgetSchemaCase()Return DB specific schemaCasevoidindexOf(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start)Invoke this database's indexOf function.booleanisFatalException(int subtype, java.sql.SQLException ex)Determine if the given SQL Exception is fatal or recoverable (such as a timeout).voidsetLocalDateTime(java.sql.PreparedStatement stmnt, int idx, java.time.LocalDateTime val, Column col)Set the given LocalTime value as a parameter to the statement.voidsetLocalTime(java.sql.PreparedStatement stmnt, int idx, java.time.LocalTime val, Column col)Set the given LocalTime value as a parameter to the statement.voidsetOffsetDateTime(java.sql.PreparedStatement stmnt, int idx, java.time.OffsetDateTime val, Column col)Set the given LocalTime value as a parameter to the statement.voidsetSupportsXMLColumn(boolean b)voidsetTime(java.sql.PreparedStatement stmnt, int idx, java.sql.Time val, java.util.Calendar cal, Column col)Set the given value as a parameter to the statement.-
Methods inherited from class org.apache.openjpa.jdbc.sql.AbstractSQLServerDictionary
getFullName, setNull, substring
-
Methods inherited from class org.apache.openjpa.jdbc.sql.DBDictionary
addCastAsType, addErrorCode, appendCast, appendNumericCast, appendSelect, appendSize, appendUpdates, applyRange, assertSupport, calculateValue, canOuterJoin, closeDataSource, combineForeignKey, comment, comparison, configureNamingRules, convertSchemaCase, convertSchemaCase, copy, copy, createIndexIfNecessary, createIndexIfNecessary, decorate, deleteStream, delimitAll, endConfiguration, executeQuery, fromDBName, getAddColumnSQL, getAddForeignKeySQL, getAddPrimaryKeySQL, getAlterSequenceSQL, getArray, getAsciiStream, getBatchFetchSize, getBatchLimit, getBatchUpdateCount, getBigDecimal, getBigInteger, getBinaryStream, getBlob, getBlobObject, getBoolean, getBooleanRepresentation, getByte, getBytes, getCalendar, getCastFunction, getCastFunction, getCatalogNameForMetadata, getCatalogNameForMetadata, getChar, getClob, getClobString, getColumnDBName, getColumnIdentifier, getColumnNameForMetadata, getColumnNameForMetadata, getConversionKey, getCreateIndexSQL, getCreateSequenceSQL, getCreateTableSQL, getCreateTableSQL, getDate, getDate, getDateFractionDigits, getDeclareColumnSQL, getDefaultIdentifierRule, getDefaultSchemaName, getDeleteTableContentsSQL, getDeleteTargets, getDelimitedCase, getDelimitIdentifiers, getDouble, getDropColumnSQL, getDropForeignKeySQL, getDropIndexSQL, getDropPrimaryKeySQL, getDropSequenceSQL, getDropTableSQL, getFloat, getForeignKeyConstraintSQL, getForUpdateClause, getFrom, getFromSelect, getFullIdentifier, getFullName, getFullName, getGeneratedKey, getGeneratedKeySequenceName, getGenKeySeqName, getIdentifierConcatenator, getIdentifierDelimiter, getIdentifierRule, getIdentifierRules, getIdentityColumnName, getImportedKeys, getImportedKeys, getImportedKeys, getImportedKeys, getIndexInfo, getIndexInfo, getInt, getInvalidColumnWordSet, getIsNotNullSQL, getIsNullSQL, getJDBCType, getJDBCType, getJDBCType, getKey, getLeadingDelimiter, getLocale, getLog, getLong, getMajorVersion, getMarkerForInsertUpdate, getMillisecondBehavior, getMinorVersion, getNamingUtil, getNumber, getObject, getOffsetTime, getPlaceholderValueString, getPreferredType, getPrimaryKeyConstraintSQL, getPrimaryKeys, getPrimaryKeys, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromBestRowIdentifier, getPrimaryKeysFromGetPrimaryKeys, getPrimaryKeysFromGetPrimaryKeys, getRef, getSchemaNameForMetadata, getSchemaNameForMetadata, getSelectOperation, getSelects, getSelectTableAliases, getSequence, getSequences, getSequences, getSequencesSQL, getSequencesSQL, getShort, getStoredProcedure, getString, getSupportsDelimitedIdentifiers, getSupportsXMLColumn, getTableNameForMetadata, getTableNameForMetadata, getTables, getTables, getTime, getTimestamp, getTrailingDelimiter, getTrimSchemaName, getTypeName, getTypeName, getUniqueConstraintSQL, getValidColumnName, getValidColumnName, getValidColumnName, getValidColumnName, getValidForeignKeyName, getValidForeignKeyName, getValidIndexName, getValidIndexName, getValidPrimaryKeyName, getValidSequenceName, getValidSequenceName, getValidTableName, getValidTableName, getValidUniqueName, getValidUniqueName, getVersionColumn, getVersionColumn, getWhere, getXMLTypeEncoding, handleWarning, insertBlobForStreamingLoad, insertClobForStreamingLoad, insertSize, isImplicitJoin, isSelect, isSystemIndex, isSystemIndex, isSystemSequence, isSystemSequence, isSystemSequence, isSystemTable, isSystemTable, isUsingLimit, isUsingOffset, isUsingOrderBy, isUsingRange, makeNameValid, makeNameValid, makeNameValid, makeNameValid, matchErrorState, mathFunction, needsToCreateIndex, needsToCreateIndex, newColumn, newForeignKey, newIndex, newPrimaryKey, newSequence, newStoreException, newTable, prepareStatement, processDBColumnName, putBytes, putChars, putString, refSchemaComponents, serialize, setArray, setAsciiStream, setBatchLimit, setBigDecimal, setBigInteger, setBinaryStream, setBlob, setBlobObject, setBoolean, setBooleanRepresentation, setByte, setBytes, setCalendar, setChar, setCharacterStream, setClob, setClobString, setConfiguration, setDate, setDate, setDateMillisecondBehavior, setDefaultSchemaName, setDelimitedCase, setDelimitIdentifiers, setDouble, setFloat, setInt, setJoinSyntax, setLeadingDelimiter, setLocalDate, setLocale, setLong, setMajorVersion, setMinorVersion, setNumber, setObject, setOffsetTime, setQueryTimeout, setRef, setShort, setStatementQueryTimeout, setString, setSupportsDelimitedIdentifiers, setTimeouts, setTimeouts, setTimestamp, setTrailingDelimiter, setTrimSchemaName, setTyped, setUnknown, setUnknown, setXMLTypeEncoding, shorten, startConfiguration, storageWarning, supportsDeferredForeignKeyConstraints, supportsDeferredUniqueConstraints, supportsDeleteAction, supportsIsolationForUpdate, supportsLocking, supportsRandomAccessResultSet, supportsUpdateAction, toBulkOperation, toDBName, toDBName, toDelete, toNativeJoin, toOperation, toOperation, toSelect, toSelect, toSelect, toSelect, toSelect, toSelectCount, toSnakeCase, toSQL92Join, toTraditionalJoin, toUpdate, updateBlob, updateClob, validateBatchProcess, validateDBSpecificBatchProcess, versionEqualOrEarlierThan, versionEqualOrLaterThan, versionLaterThan
-
-
-
-
Field Detail
-
VENDOR_MICROSOFT
public static final java.lang.String VENDOR_MICROSOFT
- See Also:
- Constant Field Values
-
VENDOR_NETDIRECT
public static final java.lang.String VENDOR_NETDIRECT
- See Also:
- Constant Field Values
-
VENDOR_JTDS
public static final java.lang.String VENDOR_JTDS
- See Also:
- Constant Field Values
-
uniqueIdentifierAsVarbinary
public boolean uniqueIdentifierAsVarbinary
Flag whether to treat UNIQUEIDENTIFIER as VARBINARY or VARCHAR
-
sendTimeAsString
public java.lang.Boolean sendTimeAsString
SQLServer doesn't like a java.sql.Time as default. So either we send it as String or people configure sendTimeAsDatetime=false on the Connection. This is depending how the Database actually is setup. To mitigate misconfiguration we can work around by sending the time as String to the JDBC driver.
-
-
Method Detail
-
connectedConfiguration
public void connectedConfiguration(java.sql.Connection conn) throws java.sql.SQLExceptionDescription copied from class:DBDictionaryThis method is called when the dictionary first sees any connection. It is used to initialize dictionary metadata if needed. If you override this method, be sure to callsuper.connectedConfiguration.- Overrides:
connectedConfigurationin classDBDictionary- Throws:
java.sql.SQLException
-
getColumns
public Column[] getColumns(java.sql.DatabaseMetaData meta, java.lang.String catalog, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, java.sql.Connection conn) throws java.sql.SQLException
Description copied from class:DBDictionaryReflect on the schema to find columns matching the given table and column patterns.- Overrides:
getColumnsin classAbstractSQLServerDictionary- Throws:
java.sql.SQLException
-
getColumns
public Column[] getColumns(java.sql.DatabaseMetaData meta, DBIdentifier catalog, DBIdentifier schemaName, DBIdentifier tableName, DBIdentifier columnName, java.sql.Connection conn) throws java.sql.SQLException
Description copied from class:DBDictionaryReflect on the schema to find columns matching the given table and column patterns.- Overrides:
getColumnsin classDBDictionary- Throws:
java.sql.SQLException
-
appendLength
protected void appendLength(SQLBuffer buf, int type)
- Overrides:
appendLengthin classDBDictionary
-
appendXmlComparison
public void appendXmlComparison(SQLBuffer buf, java.lang.String op, FilterValue lhs, FilterValue rhs, boolean lhsxml, boolean rhsxml)
If this dictionary supports XML type, use this method to append xml predicate.- Overrides:
appendXmlComparisonin classDBDictionary- Parameters:
buf- the SQL buffer to write the comparisonop- the comparison operation to performlhs- the left hand side of the comparisonrhs- the right hand side of the comparisonlhsxml- indicates whether the left operand maps to xmlrhsxml- indicates whether the right operand maps to xml
-
getSchemaCase
public java.lang.String getSchemaCase()
Return DB specific schemaCase- Specified by:
getSchemaCasein interfaceIdentifierConfiguration- Overrides:
getSchemaCasein classDBDictionary- Returns:
- upper, lower, or preserve
-
setSupportsXMLColumn
public void setSupportsXMLColumn(boolean b)
- Overrides:
setSupportsXMLColumnin classDBDictionary- Parameters:
b- boolean representing if XML columns are supported
-
isFatalException
public boolean isFatalException(int subtype, java.sql.SQLException ex)Description copied from class:DBDictionaryDetermine if the given SQL Exception is fatal or recoverable (such as a timeout). This implementation always returns true (i.e. all exceptions are fatal). The current dictionary implementation can overwrite this method to mark certain exception conditions as recoverable error.- Overrides:
isFatalExceptionin classDBDictionary- Parameters:
subtype- A constant indicating the category of error as defined inStoreException.ex- original SQL Exception as raised by the database driver.- Returns:
- false if the error is fatal.
-
getLOBStream
public java.io.InputStream getLOBStream(JDBCStore store, java.sql.ResultSet rs, int column) throws java.sql.SQLException
Obtain anInputStreamby usingResultSet.getBlob(int)andBlob.getBinaryStream(). Unfortunately this will load entire BLOB into memory. The alternativeResultSet.getBinaryStream(int)provides true streaming but the stream can be consumed only as long asResultSetis open.- Overrides:
getLOBStreamin classDBDictionary- Throws:
java.sql.SQLException
-
getCharacterStream
public java.io.Reader getCharacterStream(java.sql.ResultSet rs, int column) throws java.sql.SQLExceptionObtain aReaderby usingResultSet.getClob(int)andClob.getCharacterStream(). Unfortunately this will load entire CLOB into memory. The alternativeResultSet.getCharacterStream(int)provides true streaming but the stream can be consumed only as long asResultSetis open.- Overrides:
getCharacterStreamin classDBDictionary- Throws:
java.sql.SQLException
-
getLocalDate
public java.time.LocalDate getLocalDate(java.sql.ResultSet rs, int column) throws java.sql.SQLExceptionDescription copied from class:DBDictionaryRetrieve the specified column of the SQL ResultSet to the properLocalDatejava type.- Overrides:
getLocalDatein classDBDictionary- Throws:
java.sql.SQLException
-
setLocalTime
public void setLocalTime(java.sql.PreparedStatement stmnt, int idx, java.time.LocalTime val, Column col) throws java.sql.SQLExceptionDescription copied from class:DBDictionarySet the given LocalTime value as a parameter to the statement.- Overrides:
setLocalTimein classDBDictionary- Throws:
java.sql.SQLException
-
getLocalTime
public java.time.LocalTime getLocalTime(java.sql.ResultSet rs, int column) throws java.sql.SQLExceptionDescription copied from class:DBDictionaryRetrieve the specified column of the SQL ResultSet to the properLocalTimejava type.- Overrides:
getLocalTimein classDBDictionary- Throws:
java.sql.SQLException
-
setLocalDateTime
public void setLocalDateTime(java.sql.PreparedStatement stmnt, int idx, java.time.LocalDateTime val, Column col) throws java.sql.SQLExceptionDescription copied from class:DBDictionarySet the given LocalTime value as a parameter to the statement.- Overrides:
setLocalDateTimein classDBDictionary- Throws:
java.sql.SQLException
-
getLocalDateTime
public java.time.LocalDateTime getLocalDateTime(java.sql.ResultSet rs, int column) throws java.sql.SQLExceptionDescription copied from class:DBDictionaryRetrieve the specified column of the SQL ResultSet to the properLocalDateTimejava type.- Overrides:
getLocalDateTimein classDBDictionary- Throws:
java.sql.SQLException
-
setOffsetDateTime
public void setOffsetDateTime(java.sql.PreparedStatement stmnt, int idx, java.time.OffsetDateTime val, Column col) throws java.sql.SQLExceptionDescription copied from class:DBDictionarySet the given LocalTime value as a parameter to the statement.- Overrides:
setOffsetDateTimein classDBDictionary- Throws:
java.sql.SQLException
-
getOffsetDateTime
public java.time.OffsetDateTime getOffsetDateTime(java.sql.ResultSet rs, int column) throws java.sql.SQLExceptionh2 does intentionally not supportgetTimestamp()for 'TIME WITH TIME ZONE' columns. See h2 ticket #413.- Overrides:
getOffsetDateTimein classDBDictionary- Throws:
java.sql.SQLException
-
setTime
public void setTime(java.sql.PreparedStatement stmnt, int idx, java.sql.Time val, java.util.Calendar cal, Column col) throws java.sql.SQLExceptionDescription copied from class:DBDictionarySet the given value as a parameter to the statement.- Overrides:
setTimein classDBDictionary- Throws:
java.sql.SQLException
-
indexOf
public void indexOf(SQLBuffer buf, FilterValue str, FilterValue find, FilterValue start)
Description copied from class:DBDictionaryInvoke this database's indexOf function.- Overrides:
indexOfin classDBDictionary- Parameters:
buf- the SQL buffer to write the indexOf invocation tostr- a query value representing the target stringfind- a query value representing the search stringstart- a query value representing the start index, or null to start at the beginning
-
appendSelectRange
protected void appendSelectRange(SQLBuffer buf, long start, long end, boolean subselect)
Description copied from class:DBDictionaryIf this dictionary can select ranges, use this method to append the range SQL.- Overrides:
appendSelectRangein classAbstractSQLServerDictionary
-
-