Input / Output

Functions to read data from external sources into a DataFrame and methods to write DataFrame results to external systems.

Readers

read_catalog_table(path)	Read a catalog table into a DataFrame.
read_parquet(path, *[, schema, ...])	Read a Parquet file or directory into a DataFrame.
read_json(path, *[, schema, ...])	Read JSON file(s) into a DataFrame.
read_video_frames(source[, video_column, ...])	Read video frames from video URI/path strings, glob patterns, or a video column.
read_kafka(bootstrap_servers, *[, schema, ...])	Read data from one or more Kafka topics into a DataFrame.
read_odps(endpoint, *[, schema, ...])	Read a MaxCompute (ODPS) table into a DataFrame.
read_paimon([path, schema, primary_key, ...])	Read a Paimon table into a DataFrame.
read_sls(endpoint, *, project, logstore[, ...])	Read an SLS (Aliyun Log Service) logstore into a DataFrame.
read_mns(endpoint, *[, schema, ...])	Read an MNS (Alibaba Cloud Message Service) queue into a DataFrame.
read_hologres(endpoint, *, db_name, ...[, ...])	Read a Hologres table into a DataFrame.
read_milvus(endpoint, *, schema[, ...])	Read a Milvus vector search source into a DataFrame.
read_generic(connector, *[, schema, ...])	Read data from a generic connector into a DataFrame.

Writers

DataFrame.write_catalog_table(path, *[, ...])	Write the DataFrame to a catalog table.
DataFrame.write_parquet(path, *[, mode, ...])	Write the DataFrame to Parquet file(s) at the given path.
DataFrame.write_json(path, *[, mode, ...])	Write the DataFrame to JSON file(s) at the given path.
DataFrame.write_kafka(bootstrap_servers, *)	Write the DataFrame to a Kafka topic.
DataFrame.write_odps(endpoint, *[, ...])	Write the DataFrame to a MaxCompute (ODPS) table.
DataFrame.write_paimon([path, primary_key, ...])	Write the DataFrame to a Paimon table.
DataFrame.write_sls(endpoint, *, project, ...)	Write the DataFrame to an SLS (Aliyun Log Service) logstore.
DataFrame.write_hologres(endpoint, *, ...[, ...])	Write the DataFrame to a Hologres table.
DataFrame.write_milvus(endpoint, *, ...[, ...])	Write the DataFrame to a Milvus collection.
DataFrame.write_generic(connector, *[, ...])	Write the DataFrame using a generic connector.

Statement Sets

Use create_statement_set if you want to output multiple DataFrames in a single job.

create_statement_set()

Create a StatementSet from the DataFrame default TableEnvironment.