Skip to main content

listCatalogs

Returns a list of catalogs in this session.

Syntax

listCatalogs(pattern: str = None)

Parameters

Parameter

Type

Description

pattern

str, optional

The pattern that the catalog name needs to match.

Returns

list of CatalogMetadata

Examples

Python
spark.catalog.listCatalogs()
# [CatalogMetadata(name='spark_catalog', description=None)]

spark.catalog.listCatalogs("spark*")
# [CatalogMetadata(name='spark_catalog', description=None)]

spark.catalog.listCatalogs("hive*")
# []