LocalZonedTimestampType (Flink : 1.20-SNAPSHOT API)

java.lang.Object
- org.apache.flink.table.types.logical.LogicalType
- - org.apache.flink.table.types.logical.LocalZonedTimestampType

All Implemented Interfaces:

Serializable
```
@PublicEvolving
public final class LocalZonedTimestampType
extends LogicalType
```
Logical type of a timestamp WITH LOCAL time zone consisting of year-month-day hour:minute:second[.fractional] zone with up to nanosecond precision and values ranging from 0000-01-01 00:00:00.000000000 +14:59 to 9999-12-31 23:59:59.999999999 -14:59. Leap seconds (23:59:60 and 23:59:61) are not supported as the semantics are closer to OffsetDateTime.
The serialized string representation is TIMESTAMP(p) WITH LOCAL TIME ZONE where p is the number of digits of fractional seconds (=precision). p must have a value between 0 and 9 (both inclusive). If no precision is specified, p is equal to 6. TIMESTAMP_LTZ(p) is a synonym.
Compared to ZonedTimestampType, the time zone offset information is not stored physically in every datum. Instead, the type assumes Instant semantics in UTC time zone at the edges of the table ecosystem. Every datum is interpreted in the local time zone configured in the current session for computation and visualization.
This type fills the gap between time zone free and time zone mandatory timestamp types by allowing the interpretation of UTC timestamps according to the configured session time zone. A conversion from and to int describes the number of seconds since epoch. A conversion from and to long describes the number of milliseconds since epoch.

See Also:

TimestampType, ZonedTimestampType, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_PRECISION

static int MAX_PRECISION

static int MIN_PRECISION

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PRECISION`
`static int`	`MAX_PRECISION`
`static int`	`MIN_PRECISION`

Constructor Summary

Constructors
Constructor and Description
`LocalZonedTimestampType()`
`LocalZonedTimestampType(boolean isNullable, int precision)`
`LocalZonedTimestampType(boolean isNullable, TimestampKind kind, int precision)` Internal constructor that allows attaching additional metadata about time attribute properties.
`LocalZonedTimestampType(int precision)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<R> R`	`accept(LogicalTypeVisitor<R> visitor)`
`String`	`asSerializableString()` Returns a string that fully serializes this instance.
`String`	`asSummaryString()` Returns a string that summarizes this type for printing to a console.
`LogicalType`	`copy(boolean isNullable)` Returns a deep copy of this type with possibly different nullability.
`boolean`	`equals(Object o)`
`List<LogicalType>`	`getChildren()`
`Class<?>`	`getDefaultConversion()` Returns the default conversion class.
`TimestampKind`	`getKind()`
`int`	`getPrecision()`
`int`	`hashCode()`
`boolean`	`supportsInputConversion(Class<?> clazz)` Returns whether an instance of the given class can be represented as a value of this logical type when entering the table ecosystem.
`boolean`	`supportsOutputConversion(Class<?> clazz)` Returns whether a value of this logical type can be represented as an instance of the given class when leaving the table ecosystem.

Methods inherited from class org.apache.flink.table.types.logical.LogicalType
conversionSet, copy, getTypeRoot, is, is, isAnyOf, isAnyOf, isNullable, toString, withNullability

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN_PRECISION
```
public static final int MIN_PRECISION
```
    See Also:
    
    Constant Field Values
  - MAX_PRECISION
```
public static final int MAX_PRECISION
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PRECISION
```
public static final int DEFAULT_PRECISION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LocalZonedTimestampType
```
@Internal
public LocalZonedTimestampType(boolean isNullable,
                                         TimestampKind kind,
                                         int precision)
```
    Internal constructor that allows attaching additional metadata about time attribute properties. The additional metadata does not affect equality or serializability.
    Use getKind() for comparing this metadata.
  - LocalZonedTimestampType
```
public LocalZonedTimestampType(boolean isNullable,
                               int precision)
```
  - LocalZonedTimestampType
```
public LocalZonedTimestampType(int precision)
```
  - LocalZonedTimestampType
```
public LocalZonedTimestampType()
```
- Method Detail
  - getKind
```
@Internal
public TimestampKind getKind()
```
  - getPrecision
```
public int getPrecision()
```
  - copy
```
public LogicalType copy(boolean isNullable)
```
    Description copied from class: LogicalType
    
    Returns a deep copy of this type with possibly different nullability.
    
    Specified by:
    
    copy in class LogicalType
    
    Parameters:
    
    isNullable - the intended nullability of the copied type
    
    Returns:
    
    a deep copy
  - asSerializableString
```
public String asSerializableString()
```
    Description copied from class: LogicalType
    
    Returns a string that fully serializes this instance. The serialized string can be used for transmitting or persisting a type.
    See LogicalTypeParser for the reverse operation.
    
    Specified by:
    
    asSerializableString in class LogicalType
    
    Returns:
    
    detailed string for transmission or persistence
  - asSummaryString
```
public String asSummaryString()
```
    Description copied from class: LogicalType
    
    Returns a string that summarizes this type for printing to a console. An implementation might shorten long names or skips very specific properties.
    Use LogicalType.asSerializableString() for a type string that fully serializes this instance.
    
    Overrides:
    
    asSummaryString in class LogicalType
    
    Returns:
    
    summary string of this type for debugging purposes
  - supportsInputConversion
```
public boolean supportsInputConversion(Class<?> clazz)
```
    Description copied from class: LogicalType
    
    Returns whether an instance of the given class can be represented as a value of this logical type when entering the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.
    A supported conversion directly maps an input class to a logical type without loss of precision or type widening.
    For example, java.lang.Long or long can be used as input for BIGINT independent of the set nullability.
    
    Specified by:
    
    supportsInputConversion in class LogicalType
    
    Parameters:
    
    clazz - input class to be converted into this logical type
    
    Returns:
    
    flag that indicates if instances of this class can be used as input into the table ecosystem
    
    See Also:
    
    LogicalType.getDefaultConversion()
  - supportsOutputConversion
```
public boolean supportsOutputConversion(Class<?> clazz)
```
    Description copied from class: LogicalType
    
    Returns whether a value of this logical type can be represented as an instance of the given class when leaving the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.
    A supported conversion directly maps a logical type to an output class without loss of precision or type widening.
    For example, java.lang.Long or long can be used as output for BIGINT if the type is not nullable. If the type is nullable, only java.lang.Long can represent this.
    
    Specified by:
    
    supportsOutputConversion in class LogicalType
    
    Parameters:
    
    clazz - output class to be converted from this logical type
    
    Returns:
    
    flag that indicates if instances of this class can be used as output from the table ecosystem
    
    See Also:
    
    LogicalType.getDefaultConversion()
  - getDefaultConversion
```
public Class<?> getDefaultConversion()
```
    Description copied from class: LogicalType
    
    Returns the default conversion class. A value of this logical type is expected to be an instance of the given class when entering or is represented as an instance of the given class when leaving the table ecosystem if no other conversion has been specified.
    For example, java.lang.Long is the default input and output for BIGINT.
    
    Specified by:
    
    getDefaultConversion in class LogicalType
    
    Returns:
    
    default class to represent values of this logical type
    
    See Also:
    
    LogicalType.supportsInputConversion(Class), LogicalType.supportsOutputConversion(Class)
  - getChildren
```
public List<LogicalType> getChildren()
```
    Specified by:
    
    getChildren in class LogicalType
  - accept
```
public <R> R accept(LogicalTypeVisitor<R> visitor)
```
    Specified by:
    
    accept in class LogicalType
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class LogicalType
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class LogicalType

Back to Flink Website

Class LocalZonedTimestampType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.flink.table.types.logical.LogicalType

Methods inherited from class java.lang.Object

Field Detail

MIN_PRECISION

MAX_PRECISION

DEFAULT_PRECISION

Constructor Detail

LocalZonedTimestampType

LocalZonedTimestampType

LocalZonedTimestampType

LocalZonedTimestampType

Method Detail

getKind

getPrecision

copy

asSerializableString

asSummaryString

supportsInputConversion

supportsOutputConversion

getDefaultConversion

getChildren

accept

equals

hashCode

Back to Flink Website