Uses of Class
org.apache.flink.table.types.DataType

Packages that use DataType

Package	Description
org.apache.flink.table.api
org.apache.flink.table.api.dataview
org.apache.flink.table.api.internal
org.apache.flink.table.catalog
org.apache.flink.table.connector.sink
org.apache.flink.table.connector.source
org.apache.flink.table.expressions
org.apache.flink.table.functions
org.apache.flink.table.types
org.apache.flink.table.types.inference
org.apache.flink.types

Uses of DataType in org.apache.flink.table.api

Methods in org.apache.flink.table.api that return DataType

Modifier and Type	Method	Description
static DataType	DataTypes.ARRAY(DataType elementDataType)	Data type of an array of elements with same subtype.
static DataType	DataTypes.BIGINT()	Data type of an 8-byte signed integer with values from -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807.
static DataType	DataTypes.BINARY(int n)	Data type of a fixed-length binary string (=a sequence of bytes) BINARY(n) where n is the number of bytes.
static DataType	DataTypes.BITMAP()	Data type of bitmap data.
static DataType	DataTypes.BOOLEAN()	Data type of a boolean with a (possibly) three-valued logic of TRUE, FALSE, UNKNOWN.
static DataType	DataTypes.BYTES()	Data type of a variable-length binary string (=a sequence of bytes) with defined maximum length.
static DataType	DataTypes.CHAR(int n)	Data type of a fixed-length character string CHAR(n) where n is the number of code points.
static DataType	DataTypes.DATE()	Data type of a date consisting of year-month-day with values ranging from 0000-01-01 to 9999-12-31.
static DataType	DataTypes.DECIMAL(int precision, int scale)	Data type of a decimal number with fixed precision and scale DECIMAL(p, s) where p is the number of digits in a number (=precision) and s is the number of digits to the right of the decimal point in a number (=scale).
static DataType	DataTypes.DESCRIPTOR()	Data type for describing an arbitrary, unvalidated list of columns.
static DataType	DataTypes.DOUBLE()	Data type of an 8-byte double precision floating point number.
static DataType	DataTypes.FLOAT()	Data type of a 4-byte single precision floating point number.
DataType	DataTypes.Field.getDataType()
static DataType	DataTypes.INT()	Data type of a 4-byte signed integer with values from -2,147,483,648 to 2,147,483,647.
static DataType	DataTypes.INTERVAL(DataTypes.Resolution resolution)	Data type of a temporal interval.
static DataType	DataTypes.INTERVAL(DataTypes.Resolution upperResolution, DataTypes.Resolution lowerResolution)	Data type of a temporal interval.
static DataType	DataTypes.MAP(DataType keyDataType, DataType valueDataType)	Data type of an associative array that maps keys (including NULL) to values (including NULL).
static DataType	DataTypes.MULTISET(DataType elementDataType)	Data type of a multiset (=bag).
static DataType	DataTypes.NULL()	Data type for representing untyped NULL values.
static DataType	DataTypes.of(LogicalType logicalType)	Creates a DataType from a LogicalType with default conversion class.
static <T> DataType	DataTypes.RAW(Class<T> clazz, org.apache.flink.api.common.typeutils.TypeSerializer<T> serializer)	Data type of an arbitrary serialized type.
static DataType	DataTypes.ROW()	Data type of a row type with no fields.
static DataType	DataTypes.ROW(List<DataTypes.Field> fields)
static DataType	DataTypes.ROW(DataTypes.Field... fields)	Data type of a sequence of fields.
static DataType	DataTypes.ROW(DataType... fieldDataTypes)	Data type of a sequence of fields.
static DataType	DataTypes.SMALLINT()	Data type of a 2-byte signed integer with values from -32,768 to 32,767.
static DataType	DataTypes.STRING()	Data type of a variable-length character string with defined maximum length.
static DataType	DataTypes.STRUCTURED(Class<?> implementationClass, DataTypes.Field... fields)	Data type of a user-defined object structured type.
static DataType	DataTypes.STRUCTURED(String className, DataTypes.Field... fields)	Data type of a user-defined object structured type where the given class name is not in the classpath.
static DataType	DataTypes.TIME()	Data type of a time WITHOUT time zone TIME with no fractional seconds by default.
static DataType	DataTypes.TIME(int precision)	Data type of a time WITHOUT time zone TIME(p) where p is the number of digits of fractional seconds (=precision).
static DataType	DataTypes.TIMESTAMP()	Data type of a timestamp WITHOUT time zone TIMESTAMP with 6 digits of fractional seconds by default.
static DataType	DataTypes.TIMESTAMP(int precision)	Data type of a timestamp WITHOUT time zone TIMESTAMP(p) where p is the number of digits of fractional seconds (=precision).
static DataType	DataTypes.TIMESTAMP_LTZ()	Data type of a timestamp WITH LOCAL time zone.
static DataType	DataTypes.TIMESTAMP_LTZ(int precision)	Data type of a timestamp WITH LOCAL time zone.
static DataType	DataTypes.TIMESTAMP_WITH_LOCAL_TIME_ZONE()	Data type of a timestamp WITH LOCAL time zone TIMESTAMP WITH LOCAL TIME ZONE with 6 digits of fractional seconds by default.
static DataType	DataTypes.TIMESTAMP_WITH_LOCAL_TIME_ZONE(int precision)	Data type of a timestamp WITH LOCAL time zone TIMESTAMP(p) WITH LOCAL TIME ZONE where p is the number of digits of fractional seconds (=precision).
static DataType	DataTypes.TIMESTAMP_WITH_TIME_ZONE()	Data type of a timestamp WITH time zone TIMESTAMP WITH TIME ZONE with 6 digits of fractional seconds by default.
static DataType	DataTypes.TIMESTAMP_WITH_TIME_ZONE(int precision)	Data type of a timestamp WITH time zone TIMESTAMP(p) WITH TIME ZONE where p is the number of digits of fractional seconds (=precision).
static DataType	DataTypes.TINYINT()	Data type of a 1-byte signed integer with values from -128 to 127.
static DataType	DataTypes.VARBINARY(int n)	Data type of a variable-length binary string (=a sequence of bytes) VARBINARY(n) where n is the maximum number of bytes.
static DataType	DataTypes.VARCHAR(int n)	Data type of a variable-length character string VARCHAR(n) where n is the maximum number of code points.
static DataType	DataTypes.VARIANT()	Data type of semi-structured data.

Methods in org.apache.flink.table.api with parameters of type DataType

Modifier and Type	Method	Description
static DataType	DataTypes.ARRAY(DataType elementDataType)	Data type of an array of elements with same subtype.
static DataTypes.Field	DataTypes.FIELD(String name, DataType dataType)	Field definition with field name and data type.
static DataTypes.Field	DataTypes.FIELD(String name, DataType dataType, String description)	Field definition with field name, data type, and a description.
Schema.Builder	Schema.Builder.fromRowDataType(DataType dataType)	Adopts all fields of the given row as physical columns of the schema.
static ApiExpression	Expressions.lit(Object v, DataType dataType)	Creates a literal (i.e. a constant value) of a given DataType.
static DataType	DataTypes.MAP(DataType keyDataType, DataType valueDataType)	Data type of an associative array that maps keys (including NULL) to values (including NULL).
static DataType	DataTypes.MULTISET(DataType elementDataType)	Data type of a multiset (=bag).
static ApiExpression	Expressions.nullOf(DataType dataType)	Returns a null literal value of a given data type.
static DataType	DataTypes.ROW(DataType... fieldDataTypes)	Data type of a sequence of fields.

Uses of DataType in org.apache.flink.table.api.dataview

Methods in org.apache.flink.table.api.dataview that return DataType

Modifier and Type	Method	Description
static DataType	ListView.newListViewDataType(DataType elementDataType)	Utility method for creating a DataType of ListView explicitly.
static DataType	MapView.newMapViewDataType(DataType keyDataType, DataType valueDataType)	Utility method for creating a DataType of MapView explicitly.

Methods in org.apache.flink.table.api.dataview with parameters of type DataType

Modifier and Type	Method	Description
static DataType	ListView.newListViewDataType(DataType elementDataType)	Utility method for creating a DataType of ListView explicitly.
static DataType	MapView.newMapViewDataType(DataType keyDataType, DataType valueDataType)	Utility method for creating a DataType of MapView explicitly.

Uses of DataType in org.apache.flink.table.api.internal

Methods in org.apache.flink.table.api.internal with parameters of type DataType

Modifier and Type	Method	Description
OutType	BaseExpressions.cast(DataType toType)	Returns a new value being cast to toType.
OutType	BaseExpressions.jsonQuery(String path, DataType returnType)	Extracts JSON values from a JSON string.
OutType	BaseExpressions.jsonQuery(String path, DataType returnType, JsonQueryWrapper wrappingBehavior)	Extracts JSON values from a JSON string.
OutType	BaseExpressions.jsonQuery(String path, DataType returnType, JsonQueryWrapper wrappingBehavior, JsonQueryOnEmptyOrError onEmpty, JsonQueryOnEmptyOrError onError)	Extracts JSON values from a JSON string.
OutType	BaseExpressions.jsonValue(String path, DataType returningType)	Extracts a scalar from a JSON string.
OutType	BaseExpressions.jsonValue(String path, DataType returningType, InType defaultOnEmptyOrError)	Extracts a scalar from a JSON string.
OutType	BaseExpressions.jsonValue(String path, DataType returningType, JsonValueOnEmptyOrError onEmpty, InType defaultOnEmpty, JsonValueOnEmptyOrError onError, InType defaultOnError)	Extracts a scalar from a JSON string.
OutType	BaseExpressions.tryCast(DataType toType)	Like BaseExpressions.cast(DataType), but in case of error, returns null rather than failing the job.

Uses of DataType in org.apache.flink.table.catalog

Methods in org.apache.flink.table.catalog that return DataType

Modifier and Type	Method	Description
<T> DataType	DataTypeFactory.createDataType(Class<T> clazz)	Creates a type by analyzing the given class.
DataType	DataTypeFactory.createDataType(String typeString)	Creates a type by a fully or partially defined name.
<T> DataType	DataTypeFactory.createDataType(TypeInformation<T> typeInfo)	Creates a type for the given TypeInformation.
DataType	DataTypeFactory.createDataType(org.apache.flink.table.catalog.UnresolvedIdentifier identifier)	Creates a type by a fully or partially defined identifier.
DataType	DataTypeFactory.createDataType(AbstractDataType<?> abstractDataType)	Creates a type out of an AbstractDataType.
<T> DataType	DataTypeFactory.createRawDataType(Class<T> clazz)	Creates a RAW type for the given class in cases where no serializer is known and a generic serializer should be used.
<T> DataType	DataTypeFactory.createRawDataType(TypeInformation<T> typeInfo)	Creates a RAW type for the given TypeInformation.
DataType	ResolvedSchema.toPhysicalRowDataType()	Converts all physical columns of this schema into a (possibly nested) row data type.
DataType	ResolvedSchema.toSinkRowDataType()	Converts all persisted columns of this schema into a (possibly nested) row data type.
DataType	ResolvedSchema.toSourceRowDataType()	Converts all columns of this schema into a (possibly nested) row data type.

Methods in org.apache.flink.table.catalog that return types with arguments of type DataType

Modifier and Type	Method	Description
List<DataType>	ResolvedSchema.getColumnDataTypes()	Returns all column data types.

Methods in org.apache.flink.table.catalog with parameters of type DataType

Modifier and Type	Method	Description
static ResolvedSchema	ResolvedSchema.physical(String[] columnNames, DataType[] columnDataTypes)	Shortcut for a resolved schema of only physical columns.

Uses of DataType in org.apache.flink.table.connector.sink

Methods in org.apache.flink.table.connector.sink with parameters of type DataType

Modifier and Type	Method	Description
DynamicTableSink.DataStructureConverter	DynamicTableSink.Context.createDataStructureConverter(DataType consumedDataType)	Creates a converter for mapping between Flink's internal data structures and objects specified by the given DataType that can be passed into a runtime implementation.
<T> TypeInformation<T>	DynamicTableSink.Context.createTypeInformation(DataType consumedDataType)	Creates type information describing the internal data structures of the given DataType.

Uses of DataType in org.apache.flink.table.connector.source

Methods in org.apache.flink.table.connector.source with parameters of type DataType

Modifier and Type	Method	Description
DynamicTableSource.DataStructureConverter	DynamicTableSource.Context.createDataStructureConverter(DataType producedDataType)	Creates a converter for mapping between objects specified by the given DataType and Flink's internal data structures that can be passed into a runtime implementation.
<T> TypeInformation<T>	DynamicTableSource.Context.createTypeInformation(DataType producedDataType)	Creates type information describing the internal data structures of the given DataType.

Uses of DataType in org.apache.flink.table.expressions

Methods in org.apache.flink.table.expressions that return DataType

Modifier and Type	Method	Description
DataType	ResolvedExpression.getOutputDataType()	Returns the data type of the computation result.

Uses of DataType in org.apache.flink.table.functions

Methods in org.apache.flink.table.functions that return DataType

Modifier and Type	Method	Description
DataType	TableSemantics.dataType()	Data type of the passed table.

Uses of DataType in org.apache.flink.table.types

Subclasses of DataType in org.apache.flink.table.types

Modifier and Type	Class	Description
final class	FieldsDataType	A data type that contains field data types (i.e. row and structured type).

Methods in org.apache.flink.table.types that return DataType

Modifier and Type	Method	Description
DataType	FieldsDataType.bridgedTo(Class<?> newConversionClass)
DataType	FieldsDataType.notNull()
DataType	FieldsDataType.nullable()
DataType	UnresolvedDataType.toDataType(DataTypeFactory factory)	Converts this instance to a resolved DataType possibly enriched with additional nullability and conversion class information.
DataType	DataType.toInternal()	Creates a copy of this DataType instance with the internal data type conversion classes.

Methods in org.apache.flink.table.types that return types with arguments of type DataType

Modifier and Type	Method	Description
abstract List<DataType>	DataType.getChildren()	Returns the children of this data type, if any.
List<DataType>	FieldsDataType.getChildren()
static List<DataType>	DataType.getFieldDataTypes(DataType dataType)	Returns the first-level field data types for the provided DataType.

Methods in org.apache.flink.table.types with parameters of type DataType

Modifier and Type	Method	Description
static int	DataType.getFieldCount(DataType dataType)	Returns the count of the first-level fields for the provided DataType.
static List<DataType>	DataType.getFieldDataTypes(DataType dataType)	Returns the first-level field data types for the provided DataType.
static List<String>	DataType.getFieldNames(DataType dataType)	Returns the first-level field names for the provided DataType.
static List<DataTypes.Field>	DataType.getFields(DataType dataType)	Returns an ordered list of fields starting from the provided DataType.

Constructor parameters in org.apache.flink.table.types with type arguments of type DataType

Modifier	Constructor	Description
	FieldsDataType(LogicalType logicalType, Class<?> conversionClass, List<DataType> fieldDataTypes)
	FieldsDataType(LogicalType logicalType, List<DataType> fieldDataTypes)
	UnresolvedDataType(Supplier<String> description, Function<DataTypeFactory,DataType> resolutionFactory)

Uses of DataType in org.apache.flink.table.types.inference

Methods in org.apache.flink.table.types.inference that return types with arguments of type DataType

Modifier and Type	Method	Description
Optional<DataType>	StaticArgument.getDataType()
Optional<List<DataType>>	TypeInference.getTypedArguments()	Deprecated. Use TypeInference.getStaticArguments() instead.
Optional<DataType>	TypeStrategy.inferType(org.apache.flink.table.types.inference.CallContext callContext)	Infers a type from the given function call.

Methods in org.apache.flink.table.types.inference with parameters of type DataType

Modifier and Type	Method	Description
static StaticArgument	StaticArgument.scalar(String name, DataType dataType, boolean isOptional)	Declares a scalar argument such as f(12) or f(otherColumn).
static StaticArgument	StaticArgument.table(String name, DataType dataType, boolean isOptional, EnumSet<StaticArgumentTrait> traits)	Declares a table argument such as f(t => myTable) or f(t => TABLE myTable)).
TypeInference.Builder	TypeInference.Builder.typedArguments(DataType... argumentTypes)	Deprecated. Use TypeInference.Builder.staticArguments(StaticArgument...) instead.

Method parameters in org.apache.flink.table.types.inference with type arguments of type DataType

Modifier and Type	Method	Description
TypeInference.Builder	TypeInference.Builder.typedArguments(List<DataType> argumentTypes)	Deprecated. Use TypeInference.Builder.staticArguments(List) instead.

Uses of DataType in org.apache.flink.types

Methods in org.apache.flink.types that return types with arguments of type DataType

Modifier and Type	Method	Description
List<DataType>	ColumnList.getDataTypes()	Returns a list of data types (if available).