datom 0.1.1-pre4

datom-rs: an open-source database inspired by Datomic
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

// SPDX-FileCopyrightText: 2021 Lutris Engineering, Inc
// SPDX-License-Identifier: BlueOak-1.0.0 OR BSD-2-Clause-Patent
// SPDX-FileContributor: Piper McCorkle <piper@lutris.engineering>

#![feature(generic_associated_types, map_first_last, once_cell)]
#![deny(missing_docs)]
#![warn(clippy::nursery, clippy::cargo)]
#![doc(
    html_logo_url = "https://avatars.githubusercontent.com/u/85201395?s=200&v=4",
    html_favicon_url = "https://lutris.engineering/favicon-32x32.png"
)]

//! An open-source database inspired by Datomic.
//!
//! ```
//! // SPDX-FileCopyrightText: 2021 Lutris Engineering, Inc
//! // SPDX-License-Identifier: BlueOak-1.0.0 OR BSD-2-Clause-Patent
//! // SPDX-FileContributor: Piper McCorkle <piper@lutris.engineering>
//! ```
//!
//! Currently built on top of [sled], a modern embedded database, and is
//! only suitable for embedded usage. Future multi-peer support is
//! planned.
//!
//! If you aren't already familiar with Datomic, it might help to look
//! over [Datomic's excellent documentation]. To the user, datom-rs
//! functions extremely similarly to Datomic.
//!
//! ```
//! use datom::{backends::SledStorage, Connection, EntityResult, Transaction, Value, ID};
//!
//! // Use the sled storage backend to create a temporary database
//! let storage = SledStorage::connect_temp()?;
//!
//! // Create a connection from that backend
//! let conn = Connection::new(storage);
//!
//! // Create an ID to use for the username attribute
//! let username = ID::new();
//! // Create an ID to use for the user's entity
//! let user = ID::new();
//!
//! // Create a transaction setting the username attribute on the user
//! // entity to "pmc"
//! let mut tx = Transaction::new();
//! tx.add(user.into(), username.into(), "pmc".into());
//! // Execute the transaction using the connection
//! conn.transact(tx)?;
//!
//! // Get a view of the database in the current point in time
//! let db = conn.db()?;
//! // Get the value of the username attribute on the user entity
//! if let EntityResult::Value(Value::String(u)) = db.entity(user.into())?.get(username.into())? {
//!     println!("The user's username is {}.", u);
//! }
//! # assert_eq!(db.entity(user.into())?.get(username.into())?, EntityResult::Value("pmc".into()));
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! [sled]: https://sled.rs
//! [Datomic's excellent documentation]: https://docs.datomic.com/on-prem/overview/architecture.html

mod types;
pub use types::*;

/// Serialization/deserialization functions
pub mod serial;

/// IDs for the built-in attributes and other idents
pub mod builtin_idents;

mod merge_iters;
pub use merge_iters::*;

/// API for storage backends
pub mod storage;

/// Storage backends
pub mod backends;