Expand description
Verified offline schema migration contracts and provider lowering policy.
Re-exports§
pub use lowering::SchemaFactCatalog;pub use lowering::SchemaLoweringBinding;pub use lowering::SchemaLoweringDiagnostic;pub use lowering::SchemaLoweringPlan;pub use lowering::StatementOperationKind;pub use lowering::StatementUnit;pub use lowering::TypeQlStatement;pub use lowering::TypeQlVerb;pub use lowering::lower_schema_delta;pub use profile::AnnotationKind;pub use profile::AnnotationSubjectKind;pub use profile::AnnotationTransition;pub use profile::EvidenceFlag;pub use profile::EvidenceRequirement;pub use profile::FactKind;pub use profile::FactTransition;pub use profile::InterfaceDefault;pub use profile::InterfaceKind;pub use profile::LoweringMechanism;pub use profile::SafetyScenario;pub use profile::SafetyScenarioRule;pub use profile::SchemaLoweringProfile;pub use profile::TransitionRule;pub use profile::annotation_transition_rule;pub use profile::canonical_profile_bytes;pub use profile::fact_transition_rule;pub use profile::migration_runtime_capability_vocabulary;pub use profile::profile_fingerprint;pub use profile::schema_lowering_profile_binding;pub use profile::typedb_3_12_1_profile;
Modules§
- lowering
- Deterministic offline lowering of validated schema deltas to TypeDB 3.12.1 TypeQL.
- profile
- Closed TypeDB 3.12.1 schema-transition registry.
Structs§
- Applied
Record - Identity-only applied-ledger record for one verified manifest.
- Backfill
Completion Evidence - Exact terminal proof that one closed backfill program satisfies its postcondition.
- Backfill
Event Record - Durable positional event for one exact forward or reverse backfill step.
- Backfill
Execution Counts - Bounded aggregate counts from a completely verified backfill execution.
- Backfill
Migration Generation Request - Inputs authoring one closed binding-neutral backfill migration.
- Canonical
Migration History Evidence - Exact canonical-file authority retained from one successful discovery.
- Execution
Fence - A monotonically increasing store-issued migration fencing token.
- Execution
Scope - One durable managed migration scope.
- Generated
Migration - A freshly authored manifest with its exact canonical persistence bytes.
- Group
Commit Failure - A provider commit failure with explicit asymmetric certainty.
- Group
Event Record - Identity-only journal event for one verified transaction group.
- Journal
Entry - One record after the store atomically assigns its ordering sequence.
- Journal
Sequence - Store-assigned monotonic ordering identity for journal entries.
- Lease
Holder Id - Caller-supplied lease holder identity with no machine-derived garnish.
- Legacy
Applied SetDigest - Digest binding every semantic row in the released applied ledger.
- Legacy
Migration AppLabel - A lossless bounded UTF-8 application label from released migration history.
- Legacy
Migration Checksum - A tagged legacy migration checksum.
- Legacy
Migration Id - Lossless compound identity for a released migration frontier member.
- Legacy
Migration Name - A lossless bounded UTF-8 migration name from released migration history.
- Legacy
Migration Reference - One legacy frontier migration named by the canonical bridge.
- Migration
Apply Approval - A one-time operator approval bound to one exact verified transition.
- Migration
Authoring Lock - Exclusive advisory lock shared by canonical migration publishers.
- Migration
Backfill Observation - Bounded terminal observation for one canonical backfill operation.
- Migration
Cancellation - Cloneable, wakeable cancellation authority for migration operations.
- Migration
Catalog - Immutable runtime migration catalog admitted from canonical generated bytes.
- Migration
Directory - A retained cross-platform capability for one migration directory.
- Migration
Directory Entry - One direct entry observed through a retained migration-directory handle.
- Migration
Execution Control - Immutable controls shared by apply and rollback execution.
- Migration
Execution Report - Bounded owned projection of one terminal apply or rollback outcome.
- Migration
Execution Resource Limits - Tighten-only bounded resources for one migration execution invocation.
- Migration
Generation Request - Inputs authoring the next migration for one application lineage.
- Migration
History Graph - A validated DAG whose only node authority is a verified canonical manifest.
- Migration
Lease - Store-issued authority to mutate one migration scope.
- Migration
Safety Policy - Explicit per-class apply policy.
- Migration
Verify Report - The complete read-only verification report.
- Open
Plan Record - One trusted, still-open plan and its ordered group events.
- Open
Rollback Plan Record - One trusted, still-open rollback plan and its ordered step events.
- Plan
Record - Identity-only journal record for one complete verified apply plan.
- Rollback
Plan Record - Identity-only journal record for one complete verified rollback plan.
- Rollback
Step Event Record - Identity-only journal event for one verified rollback step transaction.
- Rolled
Back Record - Identity-only retirement record for one rolled-back applied migration.
- Schema
Lowering Profile Fingerprint - A fingerprint whose metadata is pinned to the schema-lowering domain.
- Schema
Lowering Profile Id - A validated schema-lowering profile identifier.
- Schema
Migration Draft - Trusted authoring input containing only context-free schema steps.
- Verified
Migration Apply Manifest - One verified manifest plus its external digest and rederived step evidence.
- Verified
Migration Apply Plan - An opaque, deterministic, pre-I/O migration apply plan.
- Verified
Migration History Bundle - A deterministic immutable history snapshot admitted only after full replay.
- Verified
Migration History Bundle Entry - One replay-verified historical manifest and its exact endpoint schemas.
- Verified
Migration Rollback Backfill Step - One checked closed reverse backfill program.
- Verified
Migration Rollback Manifest - One verified manifest with its complete reverse program.
- Verified
Migration Rollback Plan - A complete pre-verified rollback plan in reverse-topological order.
- Verified
Migration Rollback Step - One lowered reverse program for one forward schema step.
- Verified
Migration Transaction Group - One verifier-owned transaction group ending in exactly one schema delta.
- Verified
Schema Migration Manifest - A manifest whose complete schema program has been replayed and recomputed.
Enums§
- Backfill
Execution Direction - Direction of one closed backfill program at execution time.
- Backfill
Recovery Observation - Fresh provider observation of one exact backfill postcondition.
- Group
Commit Certainty - Commit certainty owned by the migration journal layer.
- Group
Journal Event Kind - Durable commit-boundary event vocabulary for one transaction group.
- Group
Recovery Decision - Fail-closed recovery decision for one positional transaction group.
- Group
Recovery Observation - Optional live managed-semantic evidence used during recovery.
- Migration
Apply Plan Error - Failure while deriving a provider-neutral apply plan before any I/O.
- Migration
Apply Target - Select the target closure of a migration apply operation.
- Migration
Drift Finding - One verified drift finding.
- Migration
Execution Direction - Direction of one bounded public migration execution report.
- Migration
Execution Outcome - Terminal result of one coordinator invocation.
- Migration
Execution Position - Exact execution position associated with a non-success apply outcome.
- Migration
Execution Report Position - Stable position vocabulary shared by forward and rollback reports.
- Migration
Execution Status - Terminal status of one bounded public migration execution report.
- Migration
Generation Outcome - Result of one offline generation attempt.
- Migration
Preview Error - Failure rendering a review-only TypeQL preview for a generated manifest.
- Migration
Rollback Outcome - Terminal result of one rollback coordinator invocation.
- Safety
Class - The exact eight-class provider-neutral migration safety vocabulary.
- Safety
Classification Error - A malformed formal transition that cannot be assigned a safety class.
- Safety
Policy Decision - How the apply gate treats one manifest safety classification.
- Verified
Migration Apply Step - One trusted step aligned to its independently verified execution evidence.
- Verified
Migration Rollback Operation - One verified reverse execution entry in exact reverse-manifest order.
Constants§
- LEGACY_
APPLIED_ SET_ ALGORITHM - Digest algorithm vocabulary for the complete released applied set.
- LEGACY_
APPLIED_ SET_ CANONICALIZATION - Canonicalization/domain vocabulary for the complete released applied set.
- LEGACY_
CHECKSUM_ ALGORITHM - Tag identifying the legacy checksum algorithm: SHA-256 over the authored Python migration source, hex-encoded and truncated to 16 characters.
- MAX_
MIGRATION_ BACKFILL_ OBSERVATIONS - Shared maximum number of retained terminal backfill observations.
- MAX_
MIGRATION_ EXECUTION_ GROUPS - Shared maximum number of migration transaction groups in one invocation.
- MAX_
MIGRATION_ HISTORY_ BUNDLE_ BYTES - Maximum accepted canonical history-bundle size: 16 MiB.
- MIGRATION_
HISTORY_ BUNDLE_ FINGERPRINT_ CANONICALIZATION - Canonicalization identity for the first history-bundle wire.
- MIGRATION_
HISTORY_ BUNDLE_ FINGERPRINT_ DOMAIN - Fingerprint domain for one exact verified history bundle content object.
- MIGRATION_
HISTORY_ BUNDLE_ V1 - Exact wire discriminator for the first immutable migration-history bundle.
- SCHEMA_
LOWERING_ PROFILE_ CANONICALIZATION - Canonicalization version for schema-lowering profile documents.
- SCHEMA_
LOWERING_ PROFILE_ FINGERPRINT_ DOMAIN - Fingerprint domain for schema-lowering profile documents.
- TYPEDB_
3_ 12_ 1_ SCHEMA_ LOWERING_ PROFILE_ ID - The only schema-lowering profile admitted by this V2 contract revision.
Traits§
- Migration
Execution Journal - Durable applied ledger and open-plan journal.
- Migration
Execution Provider - Provider seam for exact managed-state observation and group transactions.
- Migration
Lease Store - Store-backed exclusive lease service.
- Prepared
Migration Group - One provider transaction prepared for an exact verifier-owned group.
Functions§
- active_
applied_ entries - Filter an applied ledger down to its active records.
- await_
interruptible_ operation - Await an effect-free or abort-on-drop operation under shared controls.
- build_
legacy_ frontier_ bridge - Build the verified zero-operation bridge for one legacy frontier.
- build_
verified_ manifest - Replay a trusted draft against an exact declared source and managed context.
- build_
verified_ migration_ apply_ plan - Build a complete apply plan from verified history and explicit execution policy.
- build_
verified_ migration_ apply_ preview - Build a deterministic provider-free forward preview without execution authority.
- build_
verified_ migration_ rollback_ plan - Build a complete rollback plan from verified history and explicit policy.
- build_
verified_ migration_ rollback_ preview - Build a deterministic provider-free preview without granting execution authority.
- canonical_
history_ declared_ legacy_ bridge_ count_ in - Count direct canonical candidates that declare a legacy bridge.
- canonical_
history_ declares_ legacy_ bridge_ in - Return whether any direct canonical candidate declares a legacy bridge.
- classify_
operation_ safety - Classify one validated formal operation without granting execution authority.
- decide_
backfill_ recovery - Decide whether a complete backfill may execute or only repair its checkpoint.
- decide_
group_ recovery - Decide recovery from durable event and freshly observed managed semantics.
- decode_
verified_ manifest - Decode canonical bytes and return only a fully replay-verified manifest.
- decode_
verified_ migration_ history_ bundle - Decode, reconstruct, replay, and independently verify a history bundle.
- discover_
verified_ migration_ chain - Discover, order, and replay-verify one complete canonical migration chain.
- discover_
verified_ migration_ chain_ in - Discover and replay-verify through a retained directory capability.
- discover_
verified_ migration_ chain_ with_ evidence_ in - Discover and replay-verify through a retained directory while preserving the exact canonical-file authority used to build the graph.
- discover_
verified_ migrations - Discover only direct canonical V2 children and verify each before graph use.
- discover_
verified_ migrations_ in - Discover through a retained directory capability.
- encode_
verified_ manifest - Encode a verified manifest under the bounded canonical JSON contract.
- encode_
verified_ migration_ history_ bundle - Encode one verified history bundle into bounded canonical bytes.
- execute_
verified_ migration_ apply_ plan - Execute one complete verified plan under a store-backed fenced lease.
- execute_
verified_ migration_ apply_ plan_ controlled - Execute one verified apply plan under explicit cancellation, deadline, and limits.
- execute_
verified_ migration_ rollback_ plan - Execute one complete verified rollback plan under a store-backed lease.
- execute_
verified_ migration_ rollback_ plan_ controlled - Execute one verified rollback plan under explicit cancellation, deadline, and limits.
- generate_
backfill_ migration - Author one closed backfill against the exact committed history head.
- generate_
next_ migration - Author the next verified migration from the discovered history graph.
- partition_
transaction_ groups - Partition trusted apply evidence into exact assertion-plus-delta transactions.
- render_
migration_ preview - Render the review-only TypeQL preview of a verified manifest.
- require_
adoption_ authority_ pair - Require adopted genesis and the unique canonical legacy bridge to exist as one inseparable authority pair.
- require_
adoption_ authority_ pair_ state - Require the raw adoption-authority presence state to be complete.
- require_
authorized_ apply_ plan - Reject a provider-free forward preview before any connected setup or I/O.
- require_
authorized_ rollback_ plan - Reject a provider-free rollback preview before any connected setup or I/O.
- try_
acquire_ migration_ authoring_ lock - Acquire the shared canonical-history authoring lock without waiting.
- validate_
portable_ direct_ child - Validate one UTF-8, cross-platform direct-child name.
- verified_
manifest_ digest - Compute the external raw full-SHA256 digest of exact canonical manifest bytes.
- verify_
migration_ state - Verify the migration state triad and report every drift finding.
- write_
generated_ migration_ under_ lock - Publish a generated manifest while its directory’s authoring lock is held.
Type Aliases§
- Backfill
Execution Future - Future returned by one complete provider-owned deterministic backfill run.
- Execution
Future - Boxed future returned by provider-neutral execution stores.
- Group
Commit Future - Future returned by a consuming provider commit operation.