org.apache.flink.table.factories

Interface FileSystemFormatFactory.ReaderContext

Enclosing interface:

FileSystemFormatFactory

public static interface FileSystemFormatFactory.ReaderContext

Context of FileSystemFormatFactory.createReader(org.apache.flink.table.factories.FileSystemFormatFactory.ReaderContext).

Method Summary

Modifier and Type	Method and Description
String	getDefaultPartName() The default partition name in case the dynamic partition column value is null/empty string.
default String[]	getFormatFieldNames() Get field names without partition keys.
default DataType[]	getFormatFieldTypes() Get field types without partition keys.
ReadableConfig	getFormatOptions() Options of this format.
default List<String>	getFormatProjectFields() Mapping from non-partition project fields index to all project fields index.
default RowType	getFormatRowType() RowType of table that excludes partition key fields.
List<String>	getPartitionKeys() Partition keys of the table.
Path[]	getPaths() Read paths.
int[]	getProjectFields() Project the fields of the reader returned.
List<ResolvedExpression>	getPushedDownFilters() Pushed down filters, reader can try its best to filter records.
long	getPushedDownLimit() Limiting push-down to reader.
TableSchema	getSchema() Full schema of the table.

Method Detail

getSchema

TableSchema getSchema()

Full schema of the table.

getFormatOptions

ReadableConfig getFormatOptions()

Options of this format.

getPartitionKeys

List<String> getPartitionKeys()

Partition keys of the table.

getDefaultPartName

String getDefaultPartName()

The default partition name in case the dynamic partition column value is null/empty string.

getPaths

Path[] getPaths()

Read paths.

getProjectFields

int[] getProjectFields()

Project the fields of the reader returned.

getPushedDownLimit

long getPushedDownLimit()

Limiting push-down to reader. Reader only needs to try its best to limit the number of output records, but does not need to guarantee that the number must be less than or equal to the limit.

getPushedDownFilters

List<ResolvedExpression> getPushedDownFilters()

Pushed down filters, reader can try its best to filter records. The follow up operator will filter the records again.

getFormatFieldNames

default String[] getFormatFieldNames()

Get field names without partition keys.

getFormatFieldTypes

default DataType[] getFormatFieldTypes()

Get field types without partition keys.

getFormatRowType

default RowType getFormatRowType()

RowType of table that excludes partition key fields.

getFormatProjectFields

default List<String> getFormatProjectFields()

Mapping from non-partition project fields index to all project fields index.