io.debezium.jdbc

Class TimeZoneAdapter

java.lang.Object

io.debezium.jdbc.TimeZoneAdapter

@Immutable
public class TimeZoneAdapter
extends Object

An adapter that can convert Date, Date, Time, and Timestamp objects to ZonedDateTime instances, where the time zone in which the temporal objects were created by the database/driver can be adjusted.

Author:

Randall Hauch

Field Summary

Fields

Modifier and Type	Field and Description
private static LocalDate	EPOCH
private ZoneId	sqlDateZoneId
private ZoneId	sqlTimestampZoneId
private ZoneId	sqlTimeZoneId
private ZoneId	targetZoneId
static ZoneId	UTC
private ZoneId	utilDateZoneId

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TimeZoneAdapter(ZoneId targetZoneId, ZoneId utilDateZoneId, ZoneId sqlDateZoneId, ZoneId sqlTimeZoneId, ZoneId sqlTimestampZoneId) Create an adapter for temporal values defined in terms of the given zone.

Method Summary

Modifier and Type	Method and Description
static TimeZoneAdapter	create() Create a new adapter with UTC as the target zone and for a database that uses UTC for all temporal values.
static TimeZoneAdapter	originatingIn(ZoneId zoneId) Create a new adapter for a database that uses the specified zone for all temporal values.
static TimeZoneAdapter	originatingInLocal() Create a new adapter for a database that creates all temporal values in the local system time zone, which is the same time zone used by Calendar.getInstance().
static TimeZoneAdapter	originatingInUtc() Create a new adapter for a database that creates all temporal values in UTC.
protected ZoneId	targetZoneId()
ZonedDateTime	toZonedDateTime(Date dbDate) Convert the specified database Date, Date, Time, or Timestamp objects to a date and time in the same time zone in which the database created the value.
ZonedDateTime	toZonedDateTime(Date dbDate) Convert the specified database Date to a date (at midnight) in the same time zone in which the database created the value.
ZonedDateTime	toZonedDateTime(Time dbTime) Convert the specified database Time to a time (on the first epoch day) in the same time zone in which the database created the value.
ZonedDateTime	toZonedDateTime(Timestamp dbTimestamp) Convert the specified database Timestamp to a timestamp in the same time zone in which the database created the value.
TimeZoneAdapter	withLocalTargetZone() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for the target.
TimeZoneAdapter	withLocalZoneForSqlDate() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.
TimeZoneAdapter	withLocalZoneForSqlTime() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Time temporal values.
TimeZoneAdapter	withLocalZoneForSqlTimestamp() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Timestamp temporal values.
TimeZoneAdapter	withLocalZoneForUtilDate() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.
TimeZoneAdapter	withTargetZone(ZoneId zoneId) Create a new adapter that produces temporal values in the specified time zone.
TimeZoneAdapter	withUtcTargetZone() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for the target.
TimeZoneAdapter	withUtcZoneForSqlDate() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.
TimeZoneAdapter	withUtcZoneForSqlTime() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Time temporal values.
TimeZoneAdapter	withUtcZoneForSqlTimestamp() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Timestamp temporal values.
TimeZoneAdapter	withUtcZoneForUtilDate() Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.
TimeZoneAdapter	withZoneForAll(ZoneId zoneId) Create a new adapter for a database that uses the specified zone for all temporal values and this adapter's target zone.
TimeZoneAdapter	withZoneForSqlDate(ZoneId zoneId) Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Date temporal values.
TimeZoneAdapter	withZoneForSqlTime(ZoneId zoneId) Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Time temporal values.
TimeZoneAdapter	withZoneForSqlTimestamp(ZoneId zoneId) Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Timestamp temporal values.
TimeZoneAdapter	withZoneForUtilDate(ZoneId zoneId) Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Date temporal values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EPOCH

private static final LocalDate EPOCH

UTC

public static final ZoneId UTC

targetZoneId

private final ZoneId targetZoneId

utilDateZoneId

private final ZoneId utilDateZoneId

sqlDateZoneId

private final ZoneId sqlDateZoneId

sqlTimeZoneId

private final ZoneId sqlTimeZoneId

sqlTimestampZoneId

private final ZoneId sqlTimestampZoneId

Constructor Detail

TimeZoneAdapter

protected TimeZoneAdapter(ZoneId targetZoneId,
                          ZoneId utilDateZoneId,
                          ZoneId sqlDateZoneId,
                          ZoneId sqlTimeZoneId,
                          ZoneId sqlTimestampZoneId)

Create an adapter for temporal values defined in terms of the given zone.

Parameters:

targetZoneId - the zone in which the output temporal values are defined; may not be null

utilDateZoneId - the zone in which Date values are defined; may not be null

sqlDateZoneId - the zone in which Date values are defined; may not be null

sqlTimeZoneId - the zone in which Time values are defined; may not be null

sqlTimestampZoneId - the zone in which Timestamp values are defined; may not be null

Method Detail

create

public static TimeZoneAdapter create()

Create a new adapter with UTC as the target zone and for a database that uses UTC for all temporal values.

Returns:

the new adapter

originatingIn

public static TimeZoneAdapter originatingIn(ZoneId zoneId)

Create a new adapter for a database that uses the specified zone for all temporal values.

Parameters:

zoneId - the zone in which all temporal values are created by the database; may not be null

Returns:

the new adapter

originatingInUtc

public static TimeZoneAdapter originatingInUtc()

Create a new adapter for a database that creates all temporal values in UTC.

Returns:

the new adapter

originatingInLocal

public static TimeZoneAdapter originatingInLocal()

Create a new adapter for a database that creates all temporal values in the local system time zone, which is the same time zone used by Calendar.getInstance().

Returns:

the new adapter

targetZoneId

protected ZoneId targetZoneId()

toZonedDateTime

public ZonedDateTime toZonedDateTime(Date dbDate)

Convert the specified database Date, Date, Time, or Timestamp objects to a date and time in the same time zone in which the database created the value. If only time information is provided in the input value, the date information will be set to the first day of the epoch. If only date information is provided in the input value, the time information will be at midnight on the specified day.

Parameters:

dbDate - the database-generated value; may not be null

Returns:

the date time in the same zone used by the database; never null

toZonedDateTime

public ZonedDateTime toZonedDateTime(Date dbDate)

Convert the specified database Date to a date (at midnight) in the same time zone in which the database created the value.

Parameters:

dbDate - the database-generated value; may not be null

Returns:

the date (at midnight) in the same zone used by the database; never null

toZonedDateTime

public ZonedDateTime toZonedDateTime(Time dbTime)

Convert the specified database Time to a time (on the first epoch day) in the same time zone in which the database created the value.

Parameters:

dbTime - the database-generated value; may not be null

Returns:

the time (on the first epoch day) in the same zone used by the database; never null

toZonedDateTime

public ZonedDateTime toZonedDateTime(Timestamp dbTimestamp)

Convert the specified database Timestamp to a timestamp in the same time zone in which the database created the value.

Parameters:

dbTimestamp - the database-generated value; may not be null

Returns:

the timestamp in the same zone used by the database; never null

withTargetZone

public TimeZoneAdapter withTargetZone(ZoneId zoneId)

Create a new adapter that produces temporal values in the specified time zone.

Parameters:

zoneId - the zone in which all temporal values are to be defined; may not be null

Returns:

the new adapter

withZoneForAll

public TimeZoneAdapter withZoneForAll(ZoneId zoneId)

Create a new adapter for a database that uses the specified zone for all temporal values and this adapter's target zone.

Parameters:

zoneId - the zone in which all temporal values are created by the database; may not be null

Returns:

the new adapter

withZoneForUtilDate

public TimeZoneAdapter withZoneForUtilDate(ZoneId zoneId)

Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Date temporal values.

Parameters:

zoneId - the zone in which all Date values are created by the database; may not be null

Returns:

the new adapter; never null

withZoneForSqlDate

public TimeZoneAdapter withZoneForSqlDate(ZoneId zoneId)

Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Date temporal values.

Parameters:

zoneId - the zone in which all Date values are created by the database; may not be null

Returns:

the new adapter; never null

withZoneForSqlTime

public TimeZoneAdapter withZoneForSqlTime(ZoneId zoneId)

Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Time temporal values.

Parameters:

zoneId - the zone in which all Time values are created by the database; may not be null

Returns:

the new adapter; never null

withZoneForSqlTimestamp

public TimeZoneAdapter withZoneForSqlTimestamp(ZoneId zoneId)

Create a new adapter for a database that uses the same time zones as this adapter except it uses the specified zone for Timestamp temporal values.

Parameters:

zoneId - the zone in which all Timestamp values are created by the database; may not be null

Returns:

the new adapter; never null

withUtcTargetZone

public TimeZoneAdapter withUtcTargetZone()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for the target.

Returns:

the new adapter; never null

withUtcZoneForUtilDate

public TimeZoneAdapter withUtcZoneForUtilDate()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.

Returns:

the new adapter; never null

withUtcZoneForSqlDate

public TimeZoneAdapter withUtcZoneForSqlDate()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.

Returns:

the new adapter; never null

withUtcZoneForSqlTime

public TimeZoneAdapter withUtcZoneForSqlTime()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Time temporal values.

Returns:

the new adapter; never null

withUtcZoneForSqlTimestamp

public TimeZoneAdapter withUtcZoneForSqlTimestamp()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Timestamp temporal values.

Returns:

the new adapter; never null

withLocalTargetZone

public TimeZoneAdapter withLocalTargetZone()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for the target.

Returns:

the new adapter; never null

withLocalZoneForUtilDate

public TimeZoneAdapter withLocalZoneForUtilDate()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.

Returns:

the new adapter; never null

withLocalZoneForSqlDate

public TimeZoneAdapter withLocalZoneForSqlDate()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Date temporal values.

Returns:

the new adapter; never null

withLocalZoneForSqlTime

public TimeZoneAdapter withLocalZoneForSqlTime()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Time temporal values.

Returns:

the new adapter; never null

withLocalZoneForSqlTimestamp

public TimeZoneAdapter withLocalZoneForSqlTimestamp()

Create a new adapter for a database that uses the same time zones as this adapter except it uses the UTC zone for Timestamp temporal values.

Returns:

the new adapter; never null