org.apache.flink.table.dataformat

Class SqlTimestamp

java.lang.Object

org.apache.flink.table.dataformat.SqlTimestamp

All Implemented Interfaces:

Comparable<SqlTimestamp>

public class SqlTimestamp
extends Object
implements Comparable<SqlTimestamp>

Immutable SQL TIMESTAMP and TIMESTAMP_WITH_LOCAL_TIME_ZONE with nanosecond precision.

This class is composite of a millisecond and nanoOfMillisecond. The millisecond part holds the integral second and the milli-of-second. The nanoOfMillisecond holds the nano-of-millisecond, which should between 0 - 999_999.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SqlTimestamp that)
boolean	equals(Object obj)
static SqlTimestamp	fromEpochMillis(long millisecond) Obtains an instance of SqlTimestamp from a millisecond.
static SqlTimestamp	fromEpochMillis(long millisecond, int nanoOfMillisecond) Obtains an instance of SqlTimestamp from a millisecond and a nanoOfMillisecond.
static SqlTimestamp	fromInstant(java.time.Instant instant) Obtains an instance of SqlTimestamp from an instance of Instant.
static SqlTimestamp	fromLocalDateTime(java.time.LocalDateTime dateTime) Obtains an instance of SqlTimestamp from an instance of LocalDateTime.
static SqlTimestamp	fromTimestamp(Timestamp ts) Obtains an instance of SqlTimestamp from an instance of Timestamp.
long	getMillisecond()
int	getNanoOfMillisecond()
int	hashCode()
static boolean	isCompact(int precision) Apache Calcite and Flink's planner use the number of milliseconds since epoch to represent a Timestamp type compactly if the number of digits of fractional seconds is between 0 - 3.
static SqlTimestamp	readTimestampFieldFromSegments(MemorySegment[] segments, int baseOffset, long offsetAndNanos) Obtains an instance of SqlTimestamp from underlying MemorySegment.
java.time.Instant	toInstant() Convert this SqlTimestamp object to a Instant.
java.time.LocalDateTime	toLocalDateTime() Convert this SqlTimestamp object to a LocalDateTime.
String	toString()
Timestamp	toTimestamp() Convert this SqlTimestmap object to a Timestamp.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

compareTo

public int compareTo(SqlTimestamp that)

Specified by:

compareTo in interface Comparable<SqlTimestamp>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getMillisecond

public long getMillisecond()

getNanoOfMillisecond

public int getNanoOfMillisecond()

fromEpochMillis

public static SqlTimestamp fromEpochMillis(long millisecond)

Obtains an instance of SqlTimestamp from a millisecond.

This returns a SqlTimestamp with the specified millisecond. The nanoOfMillisecond field will be set to zero.

Parameters:

millisecond - the number of milliseconds since January 1, 1970, 00:00:00 GMT A negative number is the number of milliseconds before January 1, 1970, 00:00:00 GMT

Returns:

an instance of SqlTimestamp

fromEpochMillis

public static SqlTimestamp fromEpochMillis(long millisecond,
                                           int nanoOfMillisecond)

Obtains an instance of SqlTimestamp from a millisecond and a nanoOfMillisecond.

This returns a SqlTimestamp with the specified millisecond and nanoOfMillisecond.

Parameters:

millisecond - the number of milliseconds since January 1, 1970, 00:00:00 GMT A negative number is the number of milliseconds before January 1, 1970, 00:00:00 GMT

nanoOfMillisecond - the nanosecond within the millisecond, from 0 to 999,999

Returns:

an instance of SqlTimestamp

toTimestamp

public Timestamp toTimestamp()

Convert this SqlTimestmap object to a Timestamp.

Returns:

An instance of Timestamp

fromTimestamp

public static SqlTimestamp fromTimestamp(Timestamp ts)

Obtains an instance of SqlTimestamp from an instance of Timestamp.

This returns a SqlTimestamp with the specified Timestamp.

Parameters:

ts - an instance of Timestamp

Returns:

an instance of SqlTimestamp

toLocalDateTime

public java.time.LocalDateTime toLocalDateTime()

Convert this SqlTimestamp object to a LocalDateTime.

Returns:

An instance of LocalDateTime

fromLocalDateTime

public static SqlTimestamp fromLocalDateTime(java.time.LocalDateTime dateTime)

Obtains an instance of SqlTimestamp from an instance of LocalDateTime.

This returns a SqlTimestamp with the specified LocalDateTime.

Parameters:

dateTime - an instance of LocalDateTime

Returns:

an instance of SqlTimestamp

toInstant

public java.time.Instant toInstant()

Convert this SqlTimestamp object to a Instant.

Returns:

an instance of Instant

fromInstant

public static SqlTimestamp fromInstant(java.time.Instant instant)

Obtains an instance of SqlTimestamp from an instance of Instant.

This returns a SqlTimestmap with the specified Instant.

Parameters:

instant - an instance of Instant

Returns:

an instance of SqlTimestamp

isCompact

public static boolean isCompact(int precision)

Apache Calcite and Flink's planner use the number of milliseconds since epoch to represent a Timestamp type compactly if the number of digits of fractional seconds is between 0 - 3.

Parameters:

precision - the number of digits of fractional seconds

Returns:

true if precision is less than or equal to 3, false otherwise

readTimestampFieldFromSegments

public static SqlTimestamp readTimestampFieldFromSegments(MemorySegment[] segments,
                                                          int baseOffset,
                                                          long offsetAndNanos)

Obtains an instance of SqlTimestamp from underlying MemorySegment.

Parameters:

segments - the underlying MemorySegments

baseOffset - the base offset of current instance of SqlTimestamp

offsetAndNanos - the offset of millseconds part and nanoseconds

Returns:

an instance of SqlTimestamp