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