Skip to content

Fix SQL Server timestamp handling with non-US date formats #5805

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
labkey-adam merged 3 commits into from
Aug 27, 2024
Merged

Fix SQL Server timestamp handling with non-US date formats #5805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4ac597
Fix SQL Server timestamp handling with non-US date formats
labkey-adam Aug 26, 2024
77f9b6f
Probably should run this on SQL Server 2016+ only
labkey-adam Aug 26, 2024
ee2b5e0
Flag unsupported date formats
labkey-adam Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions bigiron/src/org/labkey/bigiron/BigIronModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.labkey.api.module.ModuleContext;
import org.labkey.api.view.WebPartFactory;
import org.labkey.bigiron.mssql.GroupConcatInstallationManager;
import org.labkey.bigiron.mssql.MicrosoftSqlServer2016Dialect;
import org.labkey.bigiron.mssql.MicrosoftSqlServerDialectFactory;
import org.labkey.bigiron.mssql.MicrosoftSqlServerVersion;
import org.labkey.bigiron.mssql.synonym.SynonymTestCase;
Expand Down Expand Up @@ -87,6 +88,7 @@ public Set<Class> getIntegrationTests()
{
return Set.of(
GroupConcatInstallationManager.TestCase.class,
MicrosoftSqlServer2016Dialect.TestCase.class,
MicrosoftSqlServerVersion.TestCase.class,
OracleVersion.TestCase.class,
SynonymTestCase.class
Expand Down
187 changes: 139 additions & 48 deletions bigiron/src/org/labkey/bigiron/mssql/MicrosoftSqlServer2016Dialect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,62 @@
*/
package org.labkey.bigiron.mssql;

import org.apache.logging.log4j.Logger;
import org.junit.Assert;
import org.junit.Test;
import org.labkey.api.data.ConnectionWrapper;
import org.labkey.api.data.DbScope;
import org.labkey.api.data.SqlSelector;
import org.labkey.api.data.dialect.SqlDialect;
import org.labkey.api.data.dialect.StatementWrapper;
import org.labkey.api.module.ModuleLoader;
import org.labkey.api.util.logging.LogHelper;

import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Statement;
import java.sql.Timestamp;
import java.sql.Types;
import java.time.ZoneId;
import java.time.format.DateTimeFormatter;
import java.util.Calendar;
import java.util.Date;
import java.util.Map;

/**
* User: adam
* Date: 8/11/2015
* Time: 1:19 PM
*/
public class MicrosoftSqlServer2016Dialect extends MicrosoftSqlServer2014Dialect
{
private static final Logger LOG = LogHelper.getLogger(MicrosoftSqlServer2016Dialect.class, "SQL Server settings");

private volatile String _language = null;
private volatile String _dateFormat = null;
private volatile DateTimeFormatter _timestampFormatter = null;

@Override
public void prepare(DbScope scope)
{
super.prepare(scope);

Map<String, Object> map = new SqlSelector(scope, "SELECT language, date_format FROM sys.dm_exec_sessions WHERE session_id = @@spid").getMap();
_language = (String) map.get("language");
_dateFormat = (String) map.get("date_format");

// This seems to be the only string format acceptable for sending Timestamps, but unfortunately it's ambiguous;
// SQL Server interprets the "MM-dd" portion based on the database's regional settings. So we must query the
// current date format and switch the formatter pattern based on what we find. See Issue 51129.
String mdFormat = switch (_dateFormat)
{
case "mdy" -> "MM-dd";
case "dmy" -> "dd-MM";
default -> throw new IllegalStateException("Unsupported date format: " + _dateFormat);
};

_timestampFormatter = DateTimeFormatter.ofPattern("yyyy-" + mdFormat + " HH:mm:ss.SSS");

LOG.info("\n Language: {}\n DateFormat: {}", _language, _dateFormat);
}

@Override
public StatementWrapper getStatementWrapper(ConnectionWrapper conn, Statement stmt)
{
Expand All @@ -44,17 +85,15 @@ public StatementWrapper getStatementWrapper(ConnectionWrapper conn, Statement st

/**
* Per the SQL Server JDBC driver docs at <a href="https://docs.microsoft.com/en-us/sql/connect/jdbc/using-basic-data-types?view=sql-server-ver16">...</a>
*
* Note that java.sql.Timestamp values can no longer be used to compare values from a datetime column starting
* "Note that java.sql.Timestamp values can no longer be used to compare values from a datetime column starting
* from SQL Server 2016. This limitation is due to a server-side change that converts datetime to datetime2
* differently, resulting in non-equitable values. The workaround to this issue is to either change datetime
* columns to datetime2(3), use String instead of java.sql.Timestamp, or change database compatibility level
* to 120 or below.
*
*
* java.sql.Timestamp.toString() includes the nanos in a ISO 8061-like format
* to 120 or below." We can't change column types in external schemas, and we don't want a low compatibility level,
* so we send Timestamps as Strings. SQL Server is very picky about this format; for example, Timestamp.toString(),
* which is basically ISO, is actually ambiguous and fails if language is French (e.g.). See Issue 51129.
*/
private static class TimestampStatementWrapper extends StatementWrapper
private class TimestampStatementWrapper extends StatementWrapper
{
public TimestampStatementWrapper(ConnectionWrapper conn, Statement stmt)
{
Expand All @@ -67,12 +106,11 @@ public TimestampStatementWrapper(ConnectionWrapper conn, Statement stmt, String
}

@Override
public void setTimestamp(String parameterName, Timestamp x)
throws SQLException
public void setTimestamp(String parameterName, Timestamp x) throws SQLException
{
if (x != null)
{
setObject(parameterName, x.toString());
setObject(parameterName, convert(x));
}
else
{
Expand All @@ -81,12 +119,11 @@ public void setTimestamp(String parameterName, Timestamp x)
}

@Override
public void setTimestamp(String parameterName, Timestamp x, Calendar cal)
throws SQLException
public void setTimestamp(String parameterName, Timestamp x, Calendar cal) throws SQLException
{
if (x != null)
{
setObject(parameterName, x.toString());
setObject(parameterName, convert(x));
}
else
{
Expand All @@ -95,12 +132,11 @@ public void setTimestamp(String parameterName, Timestamp x, Calendar cal)
}

@Override
public void setTimestamp(int parameterIndex, Timestamp x)
throws SQLException
public void setTimestamp(int parameterIndex, Timestamp x) throws SQLException
{
if (x != null)
{
setObject(parameterIndex, x.toString());
setObject(parameterIndex, convert(x));
}
else
{
Expand All @@ -109,12 +145,11 @@ public void setTimestamp(int parameterIndex, Timestamp x)
}

@Override
public void setTimestamp(int parameterIndex, Timestamp x, Calendar cal)
throws SQLException
public void setTimestamp(int parameterIndex, Timestamp x, Calendar cal) throws SQLException
{
if (x != null)
{
setObject(parameterIndex, x.toString());
setObject(parameterIndex, convert(x));
}
else
{
Expand All @@ -123,51 +158,107 @@ public void setTimestamp(int parameterIndex, Timestamp x, Calendar cal)
}

@Override
public void setObject(int parameterIndex, Object x, int targetSqlType, int scale)
throws SQLException
public void setObject(int parameterIndex, Object x, int targetSqlType, int scale) throws SQLException
{
x = x instanceof Timestamp ? x.toString() : x;
super.setObject(parameterIndex, x, targetSqlType, scale);
if (targetSqlType == Types.TIMESTAMP)
setObject(parameterIndex, x);
else
super.setObject(parameterIndex, x, targetSqlType, scale);
}

@Override
public void setObject(int parameterIndex, Object x, int targetSqlType)
throws SQLException
public void setObject(int parameterIndex, Object x, int targetSqlType) throws SQLException
{
x = x instanceof Timestamp ? x.toString() : x;
super.setObject(parameterIndex, x, targetSqlType);
if (targetSqlType == Types.TIMESTAMP)
setObject(parameterIndex, x);
else
super.setObject(parameterIndex, x, targetSqlType);
}

@Override
public void setObject(int parameterIndex, Object x)
throws SQLException
public void setObject(int parameterIndex, Object x) throws SQLException
{
x = x instanceof Timestamp ? x.toString() : x;
super.setObject(parameterIndex, x);
super.setObject(parameterIndex, convert(x));
}

@Override
public void setObject(String parameterName, Object x, int targetSqlType, int scale)
throws SQLException
public void setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException
{
x = x instanceof Timestamp ? x.toString() : x;
super.setObject(parameterName, x, targetSqlType, scale);
if (targetSqlType == Types.TIMESTAMP)
setObject(parameterName, x);
else
super.setObject(parameterName, x, targetSqlType, scale);
}

@Override
public void setObject(String parameterName, Object x, int targetSqlType)
throws SQLException
public void setObject(String parameterName, Object x, int targetSqlType) throws SQLException
{
x = x instanceof Timestamp ? x.toString() : x;
super.setObject(parameterName, x, targetSqlType);
if (targetSqlType == Types.TIMESTAMP)
setObject(parameterName, x);
else
super.setObject(parameterName, x, targetSqlType);
}

@Override
public void setObject(String parameterName, Object x)
throws SQLException
public void setObject(String parameterName, Object x) throws SQLException
{
x = x instanceof Timestamp ? x.toString() : x;
super.setObject(parameterName, x);
super.setObject(parameterName, convert(x));
}

private Object convert(Object x)
{
return x instanceof Timestamp ts ? convert(ts) : x;
}

private String convert(Timestamp ts)
{
return _timestampFormatter.format(ts.toInstant().atZone(ZoneId.systemDefault()));
}
}

public static class TestCase
{
@Test
public void testTimestamps()
{
DbScope scope = DbScope.getLabKeyScope();
SqlDialect dialect = scope.getSqlDialect();

if (dialect.isSqlServer() && dialect instanceof MicrosoftSqlServer2016Dialect)
{
try (Connection conn = DbScope.getLabKeyScope().getConnection())
{
Timestamp ts = new Timestamp(new Date().getTime());
Calendar cal = Calendar.getInstance();

try (PreparedStatement statement = conn.prepareStatement("SELECT ?"))
{
Assert.assertTrue(statement instanceof TimestampStatementWrapper);
statement.setTimestamp(1, ts);
statement.setTimestamp(1, ts, cal);
statement.setObject(1, ts, Types.TIMESTAMP, 0);
statement.setObject(1, ts, Types.TIMESTAMP);
statement.setObject(1, ts);
}

if (ModuleLoader.getInstance().hasModule("DataIntegration"))
{
try (CallableStatement statement = conn.prepareCall("{call etltest.etlTest(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)}"))
{
Assert.assertTrue(statement instanceof TimestampStatementWrapper);
statement.setTimestamp("filterStartTimeStamp", ts);
statement.setTimestamp("filterStartTimeStamp", ts, cal);
statement.setObject("filterStartTimeStamp", ts, Types.TIMESTAMP, 0);
statement.setObject("filterStartTimeStamp", ts, Types.TIMESTAMP);
statement.setObject("filterStartTimeStamp", ts);
}
}
}
catch (SQLException e)
{
throw new RuntimeException(e);
}
}
}
}
}