Crate plsql_catalog 

Modules

synthetic

Synthetic test catalog builder for creating realistic test fixtures.

Structs

AccessibleByTarget

ArgumentMetadata

CapabilityWarning

CatalogCapabilities

CatalogDependency

CatalogDoctorReport

Structured doctor report for a CatalogSnapshot.

CatalogLoadRequest

CatalogSnapshot

CatalogSnapshotDocument

CatalogSource

ColumnComment

Documentation comment attached to a column via COMMENT ON COLUMN owner.table.column IS '...'. Sourced from ALL_COL_COMMENTS.

ColumnMetadata

CompilerIdentifier

CompilerReference

CompilerStatementUsage

ConstraintMetadata

ConstraintName

DataTypeRef

DatabaseLink

Database link metadata sourced from ALL_DB_LINKS.

DbmsMetadataDdl

DoctorExtractionTotals

Summary of how many catalog rows landed per family and how many schema-scoped buckets are populated.

DoctorObjectCount

Per-ObjectType count tile shown in the doctor report.

Edition

Edition entry from ALL_EDITIONS — the per-database edition tree used by Oracle Edition-Based Redefinition (EBR). Linked into CatalogSnapshot::editions.

EditioningView

Editioning view from ALL_EDITIONING_VIEWS — a view that masks an editioned table during EBR cutovers. Linked into SchemaCatalog::editioning_views.

EditioningViewMetadata

FunctionMetadata

Grant

Hash

IndexMetadata

IndexName

MViewMetadata

MissingPermissionReport

Doctor-flagged missing privilege: the plsql-catalog driver could not observe an Oracle dictionary view that some upstream features require.

ObjectCommon

OracleCell

OracleConnectOptions

OracleConnectionInfo

OracleRow

PackageMetadata

PlScopeAvailabilityRow

One row of the doctor report’s per-schema PL/Scope availability summary. The schema_name is rendered through the snapshot’s SymbolInterner so the report is stable across JSON snapshots and live extractions.

PlScopeSnapshot

ProcedureMetadata

RoutineSignature

SchedulerJobMetadata

SchemaCatalog

SequenceMetadata

SynonymName

SynonymTarget

TableComment

Documentation comment attached to a table, view, or materialized view via COMMENT ON TABLE owner.name IS '...'. Sourced from ALL_TAB_COMMENTS.

TableMetadata

TriggerMetadata

TriggerName

TypeAttribute

TypeMetadata

ViewMetadata

VpdPolicy

Virtual Private Database (VPD / RLS) policy entry from ALL_POLICIES. Each row describes one policy attached to an object; the policy function (PF_OWNER.PACKAGE.FUNCTION) is the predicate generator that Oracle invokes at parse time to inject a WHERE clause into reads (and optional ones into INSERT/UPDATE/DELETE).

Enums

CatalogDependencyKind

CatalogError

CatalogObject

CatalogSchemaFilter

CatalogSourceKind

ConstraintType

GrantPrivilege

Grantee

ObjectStatus

ObjectType

OracleBackend

OracleBind

ParameterMode

PlScopeAvailability

TemporaryTableDuration

TriggerEvent

TriggerLevel

TriggerTiming

TypeFinality

TypeInstantiable

Constants

CATALOG_DOCTOR_SCHEMA_ID

CATALOG_DOCTOR_SCHEMA_VERSION

CATALOG_SNAPSHOT_SCHEMA_ID

CATALOG_SNAPSHOT_SCHEMA_VERSION

Traits

OracleConnection

Functions

export_snapshot_to_json

fetch_dbms_metadata_ddl

Fetch the canonical DDL + XML representation of a single object via DBMS_METADATA.

load_from_dbms_metadata_dir

Load a catalog snapshot from a directory of DBMS_METADATA-exported .sql files.

load_snapshot_from_connection

load_snapshot_from_json

negotiate_capabilities

Probe an OracleConnection for the dictionary surface it can actually reach. The loader records CatalogCapabilities from real probe outcomes instead of optimistic defaults, so downstream consumers can render an accurate doctor report and the right MissingPermissionReport rows.

normalize_dbms_metadata_ddl

Normalize DDL text emitted by DBMS_METADATA.GET_DDL so equality checks across runs ignore cosmetic differences:

object_type_to_dbms_metadata_value

Map an ObjectType to the string the DBMS_METADATA.GET_DDL / GET_XML overloads expect as their first parameter. Returns None for types that have no DBMS_METADATA representation (e.g. ObjectType::Unknown, ObjectType::Constraint).

populate_dbms_metadata_ddl

Populate ObjectCommon.ddl for every object in the snapshot using DBMS_METADATA.GET_DDL and DBMS_METADATA.GET_XML. Skips silently when capabilities.can_use_dbms_metadata is false. Failures on individual objects are recorded as CapabilityWarnings on the snapshot and do not abort the populate pass.