org.wikimedia.eventutilities.flink.formats.json

Class DataTypeSchemaConversions

java.lang.Object

org.wikimedia.eventutilities.flink.formats.json.DataTypeSchemaConversions

All Implemented Interfaces:

SchemaConversions<org.apache.flink.table.types.DataType>

@ParametersAreNonnullByDefault
public class DataTypeSchemaConversions
extends Object
implements SchemaConversions<org.apache.flink.table.types.DataType>

Implementation of SchemaConversions that can convert to Flink Table API DataType. Used by JsonSchemaFlinkConverter. If you modify this class, please also augment TypeInformationSchemaConversions accordingly. To handle proper conversion between Table API and DataStream, Flink needs the types consistently converted to the same underlying representations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.wikimedia.eventutilities.core.event.types.SchemaConversions

SchemaConversions.RowField<T>

Constructor Summary

Constructors

Constructor and Description
DataTypeSchemaConversions()

Method Summary

Modifier and Type	Method and Description
protected org.apache.flink.table.api.DataTypes.Field	buildFieldDataType(String name, org.apache.flink.table.types.DataType dataType, String description) Helper for constructing a DataTypes.Field with name, DataType, and optional description.
org.apache.flink.table.types.DataType	typeArray(org.apache.flink.table.types.DataType elementType, boolean elementsAreNullable) elementsAreNullable is ignored; all Flink Table API elements are nullable.
org.apache.flink.table.types.DataType	typeBoolean()
org.apache.flink.table.types.DataType	typeDecimal()
org.apache.flink.table.types.DataType	typeInteger() Note that the default conversion of LogicalType BigIntType is Long, which is NOT the same as Flink Types.BIG_INT (in the DataStream API).
org.apache.flink.table.types.DataType	typeMap(org.apache.flink.table.types.DataType keyType, org.apache.flink.table.types.DataType valueType, boolean valuesAreNullable) valuesAreNullable is ignored; all Flink Table API elements are nullable.
org.apache.flink.table.types.DataType	typeNull()
org.apache.flink.table.types.DataType	typeRow(List<SchemaConversions.RowField<org.apache.flink.table.types.DataType>> rowFields) If a RowFields description is not null, it will be used as the DataTypes.Field's description.
org.apache.flink.table.types.DataType	typeString()
org.apache.flink.table.types.DataType	typeTimestamp()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTypeSchemaConversions

public DataTypeSchemaConversions()

Method Detail

typeNull

public org.apache.flink.table.types.DataType typeNull()

Specified by:

typeNull in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.NULL()

typeBoolean

public org.apache.flink.table.types.DataType typeBoolean()

Specified by:

typeBoolean in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.BOOLEAN()

typeString

public org.apache.flink.table.types.DataType typeString()

Specified by:

typeString in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.STRING()

typeDecimal

public org.apache.flink.table.types.DataType typeDecimal()

Specified by:

typeDecimal in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.DOUBLE()

typeInteger

public org.apache.flink.table.types.DataType typeInteger()

Note that the default conversion of LogicalType BigIntType is Long, which is NOT the same as Flink Types.BIG_INT (in the DataStream API).

Specified by:

typeInteger in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.BIGINT()

typeTimestamp

public org.apache.flink.table.types.DataType typeTimestamp()

Specified by:

typeTimestamp in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.TIMESTAMP_LTZ(int) with precision 3

typeArray

public org.apache.flink.table.types.DataType typeArray(org.apache.flink.table.types.DataType elementType,
                                                       boolean elementsAreNullable)

elementsAreNullable is ignored; all Flink Table API elements are nullable.

Specified by:

typeArray in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.ARRAY(org.apache.flink.table.types.DataType)

typeMap

public org.apache.flink.table.types.DataType typeMap(org.apache.flink.table.types.DataType keyType,
                                                     org.apache.flink.table.types.DataType valueType,
                                                     boolean valuesAreNullable)

valuesAreNullable is ignored; all Flink Table API elements are nullable.

Specified by:

typeMap in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.MAP(org.apache.flink.table.types.DataType, org.apache.flink.table.types.DataType)

typeRow

public org.apache.flink.table.types.DataType typeRow(List<SchemaConversions.RowField<org.apache.flink.table.types.DataType>> rowFields)

If a RowFields description is not null, it will be used as the DataTypes.Field's description. RowField nullalble-ness is not relevant; all Flink Table API fields are nullable.

Specified by:

typeRow in interface SchemaConversions<org.apache.flink.table.types.DataType>

Returns:

DataTypes.ROW(org.apache.flink.table.api.DataTypes.Field...)

buildFieldDataType

@Nonnull
protected org.apache.flink.table.api.DataTypes.Field buildFieldDataType(String name,
                                                                                 org.apache.flink.table.types.DataType dataType,
                                                                                 @Nullable
                                                                                 String description)

Helper for constructing a DataTypes.Field with name, DataType, and optional description.