/******************************************************************************* * Copyright (c) 1998, 2015 Oracle and/or its affiliates, IBM Corporation. All rights reserved. * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0 * which accompanies this distribution. * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html * and the Eclipse Distribution License is available at * http://www.eclipse.org/org/documents/edl-v10.php. * * Contributors: * Oracle - initial API and implementation from Oracle TopLink * 09/14/2011-2.3.1 Guy Pelletier * - 357533: Allow DDL queries to execute even when Multitenant entities are part of the PU * 02/19/2015 - Rick Curtis * - 458877 : Add national character support * 02/23/2015-2.6 Dalia Abo Sheasha * - 460607: Change DatabasePlatform StoredProcedureTerminationToken to be configurable *****************************************************************************/ package org.eclipse.persistence.platform.database; import java.io.*; import java.sql.Connection; import java.sql.DatabaseMetaData; import java.sql.SQLException; import java.util.*; import org.eclipse.persistence.exceptions.*; import org.eclipse.persistence.expressions.*; import org.eclipse.persistence.internal.expressions.*; import org.eclipse.persistence.internal.helper.*; import org.eclipse.persistence.internal.sessions.AbstractSession; import org.eclipse.persistence.internal.databaseaccess.*; import org.eclipse.persistence.queries.*; /** * <p><b>Purpose</b>: Provides SQL Server specific behavior. * <p><b>Responsibilities</b>:<ul> * <li> Native SQL for byte[], Date, Time, {@literal &} Timestamp. * <li> Native sequencing using @@IDENTITY. * </ul> * * @since TOPLink/Java 1.0 */ public class SQLServerPlatform extends org.eclipse.persistence.platform.database.DatabasePlatform { /** Support for sequence objects added in SQL Server 2012 */ private boolean supportsSequenceObjects; private boolean isConnectionDataInitialized; public SQLServerPlatform(){ super(); this.pingSQL = "SELECT 1"; this.storedProcedureTerminationToken = " go"; } @Override public void initializeConnectionData(Connection connection) throws SQLException { if (isConnectionDataInitialized) { return; } DatabaseMetaData dmd = connection.getMetaData(); int databaseVersion = dmd.getDatabaseMajorVersion(); supportsSequenceObjects = databaseVersion >= 11; isConnectionDataInitialized = true; this.driverSupportsNationalCharacterVarying = Helper.compareVersions(dmd.getDriverVersion(), "4.0.0") >= 0; } /** * If using native SQL then print a byte[] as '0xFF...' */ protected void appendByteArray(byte[] bytes, Writer writer) throws IOException { if (usesNativeSQL() && (!usesByteArrayBinding())) { writer.write("0x"); Helper.writeHexString(bytes, writer); } else { super.appendByteArray(bytes, writer); } } /** * Answer a platform correct string representation of a Date, suitable for SQL generation. * Native format: 'yyyy-mm-dd */ protected void appendDate(java.sql.Date date, Writer writer) throws IOException { if (usesNativeSQL()) { writer.write("'"); writer.write(Helper.printDate(date)); writer.write("'"); } else { super.appendDate(date, writer); } } /** * Write a timestamp in Sybase specific format ( yyyy-mm-dd-hh.mm.ss.fff) */ protected void appendSybaseTimestamp(java.sql.Timestamp timestamp, Writer writer) throws IOException { writer.write("'"); writer.write(Helper.printTimestampWithoutNanos(timestamp)); writer.write(':'); // Must truncate the nanos to three decimal places, // it is actually a complex algorithm... String nanoString = Integer.toString(timestamp.getNanos()); int numberOfZeros = 0; for (int num = Math.min(9 - nanoString.length(), 3); num > 0; num--) { writer.write('0'); numberOfZeros++; } if ((nanoString.length() + numberOfZeros) > 3) { nanoString = nanoString.substring(0, (3 - numberOfZeros)); } writer.write(nanoString); writer.write("'"); } /** * Write a timestamp in Sybase specific format ( yyyy-mm-dd-hh.mm.ss.fff) */ protected void appendSybaseCalendar(Calendar calendar, Writer writer) throws IOException { writer.write("'"); writer.write(Helper.printCalendar(calendar)); writer.write("'"); } /** * Answer a platform correct string representation of a Time, suitable for SQL generation. * The time is printed in the ODBC platform independent format {t'hh:mm:ss'}. */ protected void appendTime(java.sql.Time time, Writer writer) throws IOException { if (usesNativeSQL()) { writer.write("'"); writer.write(Helper.printTime(time)); writer.write("'"); } else { super.appendTime(time, writer); } } /** * Answer a platform correct string representation of a Timestamp, suitable for SQL generation. * The date is printed in the ODBC platform independent format {d'YYYY-MM-DD'}. */ protected void appendTimestamp(java.sql.Timestamp timestamp, Writer writer) throws IOException { if (usesNativeSQL()) { appendSybaseTimestamp(timestamp, writer); } else { super.appendTimestamp(timestamp, writer); } } /** * Answer a platform correct string representation of a Calendar, suitable for SQL generation. * The date is printed in the ODBC platform independent format {d'YYYY-MM-DD'}. */ protected void appendCalendar(Calendar calendar, Writer writer) throws IOException { if (usesNativeSQL()) { appendSybaseCalendar(calendar, writer); } else { super.appendCalendar(calendar, writer); } } protected Hashtable buildFieldTypes() { Hashtable fieldTypeMapping; fieldTypeMapping = new Hashtable(); fieldTypeMapping.put(Boolean.class, new FieldTypeDefinition("BIT default 0", false)); fieldTypeMapping.put(Integer.class, new FieldTypeDefinition("INTEGER", false)); fieldTypeMapping.put(Long.class, new FieldTypeDefinition("NUMERIC", 19)); fieldTypeMapping.put(Float.class, new FieldTypeDefinition("FLOAT(16)", false)); fieldTypeMapping.put(Double.class, new FieldTypeDefinition("FLOAT(32)", false)); fieldTypeMapping.put(Short.class, new FieldTypeDefinition("SMALLINT", false)); fieldTypeMapping.put(Byte.class, new FieldTypeDefinition("SMALLINT", false)); fieldTypeMapping.put(java.math.BigInteger.class, new FieldTypeDefinition("NUMERIC", 28)); fieldTypeMapping.put(java.math.BigDecimal.class, new FieldTypeDefinition("NUMERIC", 28).setLimits(28, -19, 19)); fieldTypeMapping.put(Number.class, new FieldTypeDefinition("NUMERIC", 28).setLimits(28, -19, 19)); // Create String column to support unicode characters if(getUseNationalCharacterVaryingTypeForString()){ fieldTypeMapping.put(String.class, new FieldTypeDefinition("NVARCHAR", DEFAULT_VARCHAR_SIZE)); }else { fieldTypeMapping.put(String.class, new FieldTypeDefinition("VARCHAR", DEFAULT_VARCHAR_SIZE)); } fieldTypeMapping.put(Character.class, new FieldTypeDefinition("CHAR", 1)); fieldTypeMapping.put(Byte[].class, new FieldTypeDefinition("IMAGE", false)); fieldTypeMapping.put(Character[].class, new FieldTypeDefinition("TEXT", false)); fieldTypeMapping.put(byte[].class, new FieldTypeDefinition("IMAGE", false)); fieldTypeMapping.put(char[].class, new FieldTypeDefinition("TEXT", false)); fieldTypeMapping.put(java.sql.Blob.class, new FieldTypeDefinition("IMAGE", false)); fieldTypeMapping.put(java.sql.Clob.class, new FieldTypeDefinition("TEXT", false)); fieldTypeMapping.put(java.sql.Date.class, new FieldTypeDefinition("DATETIME", false)); fieldTypeMapping.put(java.sql.Time.class, new FieldTypeDefinition("DATETIME", false)); fieldTypeMapping.put(java.sql.Timestamp.class, new FieldTypeDefinition("DATETIME2", false)); return fieldTypeMapping; } /** * INTERNAL: * Build the identity query for native sequencing. */ public ValueReadQuery buildSelectQueryForIdentity() { ValueReadQuery selectQuery = new ValueReadQuery(); StringWriter writer = new StringWriter(); writer.write("SELECT @@IDENTITY"); selectQuery.setSQLString(writer.toString()); return selectQuery; } /** * INTERNAL: Produce a DataReadQuery which updates(!) the sequence number in * the database and returns it. * * @param qualifiedSeqName * a defined database sequence */ @Override public ValueReadQuery buildSelectQueryForSequenceObject(String qualifiedSeqName, Integer size) { return new ValueReadQuery("SELECT NEXT VALUE FOR " + qualifiedSeqName); } /** * INTERNAL: * In SQLServer local temporary table created by one * PreparedStatement can't be used in another PreparedStatement. * Workaround is to use Statement instead of PreparedStatement. */ public boolean dontBindUpdateAllQueryUsingTempTables() { return true; } /** * Used for batch writing and sp defs. */ public String getBatchDelimiterString() { return ""; } /** * This method is used to print the required output parameter token for the * specific platform. Used when stored procedures are created. */ public String getCreationInOutputProcedureToken() { return getInOutputProcedureToken(); } /** * This method is used to print the required output parameter token for the * specific platform. Used when stored procedures are created. */ public String getCreationOutputProcedureToken() { return "OUTPUT"; } /** * This method is used to print the output parameter token when stored * procedures are called */ public String getInOutputProcedureToken() { return "OUT"; } /** * INTERNAL: * returns the maximum number of characters that can be used in a field * name on this platform. */ public int getMaxFieldNameSize() { return 22; } /** * Return the catalog information through using the native SQL catalog selects. * This is required because many JDBC driver do not support meta-data. * Willcards can be passed as arguments. */ public Vector getNativeTableInfo(String table, String creator, AbstractSession session) { // need to filter only tables / views String query = "SELECT * FROM sysobjects WHERE table_type <> 'SYSTEM_TABLE'"; if (table != null) { if (table.indexOf('%') != -1) { query = query + " AND table_name LIKE " + table; } else { query = query + " AND table_name = " + table; } } if (creator != null) { if (creator.indexOf('%') != -1) { query = query + " AND table_owner LIKE " + creator; } else { query = query + " AND table_owner = " + creator; } } return session.executeSelectingCall(new SQLCall(query)); } /** * This method is used to print the output parameter token when stored * procedures are called */ public String getOutputProcedureToken() { return ""; } /** * Used for sp defs. */ public String getProcedureArgumentString() { return "@"; } /** * Used for sp calls. */ public String getProcedureCallHeader() { return "EXECUTE "; } public String getStoredProcedureParameterPrefix() { return "@"; } /** * PUBLIC: * This method returns the query to select the timestamp * from the server for SQLServer. */ public ValueReadQuery getTimestampQuery() { if (timestampQuery == null) { timestampQuery = new ValueReadQuery(); timestampQuery.setSQLString("SELECT GETDATE()"); timestampQuery.setAllowNativeSQLQuery(true); } return timestampQuery; } /** * INTERNAL: * Lock. * UPDLOCK seems like the correct table hint to use: * HOLDLOCK is too weak - doesn't lock out another read with HOLDLOCK, * XLOCK is too strong - locks out another read which doesn't use any locks. * UPDLOCK seems to behave exactly like Oracle's FOR UPDATE: * locking out updates and other reads with FOR UPDATE but allowing other reads without locks. * SQLServer seems to decide itself on the granularity of the lock - it could lock more than * the returned rows (for instance a page). It could be forced to obtain * to make sure to obtain row level lock: * WITH (UPDLOCK, ROWLOCK) * However this approach is strongly discouraged because it can consume too * much resources: selecting 900 rows from and requiring a "personal" * lock for each row may not be feasible because of not enough memory available at the moment - * in that case SQLServer will wait until the resource becomes available. * */ public String getSelectForUpdateString() { return " WITH (UPDLOCK)"; } /** * INTERNAL: * This syntax does no wait on the lock. */ public String getSelectForUpdateNoWaitString() { return " WITH (UPDLOCK, NOWAIT)"; } /** * INTERNAL: * Indicates whether locking clause should be printed after where clause by SQLSelectStatement. * Example: * on Oracle platform (method returns true): * SELECT ADDRESS_ID, ... FROM ADDRESS WHERE (ADDRESS_ID = ?) FOR UPDATE * on SQLServer platform (method returns false): * SELECT ADDRESS_ID, ... FROM ADDRESS WITH (UPDLOCK) WHERE (ADDRESS_ID = ?) */ public boolean shouldPrintLockingClauseAfterWhereClause() { return false; } /** * Initialize any platform-specific operators */ protected void initializePlatformOperators() { super.initializePlatformOperators(); addOperator(operatorOuterJoin()); addOperator(ExpressionOperator.simpleFunction(ExpressionOperator.Today, "GETDATE")); // GETDATE returns both date and time. It is not the perfect match for // ExpressionOperator.currentDate and ExpressionOperator.currentTime // However, there is no known function on sql server that returns just // the date or just the time. addOperator(ExpressionOperator.simpleFunction(ExpressionOperator.CurrentDate, "GETDATE")); addOperator(ExpressionOperator.simpleFunction(ExpressionOperator.CurrentTime, "GETDATE")); addOperator(ExpressionOperator.simpleFunction(ExpressionOperator.Length, "CHAR_LENGTH")); addOperator(ExpressionOperator.simpleThreeArgumentFunction(ExpressionOperator.Substring, "SUBSTRING")); addOperator(singleArgumentSubstringOperator()); addOperator(ExpressionOperator.addDate()); addOperator(ExpressionOperator.dateName()); addOperator(ExpressionOperator.datePart()); addOperator(ExpressionOperator.dateDifference()); addOperator(ExpressionOperator.difference()); addOperator(ExpressionOperator.charIndex()); addOperator(ExpressionOperator.charLength()); addOperator(ExpressionOperator.reverse()); addOperator(ExpressionOperator.replicate()); addOperator(ExpressionOperator.right()); addOperator(ExpressionOperator.cot()); addOperator(ExpressionOperator.sybaseAtan2Operator()); addOperator(ExpressionOperator.sybaseAddMonthsOperator()); addOperator(ExpressionOperator.sybaseInStringOperator()); // bug 3061144 addOperator(ExpressionOperator.simpleTwoArgumentFunction(ExpressionOperator.Nvl, "ISNULL")); // CR### TO_NUMBER, TO_CHAR, TO_DATE is CONVERT(type, ?) addOperator(ExpressionOperator.sybaseToNumberOperator()); addOperator(ExpressionOperator.sybaseToDateToStringOperator()); addOperator(ExpressionOperator.sybaseToDateOperator()); addOperator(ExpressionOperator.sybaseToCharOperator()); addOperator(ExpressionOperator.sybaseLocateOperator()); addOperator(locate2Operator()); addOperator(ExpressionOperator.simpleFunction(ExpressionOperator.Ceil, "CEILING")); addOperator(ExpressionOperator.simpleFunction(ExpressionOperator.Length, "LEN")); addOperator(modOperator()); addOperator(ExpressionOperator.simpleAggregate(ExpressionOperator.StandardDeviation, "STDEV", "standardDeviation")); addOperator(trimOperator()); addOperator(trim2Operator()); addOperator(extractOperator()); } /** * INTERNAL: * Derby does not support EXTRACT, but does have DATEPART. */ public static ExpressionOperator extractOperator() { ExpressionOperator exOperator = new ExpressionOperator(); exOperator.setType(ExpressionOperator.FunctionOperator); exOperator.setSelector(ExpressionOperator.Extract); exOperator.setName("EXTRACT"); Vector v = NonSynchronizedVector.newInstance(5); v.add("DATEPART("); v.add(","); v.add(")"); exOperator.printsAs(v); int[] indices = new int[2]; indices[0] = 1; indices[1] = 0; exOperator.setArgumentIndices(indices); exOperator.bePrefix(); exOperator.setNodeClass(ClassConstants.FunctionExpression_Class); return exOperator; } /** * INTERNAL: * Use RTRIM(LTRIM(?)) function for trim. */ public static ExpressionOperator trimOperator() { ExpressionOperator exOperator = new ExpressionOperator(); exOperator.setType(ExpressionOperator.FunctionOperator); exOperator.setSelector(ExpressionOperator.Trim); Vector v = org.eclipse.persistence.internal.helper.NonSynchronizedVector.newInstance(2); v.add("RTRIM(LTRIM("); v.add("))"); exOperator.printsAs(v); exOperator.bePrefix(); exOperator.setNodeClass(ClassConstants.FunctionExpression_Class); return exOperator; } /** * INTERNAL: * Build Trim operator. */ public static ExpressionOperator trim2Operator() { ExpressionOperator exOperator = new ExpressionOperator(); exOperator.setType(ExpressionOperator.FunctionOperator); exOperator.setSelector(ExpressionOperator.Trim2); Vector v = org.eclipse.persistence.internal.helper.NonSynchronizedVector.newInstance(5); v.add("RTRIM("); v.add(" FROM LTRIM("); v.add(" FROM "); v.add("))"); exOperator.printsAs(v); int[] argumentIndices = new int[3]; argumentIndices[0] = 1; argumentIndices[1] = 1; argumentIndices[2] = 0; exOperator.setArgumentIndices(argumentIndices); exOperator.setNodeClass(ClassConstants.FunctionExpression_Class); return exOperator; } /** * INTERNAL: * Return true if output parameters can be built with result sets. */ @Override public boolean isOutputAllowWithResultSet() { return false; } public boolean isSQLServer() { return true; } /** * Builds a table of maximum numeric values keyed on java class. This is used for type testing but * might also be useful to end users attempting to sanitize values. * <p><b>NOTE</b>: BigInteger {@literal &} BigDecimal maximums are dependent upon their precision {@literal &} Scale */ public Hashtable maximumNumericValues() { Hashtable values = new Hashtable(); values.put(Integer.class, Integer.valueOf(Integer.MAX_VALUE)); values.put(Long.class, Long.valueOf(Long.MAX_VALUE)); values.put(Double.class, Double.valueOf(0)); values.put(Short.class, Short.valueOf(Short.MAX_VALUE)); values.put(Byte.class, Byte.valueOf(Byte.MAX_VALUE)); values.put(Float.class, Float.valueOf(0)); values.put(java.math.BigInteger.class, new java.math.BigInteger("9999999999999999999999999999")); values.put(java.math.BigDecimal.class, new java.math.BigDecimal("999999999.9999999999999999999")); return values; } /** * Builds a table of minimum numeric values keyed on java class. This is used for type testing but * might also be useful to end users attempting to sanitize values. * <p><b>NOTE</b>: BigInteger {@literal &} BigDecimal minimums are dependent upon their precision {@literal &} Scale */ public Hashtable minimumNumericValues() { Hashtable values = new Hashtable(); values.put(Integer.class, Integer.valueOf(Integer.MIN_VALUE)); values.put(Long.class, Long.valueOf(Long.MIN_VALUE)); values.put(Double.class, Double.valueOf(-9)); values.put(Short.class, Short.valueOf(Short.MIN_VALUE)); values.put(Byte.class, Byte.valueOf(Byte.MIN_VALUE)); values.put(Float.class, Float.valueOf(-9)); values.put(java.math.BigInteger.class, new java.math.BigInteger("-9999999999999999999999999999")); values.put(java.math.BigDecimal.class, new java.math.BigDecimal("-999999999.9999999999999999999")); return values; } /** * Override the default MOD operator. */ public ExpressionOperator modOperator() { ExpressionOperator result = new ExpressionOperator(); result.setSelector(ExpressionOperator.Mod); Vector v = org.eclipse.persistence.internal.helper.NonSynchronizedVector.newInstance(); v.addElement(" % "); result.printsAs(v); result.bePostfix(); result.setNodeClass(org.eclipse.persistence.internal.expressions.FunctionExpression.class); return result; } /** * Override the default SubstringSingleArg operator. */ public ExpressionOperator singleArgumentSubstringOperator() { ExpressionOperator result = new ExpressionOperator(); result.setSelector(ExpressionOperator.SubstringSingleArg); result.setType(ExpressionOperator.FunctionOperator); Vector v = org.eclipse.persistence.internal.helper.NonSynchronizedVector.newInstance(); v.addElement("SUBSTRING("); v.addElement(","); v.addElement(", LEN("); v.addElement("))"); result.printsAs(v); int[] indices = new int[3]; indices[0] = 0; indices[1] = 1; indices[2] = 0; result.setArgumentIndices(indices); result.setNodeClass(ClassConstants.FunctionExpression_Class); result.bePrefix(); return result; } /* * Create the outer join operator for this platform */ protected ExpressionOperator operatorOuterJoin() { ExpressionOperator result = new ExpressionOperator(); result.setSelector(ExpressionOperator.EqualOuterJoin); Vector v = org.eclipse.persistence.internal.helper.NonSynchronizedVector.newInstance(); v.addElement(" =* "); result.printsAs(v); result.bePostfix(); result.setNodeClass(RelationExpression.class); return result; } /** * INTERNAL: * create the Locate2 Operator for this platform */ public static ExpressionOperator locate2Operator() { ExpressionOperator result = ExpressionOperator.simpleThreeArgumentFunction(ExpressionOperator.Locate2, "CHARINDEX"); int[] argumentIndices = new int[3]; argumentIndices[0] = 1; argumentIndices[1] = 0; argumentIndices[2] = 2; result.setArgumentIndices(argumentIndices); return result; } /** * INTERNAL: * Append the receiver's field 'identity' constraint clause to a writer. */ public void printFieldIdentityClause(Writer writer) throws ValidationException { try { writer.write(" IDENTITY"); } catch (IOException ioException) { throw ValidationException.fileError(ioException); } } /** * INTERNAL: * Append the receiver's field 'NULL' constraint clause to a writer. */ public void printFieldNullClause(Writer writer) throws ValidationException { try { writer.write(" NULL"); } catch (IOException ioException) { throw ValidationException.fileError(ioException); } } /** * USed for sp calls. */ public boolean requiresProcedureCallBrackets() { return false; } /** * Used for sp calls. Sybase must print output after output params. */ public boolean requiresProcedureCallOuputToken() { return true; } /** * This is required in the construction of the stored procedures with * output parameters */ public boolean shouldPrintInOutputTokenBeforeType() { return false; } /** * This is required in the construction of the stored procedures with * output parameters */ public boolean shouldPrintOutputTokenBeforeType() { return false; } /** * JDBC defines and outer join syntax, many drivers do not support this. So we normally avoid it. */ public boolean shouldUseJDBCOuterJoinSyntax() { return false; } /** * INTERNAL: * Indicates whether the platform supports identity. * SQLServer does through IDENTITY field types. * This method is to be used *ONLY* by sequencing classes */ public boolean supportsIdentity() { return true; } /** * INTERNAL: */ @Override public boolean supportsSequenceObjects() { return supportsSequenceObjects; } /** * INTERNAL: */ public boolean supportsLocalTempTables() { return true; } /** * INTERNAL: */ protected String getCreateTempTableSqlPrefix() { return "CREATE TABLE "; } /** * INTERNAL: */ public DatabaseTable getTempTableForTable(DatabaseTable table) { return new DatabaseTable("#" + table.getName(), table.getTableQualifier(), table.shouldUseDelimiters(), getStartDelimiter(), getEndDelimiter()); } /** * INTERNAL: */ public void writeUpdateOriginalFromTempTableSql(Writer writer, DatabaseTable table, Collection pkFields, Collection assignedFields) throws IOException { writer.write("UPDATE "); String tableName = table.getQualifiedNameDelimited(this); writer.write(tableName); String tempTableName = getTempTableForTable(table).getQualifiedNameDelimited(this); writeAutoAssignmentSetClause(writer, null, tempTableName, assignedFields, this); writer.write(" FROM "); writer.write(tableName); writer.write(", "); writer.write(tempTableName); writeAutoJoinWhereClause(writer, tableName, tempTableName, pkFields, this); } }