.. ################################################################################
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
    limitations under the License.
   ################################################################################

=======
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
--------------------

.. currentmodule:: pyflink.dataframe

.. autosummary::
    :toctree: api/

    create_catalog
    use_catalog
    get_current_catalog
    list_catalogs
    use_database
    get_current_database
    list_databases

Catalog I/O
-----------

.. currentmodule:: pyflink.dataframe

.. autosummary::
    :toctree: api/

    read_catalog_table
    DataFrame.write_catalog_table