"""CockroachDB AsyncPG data dictionary."""
from collections.abc import Mapping, Sequence
from typing import TYPE_CHECKING, Any, ClassVar
from sqlspec.data_dictionary import (
ColumnMetadata,
DDLResult,
ForeignKeyMetadata,
IndexMetadata,
MetadataCapability,
MetadataCapabilityProfile,
MetadataFidelity,
MetadataResult,
MetadataRisk,
MetadataSource,
MetadataSupport,
ObjectIdentity,
SystemMetadataCapability,
SystemMetadataRequest,
SystemMetadataResult,
TableMetadata,
VersionInfo,
ensure_system_metadata_request,
get_data_dictionary_loader,
system_metadata_gated_result,
unsupported_system_metadata_capability,
)
from sqlspec.data_dictionary.dialects.cockroachdb import resolve_cockroachdb_json_type
from sqlspec.driver import AsyncDataDictionaryBase
if TYPE_CHECKING:
from sqlspec.adapters.cockroach_asyncpg.driver import CockroachAsyncpgDriver
from sqlspec.core import SQL
__all__ = ("CockroachAsyncpgDataDictionary",)
_COCKROACH_METADATA_DOMAINS = (
"schemas",
"objects",
"tables",
"columns",
"constraints",
"indexes",
"views",
"sequences",
"comments",
"privileges",
"dependencies",
"ddl",
"crdb_internal",
"system",
)
_COCKROACH_SUPPORTED_DOMAINS = frozenset(_COCKROACH_METADATA_DOMAINS) - {"crdb_internal", "system"}
def _cockroach_metadata_capability(domain: str) -> MetadataCapability:
if domain == "ddl":
return MetadataCapability(
domain=domain,
support=MetadataSupport.SUPPORTED,
fidelity=MetadataFidelity.LOSSY,
source=MetadataSource.INFORMATION_SCHEMA,
warnings=(
"CockroachDB DDL metadata is lossy unless SHOW-derived SQL is requested with quoted identifiers.",
),
)
if domain == "crdb_internal":
return MetadataCapability(
domain=domain,
support=MetadataSupport.UNSUPPORTED,
fidelity=MetadataFidelity.UNSUPPORTED,
source=MetadataSource.SYSTEM_VIEW,
risks=(MetadataRisk.VERSION_GATED, MetadataRisk.PRIVILEGED),
warnings=("crdb_internal metadata is disabled by default.",),
)
if domain == "system":
return MetadataCapability(
domain=domain,
support=MetadataSupport.UNSUPPORTED,
fidelity=MetadataFidelity.UNSUPPORTED,
source=MetadataSource.SYSTEM_VIEW,
risks=(MetadataRisk.EXPENSIVE, MetadataRisk.PRIVILEGED),
warnings=("System metadata is opt-in and disabled by default.",),
)
if domain in _COCKROACH_SUPPORTED_DOMAINS:
return MetadataCapability(
domain=domain,
support=MetadataSupport.SUPPORTED,
fidelity=MetadataFidelity.PARTIAL,
source=MetadataSource.INFORMATION_SCHEMA,
)
return MetadataCapability.unsupported(domain)
def _cockroach_metadata_profile(adapter: str, domains: Sequence[str] | None) -> MetadataCapabilityProfile:
requested_domains = _COCKROACH_METADATA_DOMAINS if domains is None else tuple(domains)
return MetadataCapabilityProfile(
"cockroachdb",
adapter=adapter,
capabilities=tuple(_cockroach_metadata_capability(domain) for domain in requested_domains),
)
def _metadata_result(
domain: str, capability: MetadataCapability, rows: list[Any] | tuple[Any, ...] = ()
) -> MetadataResult:
return MetadataResult(domain, capability=capability, items=tuple(rows), warnings=capability.warnings)
def _row_value(row: object, key: str) -> object | None:
if isinstance(row, Mapping):
return row.get(key)
return getattr(row, key, None)
def _cockroach_ddl_result_from_rows(
*,
dialect: str,
object_name: str,
object_type: str,
schema: str | None,
rows: tuple[object, ...],
warnings: tuple[str, ...] = (),
) -> DDLResult:
row = rows[0] if rows else None
resolved_schema = _row_value(row, "schema_name") if row is not None else schema
ddl = _row_value(row, "ddl") if row is not None else None
row_warning = _row_value(row, "warning") if row is not None else None
result_warnings = warnings + ((str(row_warning),) if row_warning else ())
identity = ObjectIdentity(
name=object_name,
object_type=object_type,
schema=str(resolved_schema) if resolved_schema is not None else None,
dialect=dialect,
source=MetadataSource.INFORMATION_SCHEMA,
)
return DDLResult.lossy(
identity,
ddl=str(ddl) if ddl is not None else None,
source=MetadataSource.INFORMATION_SCHEMA,
warnings=result_warnings,
)
def _cockroach_domain_sql(domain: str, query_name: str) -> "SQL":
query = get_data_dictionary_loader().get_domain_query("cockroachdb", domain, query_name)
if query.sql is None:
msg = f"Missing CockroachDB data-dictionary query: {domain}/{query_name}"
raise RuntimeError(msg)
return query.sql
[docs]
class CockroachAsyncpgDataDictionary(AsyncDataDictionaryBase):
"""CockroachDB async data dictionary (AsyncPG)."""
dialect: ClassVar[str] = "cockroachdb"
async def _select_domain(
self, driver: "CockroachAsyncpgDriver", domain: str, query_name: str, **parameters: Any
) -> MetadataResult:
query = get_data_dictionary_loader().get_domain_query(type(self).dialect, domain, query_name)
if not query.is_supported or query.sql is None:
return MetadataResult(domain, capability=query.capability, warnings=query.warnings)
rows = await driver.select(query.sql, **parameters)
return _metadata_result(domain, _cockroach_metadata_capability(domain), rows)
[docs]
async def get_schemas(self, driver: "CockroachAsyncpgDriver") -> MetadataResult:
"""Get schema metadata."""
return await self._select_domain(driver, "schemas", "list")
[docs]
async def get_objects(self, driver: "CockroachAsyncpgDriver", schema: str | None = None) -> MetadataResult:
"""Get database object metadata."""
return await self._select_domain(driver, "objects", "by_schema", schema_name=self.resolve_schema(schema))
[docs]
async def get_table_details(
self, driver: "CockroachAsyncpgDriver", table: str, schema: str | None = None
) -> MetadataResult:
"""Get rich table metadata."""
return await self._select_domain(
driver,
"tables",
"by_schema",
schema_name=self.resolve_schema(schema),
table_name=self.resolve_identifier(table),
)
[docs]
async def get_constraints(
self, driver: "CockroachAsyncpgDriver", table: str | None = None, schema: str | None = None
) -> MetadataResult:
"""Get constraint metadata."""
table_name = self.resolve_identifier(table) if table is not None else None
return await self._select_domain(
driver, "constraints", "by_schema", schema_name=self.resolve_schema(schema), table_name=table_name
)
[docs]
async def get_views(self, driver: "CockroachAsyncpgDriver", schema: str | None = None) -> MetadataResult:
"""Get view metadata."""
return await self._select_domain(driver, "views", "by_schema", schema_name=self.resolve_schema(schema))
[docs]
async def get_routines(self, driver: "CockroachAsyncpgDriver", schema: str | None = None) -> MetadataResult:
"""Get routine metadata."""
return _metadata_result("routines", MetadataCapability.unsupported("routines"))
[docs]
async def get_privileges(
self, driver: "CockroachAsyncpgDriver", object_name: str | None = None, schema: str | None = None
) -> MetadataResult:
"""Get privilege metadata."""
resolved_object = self.resolve_identifier(object_name) if object_name is not None else None
return await self._select_domain(
driver, "privileges", "by_schema", schema_name=self.resolve_schema(schema), object_name=resolved_object
)
[docs]
async def get_dependencies(
self, driver: "CockroachAsyncpgDriver", object_name: str | None = None, schema: str | None = None
) -> MetadataResult:
"""Get stable dependency metadata."""
resolved_object = self.resolve_identifier(object_name) if object_name is not None else None
return await self._select_domain(
driver, "dependencies", "by_schema", schema_name=self.resolve_schema(schema), object_name=resolved_object
)
[docs]
async def get_ddl(
self,
driver: "CockroachAsyncpgDriver",
object_name: str,
schema: str | None = None,
*,
object_type: str = "table",
include_dependencies: bool = True,
prefer_native: bool = True,
redact: bool = True,
) -> DDLResult:
"""Get lossy CockroachDB DDL status without parameterized identifiers."""
_ = include_dependencies, prefer_native, redact
schema_name = self.resolve_schema(schema)
resolved_object = self.resolve_identifier(object_name)
result = await self._select_domain(
driver, "ddl", "by_object", schema_name=schema_name, object_name=resolved_object, object_type=object_type
)
return _cockroach_ddl_result_from_rows(
dialect=type(self).dialect,
object_name=resolved_object,
object_type=object_type,
schema=schema_name,
rows=result.items,
warnings=result.warnings,
)
[docs]
async def get_version(self, driver: "CockroachAsyncpgDriver") -> "VersionInfo | None":
driver_id = id(driver)
if driver_id in self._version_fetch_attempted:
return self._version_cache.get(driver_id)
version_value = await driver.select_value_or_none(self.get_query("version", "current"))
if not version_value:
self._log_version_unavailable(type(self).dialect, "missing")
self.cache_version(driver_id, None)
return None
version_info = self.parse_version_with_pattern(self.get_dialect_config().version_pattern, str(version_value))
if version_info is None:
self._log_version_unavailable(type(self).dialect, "parse_failed")
self.cache_version(driver_id, None)
return None
self._log_version_detected(type(self).dialect, version_info)
self.cache_version(driver_id, version_info)
return version_info
[docs]
async def get_feature_flag(self, driver: "CockroachAsyncpgDriver", feature: str) -> bool:
version_info = await self.get_version(driver)
return self.resolve_feature_flag(feature, version_info)
[docs]
async def get_optimal_type(self, driver: "CockroachAsyncpgDriver", type_category: str) -> str:
config = self.get_dialect_config()
if type_category == "json":
return resolve_cockroachdb_json_type(await self.get_version(driver))
return config.get_optimal_type(type_category)
[docs]
async def get_tables(self, driver: "CockroachAsyncpgDriver", schema: "str | None" = None) -> "list[TableMetadata]":
schema_name = self.resolve_schema(schema)
self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="tables")
return await driver.select(
_cockroach_domain_sql("tables", "by_schema"),
schema_name=schema_name,
table_name=None,
schema_type=TableMetadata,
)
[docs]
async def get_columns(
self, driver: "CockroachAsyncpgDriver", table: "str | None" = None, schema: "str | None" = None
) -> "list[ColumnMetadata]":
schema_name = self.resolve_schema(schema)
if table is None:
self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="columns")
return await driver.select(
_cockroach_domain_sql("columns", "by_schema"),
schema_name=schema_name,
table_name=None,
schema_type=ColumnMetadata,
)
table_name = self.resolve_identifier(table)
self._log_table_describe(driver, schema_name=schema_name, table_name=table_name, operation="columns")
return await driver.select(
_cockroach_domain_sql("columns", "by_schema"),
schema_name=schema_name,
table_name=table_name,
schema_type=ColumnMetadata,
)
[docs]
async def get_indexes(
self, driver: "CockroachAsyncpgDriver", table: "str | None" = None, schema: "str | None" = None
) -> "list[IndexMetadata]":
schema_name = self.resolve_schema(schema)
if table is None:
self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="indexes")
return await driver.select(
_cockroach_domain_sql("indexes", "by_schema"),
schema_name=schema_name,
table_name=None,
schema_type=IndexMetadata,
)
table_name = self.resolve_identifier(table)
self._log_table_describe(driver, schema_name=schema_name, table_name=table_name, operation="indexes")
return await driver.select(
_cockroach_domain_sql("indexes", "by_schema"),
schema_name=schema_name,
table_name=table_name,
schema_type=IndexMetadata,
)
[docs]
async def get_foreign_keys(
self, driver: "CockroachAsyncpgDriver", table: "str | None" = None, schema: "str | None" = None
) -> "list[ForeignKeyMetadata]":
schema_name = self.resolve_schema(schema)
if table is None:
self._log_schema_introspect(driver, schema_name=schema_name, table_name=None, operation="foreign_keys")
return await driver.select(
self.get_query("foreign_keys", "by_schema"), schema_name=schema_name, schema_type=ForeignKeyMetadata
)
table_name = self.resolve_identifier(table)
self._log_table_describe(driver, schema_name=schema_name, table_name=table_name, operation="foreign_keys")
return await driver.select(
self.get_query("foreign_keys", "by_table"),
table_name=table_name,
schema_name=schema_name,
schema_type=ForeignKeyMetadata,
)
