Skip to content

Commit b01c065

Browse files
committed
docs(metadata): clarify table catalog semantics
Signed-off-by: Vu Anh Phung <vu.phung@databricks.com>
1 parent 0f8a432 commit b01c065

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

src/databricks/sql/backend/databricks_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -292,9 +292,9 @@ def get_tables(
292292
max_rows: Maximum number of rows to fetch in a single batch
293293
max_bytes: Maximum number of bytes to fetch in a single batch
294294
cursor: The cursor object that will handle the results
295-
catalog_name: Optional catalog name pattern to filter by
296-
if catalog_name is None, we fetch across all catalogs; an empty
297-
string matches nothing
295+
catalog_name: Optional exact catalog name. ``None`` leaves the
296+
filter unset; ``%`` and ``*`` select all catalogs; an empty
297+
string is preserved.
298298
schema_name: Optional schema name pattern to filter by
299299
if schema_name is None, we fetch across all schemas; an empty
300300
string matches nothing

src/databricks/sql/client.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1668,8 +1668,9 @@ def tables(
16681668
"""
16691669
Get tables corresponding to the catalog_name, schema_name and table_name.
16701670
1671-
Empty strings are preserved; ``None`` leaves a filter unset. Names are
1672-
patterns, can contain % wildcards, and empty patterns match nothing.
1671+
Empty strings are preserved; ``None`` leaves a filter unset.
1672+
``catalog_name`` is exact except that % and * select all catalogs.
1673+
``schema_name`` and ``table_name`` are patterns; empty patterns match nothing.
16731674
:returns self
16741675
"""
16751676
self._check_not_closed()

0 commit comments

Comments
 (0)