Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(DB engine spec): get_catalog_names #23447

Merged
merged 2 commits into from
Mar 22, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions superset/db_engine_specs/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,14 @@ class BaseEngineSpec: # pylint: disable=too-many-public-methods
# a custom `adjust_engine_params` method.
supports_dynamic_schema = False

# Does the DB support catalogs? A catalog here is a group of schemas, and has
# different names depending on the DB: BigQuery calles it a "project", Postgres calls
# it a "database", Trino calls it a "catalog", etc.
supports_catalog = False

# Can the catalog be changed on a per-query basis?
supports_dynamic_catalog = False

@classmethod
def supports_url(cls, url: URL) -> bool:
"""
Expand Down Expand Up @@ -1091,6 +1099,20 @@ def patch(cls) -> None:
TODO: Improve docstring and refactor implementation in Hive
"""

@classmethod
def get_catalog_names( # pylint: disable=unused-argument
cls,
database: Database,
inspector: Inspector,
) -> List[str]:
"""
Get all catalogs from database.

This needs to be implemented per database, since SQLAlchemy doesn't offer an
abstraction.
"""
return []

@classmethod
def get_schema_names(cls, inspector: Inspector) -> List[str]:
"""
Expand Down
21 changes: 21 additions & 0 deletions superset/db_engine_specs/postgres.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
from flask_babel import gettext as __
from sqlalchemy.dialects.postgresql import DOUBLE_PRECISION, ENUM, JSON
from sqlalchemy.dialects.postgresql.base import PGInspector
from sqlalchemy.engine.reflection import Inspector
from sqlalchemy.engine.url import URL
from sqlalchemy.types import Date, DateTime, String

Expand Down Expand Up @@ -291,6 +292,26 @@ def query_cost_formatter(
) -> List[Dict[str, str]]:
return [{k: str(v) for k, v in row.items()} for row in raw_cost]

@classmethod
def get_catalog_names(
betodealmeida marked this conversation as resolved.
Show resolved Hide resolved
cls,
database: "Database",
inspector: Inspector,
) -> List[str]:
"""
Return all catalogs.

In Postgres, a catalog is called a "database".
"""
return sorted(
inspector.bind.execute(
"""
SELECT datname FROM pg_database
WHERE datistemplate = false;
"""
).fetchall()
)

@classmethod
def get_table_names(
cls, database: "Database", inspector: PGInspector, schema: Optional[str]
Expand Down