pyspark.sql.Catalog.listCatalogs#

Catalog.listCatalogs(pattern=None)[source]#

Returns a list of catalogs available in this session.

With pattern, returns only catalogs whose name matches that pattern.

Added in version 3.4.0.

Parameters:
patternstr, optional

Pattern that catalog names must match.

Added in version 3.5.0.

Returns:
list

A list of CatalogMetadata.

Examples

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