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

//! # `pile` - a simple and fast append-only data store
//!
//! ## Design goals
//!
//! * Efficient adding of bug chunks of data.
//! * A user should be able to copy the storage data (for example, over the network)
//!   while still being able to use the database for both reads and writes.
//! * The storage should have a minimal dependency footprint.
//!
//! ## Usage guide
//!
//! ### Example
//!
//! ```rust,ignore
//! use data_pile::{Database, Record, serialization::BasicRecordSerializer};
//!
//! let db = Database::new("./pile", BasicRecordSerializer).unwrap();
//!
//! let key = b"qwerty";
//! let value = b"some data";
//!
//! let record = Record::new(&key[..], &value[..]);
//!
//! db.put(record).unwrap();
//! ```
//!
//! ### Transferring the data
//!
//! - Get the raw data by using `Database::snapshot()`.
//! - Copy it somewhere.
//! - Create the root direcotry of the data store, create a file named `data` in it
//!   and add all snapshot data into it.
//! - Just start using the database: it will verify correctness and rebuild all
//!   indexes.

#[cfg(test)]
#[macro_use(quickcheck)]
extern crate quickcheck_macros;

mod appender;
mod database;
mod error;
mod flatfile;
mod growable_mmap;
mod index;
mod page_index;
mod record;
mod seqno;
mod seqno_iter;
pub mod serialization;
#[cfg(test)]
mod testutils;

use appender::Appender;
pub use database::Database;
pub use error::Error;
pub use record::Record;
pub use seqno_iter::SeqNoIter;
pub use serialization::RecordSerializer;