icydb-core 0.218.1

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

//! Module: lib
//! Responsibility: crate root for the IcyDB core runtime surface.
//! Does not own: canister-facing facade APIs from the public `icydb` crate.
//! Boundary: exposes the engine subsystems used by schema, query, executor, and storage layers.

//! Core runtime for IcyDB: accepted-schema execution, values, storage, and
//! the low-level vocabulary exported through the facade.
#![warn(unreachable_pub)]
// The no-default test target intentionally type-checks shared test/helper
// surfaces whose consuming tests live behind SQL or diagnostics
// features. Keep production and all-features dead-code linting strict.
#![cfg_attr(
    all(test, not(feature = "sql")),
    expect(
        dead_code,
        reason = "shared test helpers have SQL and diagnostics consumers"
    )
)]
// The base build owns the complete engine-neutral planner/executor substrate.
// SQL is an optional frontend over that substrate and is currently the only
// consumer of some SQL explain, diagnostic, and frontend-extension capabilities,
// so those internal extension points are intentionally dormant without SQL.
#![cfg_attr(
    all(not(test), not(feature = "sql")),
    expect(
        dead_code,
        reason = "SQL-only explain, diagnostic, and frontend-extension capabilities remain intentionally dormant in base builds"
    )
)]

extern crate self as icydb;

#[macro_use]
pub(crate) mod scalar_registry;

// public exports are one module level down
pub mod db;
pub mod error;
pub mod metrics;
pub(crate) mod runtime;
pub mod traits;
pub mod types;
pub mod value;

#[cfg(test)]
pub(crate) mod testing;

///
/// CONSTANTS
///

/// Maximum number of indexed fields allowed on an entity.
///
/// This limit keeps hashed index keys within bounded, storable sizes and
/// simplifies sizing tests in the stores.
pub const MAX_INDEX_FIELDS: usize = 4;

///
/// Prelude
///
/// Prelude contains only domain vocabulary.
/// No errors, executors, stores, serializers, or helpers are re-exported here.
///

pub mod prelude {
    pub use crate::{
        traits::Path,
        value::{InputValue, OutputValue},
    };
}