Ctrl+K
Logo image Logo image

Site Navigation

  • API Reference
  • Examples

Site Navigation

  • API Reference
  • Examples

Section Navigation

  • PyFlink Table
  • PyFlink DataFrame
    • DataFrame
    • DataFrame Creation
    • Input/Output
    • SQL
    • Data Types
    • User Defined Functions
    • Configuration
    • Catalog
    • GPU Support
    • AI / LLM
  • PyFlink Multimodal
  • PyFlink DataStream
  • PyFlink Common

pyflink.dataframe.DataFrame.write_catalog_table#

DataFrame.write_catalog_table(path: str, *, overwrite: bool = False) → None[source]#

Write the DataFrame to a catalog table.

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

  • overwrite – Whether to overwrite the target table.

Note

Call create_catalog() before writing a catalog table.

Example:

>>> import pyflink.dataframe as pf
>>> df = pf.from_records([(1, "apple")], schema=["id", "name"])
>>> pf.create_catalog("my_fluss", {
...     "type": "fluss",
...     "bootstrap.servers": "localhost:9123",
... })
>>> df.write_catalog_table("my_fluss.my_database.my_table")
>>> pf.use_catalog("my_fluss")
>>> df.write_catalog_table("my_database.my_table")
>>> pf.use_database("my_database")
>>> df.write_catalog_table("my_table", overwrite=True)

previous

pyflink.dataframe.read_custom

next

pyflink.dataframe.DataFrame.write_parquet

Show Source

Created using Sphinx 4.5.0.