pyflink.dataframe.read_catalog_table

read_catalog_table(path: str) → pyflink.dataframe.dataframe.DataFrame

Read a catalog table into a DataFrame.

Parameters

path – Table path. Use table_name, db_name.table_name, or catalog_name.db_name.table_name.

Returns

A new DataFrame.

Note

Call create_catalog() before reading a catalog table.

Example:

>>> import pyflink.dataframe as pf
>>> pf.create_catalog("my_fluss", {
...     "type": "fluss",
...     "bootstrap.servers": "localhost:9123",
... })
>>> df = pf.read_catalog_table("my_fluss.my_database.my_table")
>>> pf.use_catalog("my_fluss")
>>> df = pf.read_catalog_table("my_database.my_table")
>>> pf.use_database("my_database")
>>> df = pf.read_catalog_table("my_table")