Skip to content

featurebyte.Catalog.list_tables

list_tables(
include_id: Union[bool, NoneType]=True,
entity: Union[str, NoneType]=None
) -> DataFrame

Description

Returns a DataFrame that contains various attributes of the registered tables in the catalog, such as their names, types, statuses, creation dates, and associated entities.

The returned DataFrame can be filtered by the name of the entities associated with the tables.

Parameters

  • include_id: Union[bool, NoneType]
    default: True
    Whether to include id in the list.

  • entity: Union[str, NoneType]
    Name of entity used to filter results.

Returns

  • DataFrame
    Dataframe of tables

Examples

>>> tables = catalog.list_tables()