noxu-db 3.0.2

Noxu DB - An embedded transactional database engine
Documentation 
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

// Copyright (C) 2024-2025 Greg Burd.  Licensed under either of the
// Apache License, Version 2.0 or the MIT license, at your option.
// See LICENSE-APACHE and LICENSE-MIT at the root of this repository.
// SPDX-License-Identifier: Apache-2.0 OR MIT

#![allow(
    dead_code,
    unused_macros,
    unused_imports,
    clippy::type_complexity,
    clippy::too_many_arguments
)]
//! > **Internal component of the [`noxu`](https://crates.io/crates/noxu) database.**
//! >
//! > This crate is published only so the `noxu` umbrella crate can depend on it.
//! > Use `noxu` (`noxu = "3"`) in applications; depend on this crate directly only
//! > if you are extending the engine internals. Its API may change without a major
//! > version bump.
//!
//! Noxu DB - An embedded transactional database engine.
//!
//! Public API : Environment, Database,
//! Cursor, Transaction, DatabaseEntry, SecondaryDatabase, Sequence, etc.
//!
//! This crate provides the public API for Noxu DB.
//! It is designed to be familiar to embedded database users while being
//! idiomatic Rust.
//!
//! # Example
//!
//! ```no_run
//! use noxu_db::{EnvironmentConfig, DatabaseConfig};
//! use std::path::PathBuf;
//!
//! let env_config = EnvironmentConfig::new(PathBuf::from("/tmp/mydb"))
//!     .with_allow_create(true)
//!     .with_transactional(true);
//!
//! let db_config = DatabaseConfig::new()
//!     .with_allow_create(true)
//!     .with_transactional(true);
//! ```

#[macro_use]
mod observe;

/// Re-export of the observability crate when the `observability` feature is enabled.
/// Users can access `noxu_db::observe_crate::{metrics, tracing}` for their own
/// recorder/subscriber setup.
#[cfg(feature = "observability")]
pub use noxu_observe as observe_crate;

pub mod cache_mode;
pub mod checkpoint_config;
pub mod cursor;
pub mod cursor_config;
pub mod database;
pub mod database_config;
pub mod database_entry;
pub mod database_stats;
pub mod db_iter;
pub mod disk_ordered_cursor;
pub mod durability;
pub mod environment;
pub mod environment_config;
pub mod environment_mutable_config;
pub mod error;
pub mod extinction_filter;
pub mod get;
pub mod join_config;
pub mod join_cursor;
pub mod lock_mode;
pub mod operation_result;
pub mod operation_status;
pub mod preload;
pub mod put;
pub mod read_options;
pub mod scan_filter;
pub mod secondary_config;
pub mod secondary_cursor;
pub mod secondary_database;
pub mod sequence;
pub mod sequence_config;
pub mod sequence_stats;
pub mod stats_config;
pub mod transaction;
pub mod transaction_config;
pub mod write_options;

// Re-export commonly used types
pub use cache_mode::CacheMode;
pub use checkpoint_config::CheckpointConfig;
pub use cursor::Cursor;
pub use cursor_config::CursorConfig;
pub use database::Database;
pub use database_config::DatabaseConfig;
pub use database_entry::DatabaseEntry;
pub use database_stats::{BtreeStats, DatabaseStats};
pub use db_iter::{DbIter, DbRange};
pub use disk_ordered_cursor::{
    DiskOrderedCursor, DiskOrderedCursorConfig, open_disk_ordered_cursor_multi,
};
pub use durability::{Durability, ReplicaAckPolicy, SyncPolicy};
pub use environment::Environment;
pub use environment_config::{EnvironmentConfig, ExceptionListenerHolder};
pub use environment_mutable_config::EnvironmentMutableConfig;
pub use error::{
    EnvironmentFailureReason, ExceptionEvent, ExceptionListener,
    ExceptionSource, NoxuError, Result,
};
pub use extinction_filter::{ExtinctionFilter, ExtinctionStatus};
pub use get::Get;
pub use join_config::JoinConfig;
pub use join_cursor::JoinCursor;
pub use lock_mode::LockMode;
pub use noxu_engine::{
    EnvironmentStats, VerifyConfig, VerifyError, VerifyResult,
};
pub use operation_result::OperationResult;
pub use operation_status::OperationStatus;
pub use preload::{PreloadConfig, PreloadStats};
pub use put::Put;
pub use read_options::ReadOptions;
pub use scan_filter::{ScanFilter, ScanResult};
pub use secondary_config::{
    ForeignKeyDeleteAction, ForeignKeyNullifier, ForeignMultiKeyNullifier,
    SecondaryConfig, SecondaryKeyCreator, SecondaryMultiKeyCreator,
};
pub use secondary_cursor::SecondaryCursor;
pub use secondary_database::SecondaryDatabase;
pub use sequence::Sequence;
pub use sequence_config::SequenceConfig;
pub use sequence_stats::SequenceStats;
pub use stats_config::StatsConfig;
pub use transaction::Transaction;
pub use transaction_config::TransactionConfig;
pub use write_options::WriteOptions;