pyspark.sql.Catalog.listDatabases#

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

Returns a list of databases (namespaces) available within the current catalog.

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

Added in version 2.0.0.

Parameters:
patternstr, optional

Pattern that database names must match.

Added in version 3.5.0.

Returns:
list

A list of Database.

Examples

>>> spark.catalog.listDatabases()
[Database(name='default', catalog='spark_catalog', description='default database', ...
>>> spark.catalog.listDatabases("def*")
[Database(name='default', catalog='spark_catalog', description='default database', ...
>>> spark.catalog.listDatabases("def2*")
[]