Catalog

Functions to register and navigate catalogs and databases used by the DataFrame API, and to read from or write to catalog tables.

Example:

>>> import pyflink.dataframe as pf
>>> pf.create_catalog("my-fluss", {
...     "type": "fluss",
...     "bootstrap.servers": "localhost:9123",
...     "client.security.protocol": "SASL",
...     "client.security.sasl.mechanism": "PLAIN",
...     "client.security.sasl.username": "*****",
...     "client.security.sasl.password": "*****",
... })
>>> df = pf.read_catalog_table("my-fluss.my_database.my_table")

Catalog and Database

create_catalog(name, options)	Create a catalog in the DataFrame default TableEnvironment.
use_catalog(name)	Set the current catalog for DataFrame operations.
get_current_catalog()	Get the current catalog used by DataFrame operations.
list_catalogs()	List catalogs in the DataFrame default TableEnvironment.
use_database(name)	Set the current database for DataFrame operations.
get_current_database()	Get the current database used by DataFrame operations.
list_databases()	List databases in the current catalog.

Catalog I/O

read_catalog_table(path)	Read a catalog table into a DataFrame.
DataFrame.write_catalog_table(path, *[, ...])	Write the DataFrame to a catalog table.