Skip to main content

Crate type_bridge_schema_migration

Crate type_bridge_schema_migration 

Source
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§

AppliedRecord
Identity-only applied-ledger record for one verified manifest.
BackfillCompletionEvidence
Exact terminal proof that one closed backfill program satisfies its postcondition.
BackfillEventRecord
Durable positional event for one exact forward or reverse backfill step.
BackfillExecutionCounts
Bounded aggregate counts from a completely verified backfill execution.
BackfillMigrationGenerationRequest
Inputs authoring one closed binding-neutral backfill migration.
CanonicalMigrationHistoryEvidence
Exact canonical-file authority retained from one successful discovery.
ExecutionFence
A monotonically increasing store-issued migration fencing token.
ExecutionScope
One durable managed migration scope.
GeneratedMigration
A freshly authored manifest with its exact canonical persistence bytes.
GroupCommitFailure
A provider commit failure with explicit asymmetric certainty.
GroupEventRecord
Identity-only journal event for one verified transaction group.
JournalEntry
One record after the store atomically assigns its ordering sequence.
JournalSequence
Store-assigned monotonic ordering identity for journal entries.
LeaseHolderId
Caller-supplied lease holder identity with no machine-derived garnish.
LegacyAppliedSetDigest
Digest binding every semantic row in the released applied ledger.
LegacyMigrationAppLabel
A lossless bounded UTF-8 application label from released migration history.
LegacyMigrationChecksum
A tagged legacy migration checksum.
LegacyMigrationId
Lossless compound identity for a released migration frontier member.
LegacyMigrationName
A lossless bounded UTF-8 migration name from released migration history.
LegacyMigrationReference
One legacy frontier migration named by the canonical bridge.
MigrationApplyApproval
A one-time operator approval bound to one exact verified transition.
MigrationAuthoringLock
Exclusive advisory lock shared by canonical migration publishers.
MigrationBackfillObservation
Bounded terminal observation for one canonical backfill operation.
MigrationCancellation
Cloneable, wakeable cancellation authority for migration operations.
MigrationCatalog
Immutable runtime migration catalog admitted from canonical generated bytes.
MigrationDirectory
A retained cross-platform capability for one migration directory.
MigrationDirectoryEntry
One direct entry observed through a retained migration-directory handle.
MigrationExecutionControl
Immutable controls shared by apply and rollback execution.
MigrationExecutionReport
Bounded owned projection of one terminal apply or rollback outcome.
MigrationExecutionResourceLimits
Tighten-only bounded resources for one migration execution invocation.
MigrationGenerationRequest
Inputs authoring the next migration for one application lineage.
MigrationHistoryGraph
A validated DAG whose only node authority is a verified canonical manifest.
MigrationLease
Store-issued authority to mutate one migration scope.
MigrationSafetyPolicy
Explicit per-class apply policy.
MigrationVerifyReport
The complete read-only verification report.
OpenPlanRecord
One trusted, still-open plan and its ordered group events.
OpenRollbackPlanRecord
One trusted, still-open rollback plan and its ordered step events.
PlanRecord
Identity-only journal record for one complete verified apply plan.
RollbackPlanRecord
Identity-only journal record for one complete verified rollback plan.
RollbackStepEventRecord
Identity-only journal event for one verified rollback step transaction.
RolledBackRecord
Identity-only retirement record for one rolled-back applied migration.
SchemaLoweringProfileFingerprint
A fingerprint whose metadata is pinned to the schema-lowering domain.
SchemaLoweringProfileId
A validated schema-lowering profile identifier.
SchemaMigrationDraft
Trusted authoring input containing only context-free schema steps.
VerifiedMigrationApplyManifest
One verified manifest plus its external digest and rederived step evidence.
VerifiedMigrationApplyPlan
An opaque, deterministic, pre-I/O migration apply plan.
VerifiedMigrationHistoryBundle
A deterministic immutable history snapshot admitted only after full replay.
VerifiedMigrationHistoryBundleEntry
One replay-verified historical manifest and its exact endpoint schemas.
VerifiedMigrationRollbackBackfillStep
One checked closed reverse backfill program.
VerifiedMigrationRollbackManifest
One verified manifest with its complete reverse program.
VerifiedMigrationRollbackPlan
A complete pre-verified rollback plan in reverse-topological order.
VerifiedMigrationRollbackStep
One lowered reverse program for one forward schema step.
VerifiedMigrationTransactionGroup
One verifier-owned transaction group ending in exactly one schema delta.
VerifiedSchemaMigrationManifest
A manifest whose complete schema program has been replayed and recomputed.

Enums§

BackfillExecutionDirection
Direction of one closed backfill program at execution time.
BackfillRecoveryObservation
Fresh provider observation of one exact backfill postcondition.
GroupCommitCertainty
Commit certainty owned by the migration journal layer.
GroupJournalEventKind
Durable commit-boundary event vocabulary for one transaction group.
GroupRecoveryDecision
Fail-closed recovery decision for one positional transaction group.
GroupRecoveryObservation
Optional live managed-semantic evidence used during recovery.
MigrationApplyPlanError
Failure while deriving a provider-neutral apply plan before any I/O.
MigrationApplyTarget
Select the target closure of a migration apply operation.
MigrationDriftFinding
One verified drift finding.
MigrationExecutionDirection
Direction of one bounded public migration execution report.
MigrationExecutionOutcome
Terminal result of one coordinator invocation.
MigrationExecutionPosition
Exact execution position associated with a non-success apply outcome.
MigrationExecutionReportPosition
Stable position vocabulary shared by forward and rollback reports.
MigrationExecutionStatus
Terminal status of one bounded public migration execution report.
MigrationGenerationOutcome
Result of one offline generation attempt.
MigrationPreviewError
Failure rendering a review-only TypeQL preview for a generated manifest.
MigrationRollbackOutcome
Terminal result of one rollback coordinator invocation.
SafetyClass
The exact eight-class provider-neutral migration safety vocabulary.
SafetyClassificationError
A malformed formal transition that cannot be assigned a safety class.
SafetyPolicyDecision
How the apply gate treats one manifest safety classification.
VerifiedMigrationApplyStep
One trusted step aligned to its independently verified execution evidence.
VerifiedMigrationRollbackOperation
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§

MigrationExecutionJournal
Durable applied ledger and open-plan journal.
MigrationExecutionProvider
Provider seam for exact managed-state observation and group transactions.
MigrationLeaseStore
Store-backed exclusive lease service.
PreparedMigrationGroup
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§

BackfillExecutionFuture
Future returned by one complete provider-owned deterministic backfill run.
ExecutionFuture
Boxed future returned by provider-neutral execution stores.
GroupCommitFuture
Future returned by a consuming provider commit operation.