Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/*
* Copyright 2026 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.google.cloud.bigquery.jdbc;

import java.sql.Date;
import java.sql.Time;
import java.sql.Timestamp;
import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.ZoneId;
import java.util.Calendar;

/**
* A highly optimized utility for bridging BigQuery's civil time and absolute time semantics to
* legacy JDBC Date/Time/Timestamp classes using JSR-310 timezone anchoring.
*/
final class BigQueryTemporalUtility {

private BigQueryTemporalUtility() {}

/**
* Converts a BigQuery civil DATETIME string into an absolute Timestamp by anchoring it to the
* provided timezone (or JVM default if null).
*/
public static Timestamp boxDateTime(String val, ZoneId zoneId) {
ZoneId targetZone = zoneId != null ? zoneId : ZoneId.systemDefault();
String isoString = val.replace(' ', 'T');
return Timestamp.from(LocalDateTime.parse(isoString).atZone(targetZone).toInstant());
}

/**
* Converts a BigQuery civil DATE string into an absolute Date by anchoring it to midnight of the
* provided timezone (or JVM default if null).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this is where I'm not 100% sure about the behavior.

We have 4 time-related types: timestamp, time, date, datetime.

Time, Date, Datetime are not timezone specific, so we should be reading them as-is. If it is stored as "12:30:00", it should remain "12:30:00" regardless of the JVM timezone or provided timezone.

Timestamp is the only value that needs to be adjusted to the timezone.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. java.sql.Date stores epoch millis under the hood, not civil year/month/day fields.
  2. getDate(col, cal) contract: Per JDBC spec, the returned java.sql.Date must represent midnight (00:00:00) in the provided Calendar's timezone.
  3. Prevents date shifting: Without anchoring to midnight in the target timezone, formatting or reading the date in that timezone would shift it to the wrong day (e.g., UTC midnight 2026-07-17 displays as 2026-07-16 20:00 in New York time).

(Note: Modern LocalDate via getObject(col, LocalDate.class) is already timezone-agnostic and read as-is without any conversion).

Returned Class / Method Underlying Representation Timezone Handling
getObject(col, LocalDate.class) java.time.LocalDate As-is (completely timezone-agnostic)
getObject(col, LocalTime.class) java.time.LocalTime As-is (completely timezone-agnostic)
getDate(col) java.sql.Date Anchored to 00:00:00 in JVM default timezone
getDate(col, Calendar cal) java.sql.Date Anchored to 00:00:00 in target Calendar timezone
getTimestamp(col, Calendar cal) java.sql.Timestamp Absolute instant adjusted to target Calendar timezone

*/
public static Date boxDate(String val, ZoneId zoneId) {
ZoneId targetZone = zoneId != null ? zoneId : ZoneId.systemDefault();
return new Date(LocalDate.parse(val).atStartOfDay(targetZone).toInstant().toEpochMilli());
}

/**
* Converts a BigQuery civil TIME string into an absolute Time. If a ZoneId is provided (e.g. from
* the legacy JDBC 3.0 getTime(col, Calendar) API), this uses legacy Calendar manipulation to
* strictly mimic older JVM historical DST quirks for 1970. If no ZoneId is provided (e.g. modern
* JDBC 4.2 getObject(col, LocalTime.class)), this uses pure JSR-310 math which guarantees
* perfectly accurate modern conversions.
*/
public static Time boxTime(String val, ZoneId zoneId) {
LocalTime localTime = LocalTime.parse(val);

if (zoneId == null) {
// JDBC 4.2 Modern API (no Calendar provided):
// Use pure JSR-310 math for perfectly accurate modern conversions without Calendar quirks.
return new Time(
localTime
.atDate(LocalDate.of(1970, 1, 1))
.atZone(ZoneId.systemDefault())
.toInstant()
.toEpochMilli());
}

// Legacy JDBC 3.0 API (Calendar provided):
// Use legacy Calendar manipulation to intentionally replicate old JVM historical DST quirks
// for January 1, 1970, ensuring strict backwards compatibility for legacy ORMs.
Calendar targetCal = Calendar.getInstance(java.util.TimeZone.getTimeZone(zoneId));
targetCal.set(Calendar.YEAR, 1970);
targetCal.set(Calendar.MONTH, Calendar.JANUARY);
targetCal.set(Calendar.DAY_OF_MONTH, 1);
targetCal.set(Calendar.HOUR_OF_DAY, localTime.getHour());
targetCal.set(Calendar.MINUTE, localTime.getMinute());
targetCal.set(Calendar.SECOND, localTime.getSecond());
targetCal.set(Calendar.MILLISECOND, localTime.getNano() / 1_000_000);

return new Time(targetCal.getTimeInMillis());
}

/**
* Converts a BigQuery absolute TIMESTAMP string into a legacy Timestamp. Because it is absolute,
* the Calendar timezone is explicitly ignored per JDBC 4.2 spec.
*/
public static Timestamp boxTimestamp(String val) {
String iso = val;
// Handle the " UTC" suffix format
if (iso.endsWith(" UTC")) {
iso = iso.substring(0, iso.length() - 4) + "Z";
}
// Replace the date-time space separator with 'T' (e.g. 2023-10-01 12:00:00 ->
// 2023-10-01T12:00:00)
if (iso.length() > 10 && iso.charAt(10) == ' ') {
iso = iso.substring(0, 10) + 'T' + iso.substring(11);
}

try {
return Timestamp.from(Instant.parse(iso));
} catch (java.time.format.DateTimeParseException e) {
// Fallback for non-standard formats
return Timestamp.valueOf(val);
}
}
}
Loading
Loading