pyflink.datastream.formats.csv.CsvReaderFormat

class CsvReaderFormat(j_csv_format)

The StreamFormat for reading csv files.

Example:

>>> schema = CsvSchema.builder() \
...     .add_number_column('id', number_type=DataTypes.INT()) \
...     .add_string_column('name') \
...     .add_array_column('list', ',', element_type=DataTypes.STRING()) \
...     .set_column_separator('|') \
...     .set_escape_char('\\') \
...     .set_use_header() \
...     .set_strict_headers() \
...     .build()
>>> source = FileSource.for_record_stream_format(
...     CsvReaderFormat.for_schema(schema), CSV_FILE_PATH).build()
>>> ds = env.from_source(source, WatermarkStrategy.no_watermarks(), 'csv-source')
>>> # the type of records is Types.ROW_NAMED(['id', 'name', 'list'],
>>> #   [Types.INT(), Types.STRING(), Types.LIST(Types.STRING())])

Added in version 1.16.0.

Methods

for_schema(schema)	Builds a CsvReaderFormat using CsvSchema.
text_line_format([charset_name])	Creates a reader format that text lines from a file.