icydb-core 0.158.13

IcyDB — A schema-first typed query engine and persistence runtime for Internet Computer canisters
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! Module: db::schema
//! Responsibility: runtime schema-contract utilities (introspection, validation, hashing).
//! Does not own: query planning policy, execution routing, or storage diagnostics.
//! Boundary: exposes schema-facing contracts consumed by session/query/commit paths.

mod capabilities;
mod codec;
mod describe;
mod errors;
mod fingerprint;
mod format;
mod identity;
mod info;
mod integrity;
mod layout;
mod mutation;
mod proposal;
mod reconcile;
mod runtime;
mod snapshot;
mod store;
mod transition;
mod types;

pub use describe::{
    EntityFieldDescription, EntityIndexDescription, EntityRelationCardinality,
    EntityRelationDescription, EntityRelationStrength, EntitySchemaCheckDescription,
    EntitySchemaDescription,
};
pub use errors::ValidateError;

pub(in crate::db) use capabilities::{SqlCapabilities, sql_capabilities};
pub(in crate::db::schema) use codec::{
    decode_persisted_schema_snapshot, encode_persisted_schema_snapshot,
};
pub(in crate::db) use describe::{
    describe_entity_fields, describe_entity_fields_with_persisted_schema, describe_entity_model,
    describe_entity_model_with_persisted_schema,
};
pub(in crate::db) use fingerprint::{
    accepted_commit_schema_fingerprint, accepted_schema_cache_fingerprint,
};
pub(in crate::db) use format::{
    show_indexes_for_model, show_indexes_for_model_with_runtime_state,
    show_indexes_for_schema_info_with_runtime_state,
};
pub(in crate::db) use identity::FieldId;
pub(in crate::db) use info::{
    SchemaExpressionIndexInfo, SchemaExpressionIndexKeyItemInfo, SchemaIndexFieldPathInfo,
    SchemaIndexInfo, SchemaInfo,
};
pub(in crate::db::schema) use integrity::{
    schema_snapshot_index_integrity_detail, schema_snapshot_integrity_detail,
};
pub(in crate::db) use layout::{SchemaFieldSlot, SchemaRowLayout, SchemaVersion};
#[cfg(test)]
pub(in crate::db::schema) use mutation::AcceptedSchemaMutationError;
#[cfg(test)]
pub(in crate::db::schema) use mutation::SchemaMutation;
#[cfg(test)]
pub(in crate::db::schema) use mutation::SchemaRebuildAction;
#[cfg(test)]
pub(in crate::db::schema) use mutation::{MutationCompatibility, RebuildRequirement};
pub(in crate::db::schema) use mutation::{
    MutationPlan, MutationPublicationBlocker, MutationPublicationPreflight,
    MutationPublicationStatus, SchemaExpressionIndexRebuildRow, SchemaExpressionIndexStagedEntry,
    SchemaExpressionIndexStagedRebuild, SchemaFieldPathIndexRebuildRow, SchemaFieldPathIndexRunner,
    SchemaFieldPathIndexRunnerFailure, SchemaFieldPathIndexRunnerReport,
    SchemaMutationAcceptedSnapshotPublicationSink, SchemaMutationDeveloperReport,
    SchemaMutationExecutionPlan, SchemaMutationExecutionStep, SchemaMutationPublishStatus,
    SchemaMutationRequest, SchemaMutationRunnerCapability, SchemaMutationRunnerContract,
    SchemaMutationRunnerInput, SchemaMutationRunnerPhase, SchemaMutationRuntimeEpoch,
    SchemaMutationRuntimeInvalidationSink, SchemaMutationSupportedExecutionPath,
    SchemaMutationSupportedPathRejection, SchemaMutationValidationStatus,
    schema_mutation_request_for_snapshots,
};
pub(in crate::db) use mutation::{
    SchemaDdlAcceptedSnapshotDerivation, SchemaDdlIndexDropCandidateError,
    SchemaDdlMutationAdmission, SchemaDdlMutationAdmissionError,
    SchemaExpressionIndexRebuildExpression, SchemaExpressionIndexRebuildKey,
    SchemaExpressionIndexRebuildTarget, SchemaFieldDefaultTarget, SchemaFieldDropTarget,
    SchemaFieldNullabilityTarget, SchemaFieldPathIndexRebuildKey,
    SchemaFieldPathIndexRebuildTarget, SchemaFieldRenameTarget,
    SchemaSecondaryIndexDropCleanupTarget, admit_sql_ddl_expression_index_candidate,
    admit_sql_ddl_field_addition_candidate, admit_sql_ddl_field_default_candidate,
    admit_sql_ddl_field_drop_candidate, admit_sql_ddl_field_nullability_candidate,
    admit_sql_ddl_field_path_index_candidate, admit_sql_ddl_field_rename_candidate,
    admit_sql_ddl_secondary_index_drop_candidate, derive_sql_ddl_expression_index_accepted_after,
    derive_sql_ddl_field_addition_accepted_after, derive_sql_ddl_field_default_accepted_after,
    derive_sql_ddl_field_drop_accepted_after, derive_sql_ddl_field_nullability_accepted_after,
    derive_sql_ddl_field_path_index_accepted_after, derive_sql_ddl_field_rename_accepted_after,
    derive_sql_ddl_secondary_index_drop_accepted_after, resolve_sql_ddl_field_drop_dependent_index,
    resolve_sql_ddl_secondary_index_drop_candidate,
};
#[cfg(test)]
pub(in crate::db::schema) use mutation::{SchemaMutationDelta, classify_schema_mutation_delta};
pub(in crate::db) use proposal::compiled_schema_proposal_for_model;
pub(in crate::db) use reconcile::{
    ensure_accepted_schema_snapshot, execute_sql_ddl_expression_index_addition,
    execute_sql_ddl_field_addition, execute_sql_ddl_field_default_change,
    execute_sql_ddl_field_drop, execute_sql_ddl_field_nullability_change,
    execute_sql_ddl_field_path_index_addition, execute_sql_ddl_field_rename,
    execute_sql_ddl_secondary_index_drop, reconcile_runtime_schemas,
};
pub(in crate::db) use runtime::{
    AcceptedFieldAbsencePolicy, AcceptedFieldDecodeContract, AcceptedGeneratedCompatibleRowShape,
    AcceptedRowDecodeContract, AcceptedRowLayoutRuntimeDescriptor, AcceptedRowLayoutRuntimeField,
};
pub(in crate::db) use snapshot::{
    AcceptedSchemaSnapshot, PersistedEnumVariant, PersistedFieldKind, PersistedFieldOrigin,
    PersistedFieldSnapshot, PersistedIndexExpressionOp, PersistedIndexExpressionSnapshot,
    PersistedIndexFieldPathSnapshot, PersistedIndexKeyItemSnapshot, PersistedIndexKeySnapshot,
    PersistedIndexOrigin, PersistedIndexSnapshot, PersistedNestedLeafSnapshot,
    PersistedRelationStrength, PersistedSchemaSnapshot, SchemaFieldDefault, SchemaFieldWritePolicy,
};
pub use store::SchemaStore;
pub(in crate::db::schema) use transition::{
    SchemaTransitionDecision, SchemaTransitionPlanKind, decide_schema_transition,
};
pub(crate) use types::{FieldType, ScalarType, field_type_from_model_kind, literal_matches_type};
pub(in crate::db) use types::{
    canonicalize_strict_sql_literal_for_persisted_kind, field_type_from_persisted_kind,
};