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