Skip to main content

ic_db/
lib.rs

1#![forbid(unsafe_code)]
2//! Experimental IC database: compiled schemas and synchronous bounded records.
3//! Schema modules can import the declaration attributes and value types from
4//! [`design::prelude`].
5//!
6//! This M1 slice supports 8/16/32/64/128-bit integers, U256, Ulid, Date, Timestamp, Duration, Decimal,
7//! finite Float32/Float64, Bool, Principal, Account/Subaccount and bounded Text/Blob, with optional
8//! values. Named records and unit/payload enums support bounded recursion via explicit
9//! indirection and ordered lists; traversals share byte, depth, structured-value
10//! and total collection-item limits. Sets/maps use strict scalar/unit-enum key order.
11//! Secondary indexes admit integers, Ulid, Date, Timestamp, Duration, Decimal, finite floats,
12//! Account/Subaccount, Principal, Bool, Text, Blob and unit enums, including optional values; primary keys
13//! require non-optional integer, U256, Ulid, Principal, Account or Subaccount fields. References use
14//! the target’s exact key type;
15//! absence has no target, while every present target must survive the batch.
16//! Atomicity relies on the enclosing IC message: after persistent mutation starts,
17//! supplier failures trap. A later application trap also rolls back the batch.
18//! Native callers must discard their runtime after a mutation panic. No SQL,
19//! endpoint exports, automatic migration or production compatibility is promised.
20//!
21//! Payload enums cannot become index keys, even when a row selects a unit variant:
22//! ```compile_fail
23//! use ic_db::{entity, enum_};
24//! #[enum_(variant(name="Empty"), variant(name="Data", value(item(prim="Nat8"))))]
25//! struct State {}
26//! #[entity(pk(field="id"), index(field="state"), fields(
27//!     field(name="id", value(item(prim="Nat64"))),
28//!     field(name="state", value(opt, item(is="State")))
29//! ))]
30//! struct Row {}
31//! ```
32//! Payload enums also lack the generated ordering required by sets/maps:
33//! ```compile_fail
34//! use ic_db::{enum_, set};
35//! #[enum_(variant(name="Empty"), variant(name="Data", value(item(prim="Nat8"))))]
36//! struct State {}
37//! #[set(item(is="State"), max_items=3)]
38//! struct States {}
39//! ```
40
41#[doc(hidden)]
42mod codec;
43mod date;
44mod decimal;
45mod defaults;
46mod float;
47mod key;
48mod managed;
49mod primary;
50mod schema;
51mod store;
52mod store_key;
53mod time;
54mod types;
55mod ulid;
56
57#[cfg(all(feature = "build", not(target_arch = "wasm32")))]
58pub mod build;
59
60#[cfg(all(feature = "test-support", not(target_arch = "wasm32")))]
61pub mod testing;
62
63/// Emit constructor registration only in explicitly selected host schema builds.
64#[doc(hidden)]
65#[cfg(all(feature = "build", not(target_arch = "wasm32")))]
66#[macro_export]
67macro_rules! __register_schema {
68    ($($item:item)*) => { $($item)* };
69}
70
71#[doc(hidden)]
72#[cfg(not(all(feature = "build", not(target_arch = "wasm32"))))]
73#[macro_export]
74macro_rules! __register_schema {
75    ($($item:item)*) => {};
76}
77
78pub use date::Date;
79pub use decimal::{Decimal, ParseDecimalError};
80pub use defaults::{InsertInput, LiteralDefault};
81/// Exact unsigned 256-bit integer. IC DB owns its durable and index encodings.
82pub use ethnum::U256;
83pub use float::{Float32, Float64};
84pub use ic_db_macros::{entity, enum_, list, map, newtype, record, set};
85pub use ic_platform_types::{Account, Principal, Subaccount};
86pub use key::IndexValue;
87pub use managed::ManagedTimestamp;
88pub use primary::PrimaryKey;
89pub use time::{Duration, TimeParseError, Timestamp};
90pub use ulid::{Ulid, UlidGenerationError, UlidGenerator, UlidParseError};
91/// Owned binary bytes. The database codec enforces authored limits and row bounds.
92pub type Blob = Vec<u8>;
93pub use schema::{EntitySchema, FieldSchema, FieldType, IndexSchema, ReferenceSchema, Schema};
94pub use store::{
95    Aggregate, AggregateJobs, Batch, Comparison, CopyStep, Database, GroupCount, GroupCursor,
96    GroupOrder, GroupPage, GroupValue, JobHandle, JobOutcome, JobStep, Maintenance, Page, Query,
97    QueryCursor, QueryOperand, QueryPage, RetiredSource, SchemaCopy, SchemaTransition,
98    SortDirection,
99};
100pub use store_key::MAX_INDEX_KEY_BYTES;
101
102/// Failure before commit begins, or a refusal to admit stored data.
103#[derive(Debug)]
104pub enum Error {
105    /// Ordinary access is closed by an admitted durable maintenance gate.
106    Maintenance,
107    /// A maintenance identity is invalid or does not match this source/active transition.
108    InvalidTransition,
109    /// The retained job handle, query, result shape or requested sequence does not match.
110    InvalidJob,
111    /// All retained job slots are occupied; cancel or clean up expired jobs explicitly.
112    JobCapacity,
113    /// An arithmetic total exceeds its accumulator or explicitly selected result range.
114    ArithmeticOverflow,
115    /// Unsupported query field/shape or unavailable ordered access path.
116    InvalidQuery,
117    /// Malformed continuation or a different database/schema/query boundary.
118    InvalidCursor,
119    /// One matching encoded row exceeds the whole requested output-byte allowance.
120    RowTooLarge,
121    /// Managed insert/replacement requires an explicitly captured batch time.
122    MissingOperationTime,
123    /// A caller attempted to assign a database-managed field.
124    ManagedField,
125    /// A real change would move managed time behind its stored value.
126    TimestampRegression,
127    /// An insert input omitted a required field with no declared default.
128    MissingField(&'static str),
129    /// Invalid or unsupported compiled schema.
130    InvalidSchema,
131    /// An index operand has a different exact type from its declared field.
132    InvalidOperand,
133    /// The typed entity is not part of this admitted schema.
134    UnknownEntity,
135    /// The stored manifest belongs to another schema or format.
136    IncompatibleSchema,
137    /// Missing, malformed or internally inconsistent stored data.
138    Corrupt,
139    /// Insert requires an absent primary key.
140    Exists,
141    /// Replacement/deletion requires an existing primary key.
142    Missing,
143    /// Two batch commands address the same entity and primary key.
144    DuplicateTarget,
145    /// The intended final state violates a unique index.
146    UniqueViolation,
147    /// A reference target is absent, or a deleted target still has a dependent.
148    ReferenceViolation,
149    /// A declared resource bound or revision range is exceeded.
150    Limit,
151}
152
153impl std::fmt::Display for Error {
154    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
155        write!(f, "{self:?}")
156    }
157}
158impl std::error::Error for Error {}
159
160pub use types::{TypeBody, TypeLink, TypeSchema, Value, ValueSchema, VariantSchema};
161
162/// Schema authoring for application design modules.
163pub mod design {
164    /// Declaration attributes, database scalar types and schema assembly.
165    ///
166    /// ```
167    /// use ic_db::design::prelude::*;
168    ///
169    /// #[newtype(item(prim = "Timestamp"))]
170    /// struct StartedAt {}
171    ///
172    /// #[list(item(is = "StartedAt"), max_items = 3)]
173    /// struct StartHistory {}
174    ///
175    /// #[entity(pk(field = "id"), fields(
176    ///     field(name = "id", value(item(prim = "Nat64"))),
177    ///     field(name = "history", value(item(is = "StartHistory")))
178    /// ))]
179    /// struct Event {}
180    ///
181    /// let event = Event { id: 1, history: StartHistory(vec![StartedAt(Timestamp::from_millis(0))]) };
182    /// let schema = Schema::new(&[Event::SCHEMA]).unwrap();
183    /// assert_eq!(schema.entities()[0].name, "Event");
184    /// assert_eq!(event.history.0.len(), 1);
185    /// ```
186    pub mod prelude {
187        pub use crate::{
188            Account, Blob, Date, Decimal, Duration, Float32, Float64, Principal, Subaccount,
189            Timestamp, U256, Ulid,
190        };
191        pub use crate::{Entity, Schema, Value};
192        pub use crate::{entity, enum_, list, map, newtype, record, set};
193    }
194}
195
196/// Codec boundary emitted by `#[entity]`; hand-written implementations are unsupported.
197/// Typed references use Rust resolution; an unresolved name fails compilation:
198/// ```compile_fail
199/// use ic_db::entity;
200/// #[entity(pk(field="id"), index(field="target"), fields(
201///     field(name="id",value(item(prim="Nat64"))),
202///     field(name="target",value(item(prim="Nat64")),references(entity="Missing"))))]
203/// struct Example {}
204/// ```
205/// Lookups require the declared key type; integers cannot stand in for ULIDs:
206/// ```compile_fail
207/// use ic_db::{entity, Database};
208/// #[entity(pk(field="id"), fields(field(name="id",value(item(prim="Ulid")))))]
209/// struct Asset {}
210/// fn wrong_key(db: &Database) { let _ = db.get::<Asset>(7_u64); }
211/// ```
212/// Integer key widths are exact, without implicit widening:
213/// ```compile_fail
214/// use ic_db::{entity, Database};
215/// #[entity(pk(field="id"), fields(field(name="id",value(item(prim="Nat8")))))]
216/// struct Small {}
217/// fn wrong_width(db: &Database) { let _ = db.get::<Small>(7_u64); }
218/// ```
219pub trait Entity: Sized {
220    /// Exact supplied primary-key type, selected by the declared field.
221    type Key: PrimaryKey;
222    /// Generated handle, also usable in cyclic typed references; not authored.
223    #[doc(hidden)]
224    const ID: u32;
225    /// Logical entity name under the stored contract.
226    const NAME: &'static str;
227    /// Rust-resolved declaration path for host schema assembly, not durable identity.
228    const PATH: &'static str;
229    /// This executable's compiled entity contract.
230    const SCHEMA: &'static EntitySchema;
231    /// Read the application's primary key without encoding or inspecting indexes.
232    fn key(&self) -> Self::Key;
233
234    /// Extract keys from an already typed value for the shared mutation/index paths.
235    #[doc(hidden)]
236    fn __row_info(&self) -> __private::RowInfo;
237
238    /// Validate declared field bounds before encoding; no persistent effects.
239    /// # Errors
240    /// Refuses values outside the authored field contract.
241    fn validate(&self) -> Result<(), Error>;
242
243    /// Encode canonical stored fields within the row envelope.
244    /// # Errors
245    /// Returns a limit refusal when the row cannot be encoded within its bounds.
246    fn encode(&self) -> Result<Vec<u8>, Error>;
247
248    /// Decode an admitted row; this does not open a database or admit a schema.
249    /// # Errors
250    /// Returns corruption for malformed stored bytes.
251    fn decode(bytes: &[u8]) -> Result<Self, Error>;
252}
253
254/// Implementation support for generated code; not a second query frontend.
255#[doc(hidden)]
256pub mod __private {
257    pub use crate::codec::{Decoder, Encoder, MAX_ROW_BYTES};
258    pub use crate::key::encode_index;
259    pub use crate::managed::validate_order as validate_managed_order;
260    pub use crate::primary::RowKey;
261    pub use crate::schema::handle;
262    /// Primary/index keys extracted at the small typed codec boundary.
263    pub struct RowInfo {
264        pub key: RowKey,
265        /// None means the row is outside an explicitly present-only unique index.
266        pub indexes: Vec<Option<Vec<u8>>>,
267    }
268}