modelvault-core 0.16.0

Core engine for ModelVault — application-focused embedded storage with model schemas, validation, and migrations.
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

//! Embedded ModelVault database engine: append-only segments, versioned schema catalog, and
//! last-write-wins row storage keyed by primary values.
//!
//! ## Stable API (0.16+)
//!
//! Prefer [`Database`], [`prelude`], and root type re-exports. Modules marked `#[doc(hidden)]`
//! are format/engine internals and may change in minor releases.
//!
//! Start with [`Database`] for open, register, insert, and get. Supporting types include
//! [`Catalog`], [`ScalarValue`], [`FieldDef`], and [`DbError`]. For a small import set, use
//! [`prelude`].

pub mod catalog;
#[doc(hidden)]
pub mod checkpoint;
#[doc(hidden)]
pub mod checksum;
pub mod config;
pub use config::{OpenMode, OpenOptions, OpenOptionsBuilder, OpenRecoveryInfo, RecoveryMode};
pub mod db;
pub mod error;
#[doc(hidden)]
pub mod file_format;
pub mod index;
#[doc(hidden)]
pub mod manifest;
pub mod migration;
#[doc(hidden)]
pub mod pager;
#[doc(hidden)]
pub mod publish;
pub mod query;
pub mod record;
pub mod schema;
pub mod schema_compat;
#[doc(hidden)]
pub mod segments;
#[doc(hidden)]
pub mod spill;
pub mod sql;
pub mod storage;
#[doc(hidden)]
pub mod superblock;
#[doc(hidden)]
pub mod txn;
pub mod validation;

pub use catalog::{Catalog, CatalogRecord, CollectionInfo};
pub use db::Database;
pub use db::{
    read_header_and_superblocks, scan_database_file, scan_database_store, select_superblock,
    DatabaseFileScan, DatabaseScanMode, SEGMENT_REGION_START,
};
pub use error::DbError;
pub use error::DbErrorKind;
pub use error::FormatError;
pub use error::SchemaError;
pub use error::TransactionError;
pub use error::ValidationError;
pub use migration::{MigrationPlan, MigrationStep};
pub use record::RowValue;
pub use record::ScalarValue;
pub use schema::CollectionId;
pub use schema::CollectionSchema;
pub use schema::Constraint;
pub use schema::DbModel;
pub use schema::FieldDef;
pub use schema::IndexDef;
pub use schema::IndexKind;
pub use schema::SchemaVersion;
pub use schema::Type;
pub use schema_compat::classify_schema_update;
pub use schema_compat::validate_model_fields_against_catalog;

/// Convenient re-exports for typical application code (`Database`, schema types, [`DbError`]).
pub mod prelude {
    pub use crate::catalog::{Catalog, CollectionInfo};
    pub use crate::db::Database;
    pub use crate::error::DbError;
    pub use crate::record::RowValue;
    pub use crate::record::ScalarValue;
    pub use crate::schema::CollectionId;
    pub use crate::schema::CollectionSchema;
    pub use crate::schema::DbModel;
    pub use crate::schema::FieldDef;
    pub use crate::schema::IndexDef;
    pub use crate::schema::IndexKind;
    pub use crate::schema::SchemaVersion;
}