oxirs-tdb 0.4.1

Apache Jena TDB/TDB2 compatible RDF storage engine with B+Tree indexes
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
//! # OxiRS TDB - Apache Jena TDB/TDB2 Compatible Storage Engine
//!
//! [![Version](https://img.shields.io/badge/version-0.4.1-blue)](https://github.com/cool-japan/oxirs/releases)
//!
//! **Status**: Production Release (v0.4.1)
//! **Stability**: Public APIs are stable. Production-ready with comprehensive testing.
//!
//! High-performance RDF triple store with B+Tree indexes, ACID transactions,
//! and Apache Jena TDB/TDB2 API compatibility.
//!
//! ## Features
//!
//! - **B+Tree Storage** - Efficient range queries and sequential scans
//! - **Triple Indexes** - SPO, POS, OSP for optimal query performance
//! - **ACID Transactions** - Write-Ahead Logging (WAL) with 2PL concurrency control
//! - **Dictionary Encoding** - Compress IRIs and literals to 8-byte NodeIDs
//! - **Buffer Pool** - LRU caching for hot pages
//! - **100M+ Triples** - Scalable to large datasets
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use oxirs_tdb::TdbStore;
//! # fn example() -> Result<(), Box<dyn std::error::Error>> {
//! // Create a new TDB store
//! let mut store = TdbStore::open("/path/to/data")?;
//!
//! // Insert triples
//! // store.insert(...)?;
//!
//! // Query triples
//! // let results = store.query(...)?;
//!
//! # Ok(())
//! # }
//! ```
//!
//! ## Architecture
//!
//! ```text
//! ┌─────────────────────────────────────────┐
//! │         TdbStore (High-level API)       │
//! └─────────────────┬───────────────────────┘
//!//!       ┌───────────┴───────────┐
//!       │                       │
//! ┌─────▼─────┐         ┌──────▼──────┐
//! │  Indexes  │         │ Dictionary  │
//! │ SPO/POS/  │         │   Encoding  │
//! │    OSP    │         │             │
//! └─────┬─────┘         └──────┬──────┘
//!       │                      │
//!       └───────────┬──────────┘
//!//!            ┌──────▼──────┐
//!            │   B+Tree    │
//!            └──────┬──────┘
//!//!       ┌───────────┴───────────┐
//!       │                       │
//! ┌─────▼─────┐         ┌──────▼──────┐
//! │  Buffer   │         │     WAL     │
//! │   Pool    │         │  (Logging)  │
//! └─────┬─────┘         └──────┬──────┘
//!       │                      │
//!       └───────────┬──────────┘
//!//!            ┌──────▼──────┐
//!            │ File Manager│
//!            │   (mmap)    │
//!            └─────────────┘
//! ```
//!
//! ## See Also
//!
//! - [`oxirs-core`](https://docs.rs/oxirs-core) - RDF data model
//! - [`oxirs-arq`](https://docs.rs/oxirs-arq) - SPARQL query engine

#![doc(html_root_url = "https://docs.rs/oxirs-tdb/0.4.1")]
#![warn(missing_docs)]
// NOTE: The former crate-wide `#![allow(dead_code/unused_imports/unused_variables)]`
// has been removed so the hardened durability core (storage/superblock,
// storage/file_manager, storage/buffer_pool, btree, index/triple_index,
// dictionary, store/store_impl, loader/bulk_loader) compiles strictly. The
// allows are re-applied per-module below only to the modules NOT in that core
// (many owned by other agents or peripheral to this pass), where resolving the
// pre-existing dead code is out of scope for the durability work.

// Core modules
pub mod error;

// Storage layer (peripheral submodules scoped inside storage/mod.rs)
pub mod storage;

// B+Tree implementation
pub mod btree;
#[allow(dead_code, unused_imports, unused_variables)]
pub mod btree_index;

// Index structures (peripheral submodules scoped inside index/mod.rs)
pub mod index;

// Dictionary encoding
pub mod dictionary;

// Transaction management
#[allow(dead_code, unused_imports, unused_variables)]
pub mod transaction;

// Consensus algorithms for distributed coordination
#[allow(dead_code, unused_imports, unused_variables)]
pub mod consensus;

// Distributed coordination and replication
#[allow(dead_code, unused_imports, unused_variables)]
pub mod distributed;

// Data loading utilities (peripheral submodules scoped inside loader/mod.rs)
pub mod loader;

// Compression and optimization
#[allow(dead_code, unused_imports, unused_variables)]
pub mod compression;

// High-level store API (peripheral submodules scoped inside store/mod.rs)
pub mod store;

// Production hardening features
#[allow(dead_code, unused_imports, unused_variables)]
pub mod production;

// Backup and restore utilities
#[allow(dead_code, unused_imports, unused_variables)]
pub mod backup;

// Backup encryption for data at rest
#[allow(dead_code, unused_imports, unused_variables)]
pub mod backup_encryption;

// Online backup without downtime
#[allow(dead_code, unused_imports, unused_variables)]
pub mod online_backup;

// Crash recovery and corruption detection
#[allow(dead_code, unused_imports, unused_variables)]
pub mod recovery;

// Query hint support
#[allow(dead_code, unused_imports, unused_variables)]
pub mod query_hints;

// Query result caching
#[allow(dead_code, unused_imports, unused_variables)]
pub mod query_cache;

// Cost-based query optimization with StatisticsSnapshot integration
#[allow(dead_code, unused_imports, unused_variables)]
pub mod query_optimizer;

// Join order optimization for query planning
#[allow(dead_code, unused_imports, unused_variables)]
pub mod query_join_optimizer;

// Adaptive query execution with runtime plan adjustment
#[allow(dead_code, unused_imports, unused_variables)]
pub mod adaptive_execution;

// Statistics collection for cost-based optimization
#[allow(dead_code, unused_imports, unused_variables)]
pub mod statistics;

// Slow query logging and analysis for production monitoring
#[allow(dead_code, unused_imports, unused_variables)]
pub mod slow_query_log;

// Query timeout enforcement for production safety
#[allow(dead_code, unused_imports, unused_variables)]
pub mod query_timeout;

// Query monitoring (timeout enforcement and slow query logging)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod query_monitor;

// Advanced diagnostic tools
#[allow(dead_code, unused_imports, unused_variables)]
pub mod diagnostics;
#[allow(dead_code, unused_imports, unused_variables)]
pub mod diagnostics_collectors;
#[allow(dead_code, unused_imports, unused_variables)]
pub mod diagnostics_tests;
#[allow(dead_code, unused_imports, unused_variables)]
pub mod diagnostics_types;

// Advanced diagnostic tools (monitoring and analysis)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod advanced_diagnostics;
#[allow(dead_code, unused_imports, unused_variables)]
pub mod advanced_diagnostics_engine;
#[cfg(test)]
#[allow(dead_code, unused_imports, unused_variables)]
mod advanced_diagnostics_tests;
#[allow(dead_code, unused_imports, unused_variables)]
pub mod advanced_diagnostics_types;

// High-performance operations using SciRS2-Core
#[allow(dead_code, unused_imports, unused_variables)]
pub mod performance;

// Bulk operations for high-throughput processing
#[allow(dead_code, unused_imports, unused_variables)]
pub mod bulk_operations;

// RDF-star support for quoted triples
#[allow(dead_code, unused_imports, unused_variables)]
pub mod rdf_star;

// Connection pooling for multi-client access
#[allow(dead_code, unused_imports, unused_variables)]
pub mod connection_pool;

// Connection pool optimizer (advanced pool management)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod connection_pool_optimizer;

// Query resource quotas for per-query resource limiting
#[allow(dead_code, unused_imports, unused_variables)]
pub mod query_resource_quota;

// Materialized views for query acceleration
#[allow(dead_code, unused_imports, unused_variables)]
pub mod materialized_views;

// WAL archiving for point-in-time recovery
#[allow(dead_code, unused_imports, unused_variables)]
pub mod wal_archive;

// WAL shipping for continuous archiving
#[allow(dead_code, unused_imports, unused_variables)]
pub mod wal_shipping;

// Cloud storage integration (S3, GCS, Azure)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod cloud_storage;

// Database operations and management
#[allow(dead_code, unused_imports, unused_variables)]
pub mod database_ops;

// Observability and monitoring
#[allow(dead_code, unused_imports, unused_variables)]
pub mod observability;

// Full-text search over RDF literals (Tantivy-backed).
// Gated behind the non-default `full-text-search` feature so the default build
// stays Pure Rust (Tantivy pulls C `zstd-sys`). See Cargo.toml.
#[cfg(feature = "full-text-search")]
#[allow(dead_code, unused_imports, unused_variables)]
pub mod text_search;

// Bloom filter for probabilistic triple existence checks
#[allow(dead_code, unused_imports, unused_variables)]
pub mod bloom_filter;

// Re-export commonly used types
pub use backup_encryption::{BackupEncryption, EncryptedData, EncryptionConfig};
pub use bulk_operations::{
    BulkStats, BulkTripleProcessor, ParallelPipelineBuilder, StreamingTripleIterator,
};
pub use compression::{
    DeltaStoreConfig, DeltaStoreStats, EncodedDeltaLog, TripleDelta, TripleDeltaStore,
};
pub use connection_pool::{ConnectionPool, ConnectionPoolConfig, ConnectionPoolStatsSnapshot};
pub use database_ops::{
    CompactionStats, DatabaseMetadata, DatabaseOps, DatabaseStatus, RepairReport,
};
pub use error::{Result, TdbError};
pub use index::{BTreeTripleIndex, EncodedTriple, TripleIndexSet, TripleOrdering};
pub use loader::{BulkLoadStats, BulkLoader, BulkLoaderConfig, BulkLoaderFactory};
pub use loader::{
    NodeDictionary, ParallelBulkLoadConfig, ParallelBulkLoadStats, ParallelBulkLoader, RawTriple,
    RdfNode, TripleSource, VecTripleSource,
};
pub use materialized_views::{
    MaterializedView, MaterializedViewConfig, MaterializedViewManager,
    MaterializedViewManagerStats, RefreshStrategy, ViewInfo,
};
pub use observability::{
    HealthCheck, HealthCheckResult, HealthCheckResults, HealthStatus, MetricSnapshot,
    ObservabilityConfig, ObservabilityManager, TraceSpan, TraceSpanId,
};
pub use online_backup::{
    OnlineBackupManager, OnlineBackupStats, Snapshot, SnapshotConfig, SnapshotId, SnapshotStatus,
};
pub use query_resource_quota::{
    QueryQuotaStats, QueryResourceQuotaConfig, QueryResourceQuotaManager, QueryResourceTracker,
    QueryResourceUsage,
};
pub use store::{
    CompressionAlgorithm, GraphName, GraphTarget, QuadResult, QuadTermIter, ReplicationMode,
    StoreParams, StoreParamsBuilder, StorePresets, TdbConfig, TdbStats, TdbStore, TripleTermIter,
};
pub use wal_archive::{
    WalArchiveConfig, WalArchiveMetadata, WalArchiver, WalArchiverStatsSnapshot,
};
pub use wal_shipping::{
    ShippingConfig, ShippingDestination, ShippingRecord, ShippingStats, ShippingStatus, WalShipper,
};

// Temporal RDF: version control and time-travel queries (v0.3.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod temporal;

pub use temporal::{
    ChangeEntry, ChangeLog, ChangeLogStats, ChangeOperation, TemporalDiff, TemporalSnapshot,
    TemporalVersionStore, TimeTravelQuery, TimeTravelQueryBuilder, TripleKey, TriplePattern,
    VersionedTriple,
};

/// TDB storage engine version
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Default page size (4KB)
pub const DEFAULT_PAGE_SIZE: usize = 4096;

/// Default buffer pool size (1000 pages = 4MB)
pub const DEFAULT_BUFFER_POOL_SIZE: usize = 1000;

// MVCC Transaction Manager: snapshot isolation and SSI (v0.3.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod mvcc;

pub use mvcc::deadlock::{DeadlockDetector, DeadlockScanResult};
pub use mvcc::{
    IsolationLevel, MvccError, MvccManager, MvccStats, TransactionContext, TransactionState, TxId,
    VersionedEntry, VersionedKey, TX_ID_COMMITTED,
};

// Multi-tenant isolation (v1.0.0 LTS)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod tenant;

pub use tenant::{
    TenantAuditEvent, TenantAuditLog, TenantConfig, TenantError, TenantHandle, TenantId,
    TenantIsolationLayer, TenantRegistry, TenantResult, TenantStats, TenantStore,
};

// TDB2-compatible data format (v1.1.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod tdb2;

pub use tdb2::{NodeTable, RdfTerm, Tdb2Database, Tdb2Format, TripleIndex};

// Backup engine: triple-level backup/restore with format + compression (v0.2.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod backup_engine;

pub use backup_engine::{
    BackupCompression, BackupDelta, BackupEngine, BackupFormat, BackupManifest, IncrementalBackup,
};

// Advanced SLA monitoring and enforcement (v0.2.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod sla;

pub use sla::{SlaComplianceReport, SlaMonitor, SlaViolation, StorageSla, ViolationType};

// Dataset import/export formats: CSV-RDF, JSON-LD, N-Quads (v0.2.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod formats;

pub use formats::{CsvRdfMapper, JsonLdImporter, NQuadsExporter, NQuadsImporter, RdfColumnType};

// WAL compaction and point-in-time recovery (v1.1.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod wal_compaction;

// LSM-tree compaction strategy with bloom filters (v1.1.0)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod lsm_compaction;

// v1.2.0 Compressed prefix table for IRI storage
#[allow(dead_code, unused_imports, unused_variables)]
pub mod prefix_table;

// v1.2.0 Triple store cardinality estimator for query optimization
#[allow(dead_code, unused_imports, unused_variables)]
pub mod index_statistics;

// v1.5.0 Write-ahead journal for crash recovery
#[allow(dead_code, unused_imports, unused_variables)]
pub mod journal;

/// Write buffer for batching triple insertions (v1.6.0).
#[allow(dead_code, unused_imports, unused_variables)]
pub mod triple_buffer;

/// Background compaction task scheduler (v1.7.0).
#[allow(dead_code, unused_imports, unused_variables)]
pub mod compaction_scheduler;

/// Atomic batch write operations with WAL integration (v1.8.0).
#[allow(dead_code, unused_imports, unused_variables)]
pub mod write_batch;

/// Database checkpoint management for crash recovery and WAL truncation (v1.9.0).
#[allow(dead_code, unused_imports, unused_variables)]
pub mod checkpoint_manager;

/// Database vacuuming and compaction: dead-space detection, fragmentation analysis, online vacuum (v2.0.0).
#[allow(dead_code, unused_imports, unused_variables)]
pub mod vacuum;

/// B-tree index rebuild from raw triple data: SPO/POS/OSP/GSPO/GPOS/GOSP orders,
/// sorted IndexEntry generation, rebuild statistics, and sortedness verification (v1.1.0 round 14)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod index_rebuilder;

/// Triple pattern cache: memoize repeated pattern lookups using LRU eviction (v1.1.0 round 15)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod triple_cache;

/// Bloom filter index for fast triple existence checks: FNV double-hashing,
/// capacity-tuned bit array, TripleBloomIndex wrapper (v1.1.0 round 16)
#[allow(dead_code, unused_imports, unused_variables)]
pub mod bloom_index;

/// Six-index triple store (SPO/POS/OSP and derived patterns) for O(log n)
/// pattern matching — used in TDB2 parity verification.
#[allow(dead_code, unused_imports, unused_variables)]
pub mod six_index_store;

pub use wal_compaction::{
    BaseSnapshot, CompactionConfig, CompactionStats as WalCompactionStats, PitrConfig, PitrEngine,
    RecoveryPlan, WalCompactor, WalRecord, WalRecordType, WalSegment,
};