kitedb 0.2.2

High-performance embedded graph database
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

//! Python bindings for KiteDB using PyO3
//!
//! Exposes SingleFileDB and related types to Python.
//!
//! ## Module Structure
//!
//! - `database` - Core Database class and main operations
//! - `types` - Basic types (PropValue, Edge, FullEdge, NodeProp, etc.)
//! - `options` - Configuration options (OpenOptions, BackupOptions, etc.)
//! - `stats` - Statistics and metrics types
//! - `ops` - Operation implementations organized by domain
//! - `helpers` - Internal helper functions
//! - `traversal` - Traversal result types
//! - `vector` - Vector index types

// PyO3's #[pymethods] macro generates code that triggers false positives
// for clippy::useless_conversion on PyResult return types.
// See: https://github.com/PyO3/pyo3/issues/4759
#![cfg_attr(feature = "python", allow(clippy::useless_conversion))]

#[cfg(feature = "python")]
pub mod database;
#[cfg(feature = "python")]
pub mod helpers;
#[cfg(feature = "python")]
pub mod ops;
#[cfg(feature = "python")]
pub mod options;
#[cfg(feature = "python")]
pub mod stats;
#[cfg(feature = "python")]
pub mod traversal;
#[cfg(feature = "python")]
pub mod types;
#[cfg(feature = "python")]
pub mod vector;

#[cfg(feature = "python")]
pub use database::*;
#[cfg(feature = "python")]
pub use traversal::*;
#[cfg(feature = "python")]
pub use vector::*;

#[cfg(feature = "python")]
use pyo3::prelude::*;

/// KiteDB Python module
#[cfg(feature = "python")]
#[pymodule]
#[pyo3(name = "_kitedb")]
pub fn kitedb(m: &Bound<'_, PyModule>) -> PyResult<()> {
  // Database class
  m.add_class::<database::PyDatabase>()?;

  // Options classes
  m.add_class::<options::OpenOptions>()?;
  m.add_class::<options::SyncMode>()?;
  m.add_class::<options::CompressionOptions>()?;
  m.add_class::<options::SingleFileOptimizeOptions>()?;
  m.add_class::<options::VacuumOptions>()?;
  m.add_class::<options::ExportOptions>()?;
  m.add_class::<options::ImportOptions>()?;
  m.add_class::<options::StreamOptions>()?;
  m.add_class::<options::PaginationOptions>()?;
  m.add_class::<options::BackupOptions>()?;
  m.add_class::<options::RestoreOptions>()?;
  m.add_class::<options::OfflineBackupOptions>()?;

  // Stats classes
  m.add_class::<stats::DbStats>()?;
  m.add_class::<stats::CheckResult>()?;
  m.add_class::<stats::CacheStats>()?;
  m.add_class::<stats::CacheLayerMetrics>()?;
  m.add_class::<stats::CacheMetrics>()?;
  m.add_class::<stats::DataMetrics>()?;
  m.add_class::<stats::MvccMetrics>()?;
  m.add_class::<stats::MvccStats>()?;
  m.add_class::<stats::MemoryMetrics>()?;
  m.add_class::<stats::DatabaseMetrics>()?;
  m.add_class::<stats::HealthCheckEntry>()?;
  m.add_class::<stats::HealthCheckResult>()?;

  // Types classes
  m.add_class::<types::PropValue>()?;
  m.add_class::<types::Edge>()?;
  m.add_class::<types::FullEdge>()?;
  m.add_class::<types::NodeProp>()?;
  m.add_class::<types::NodeWithProps>()?;
  m.add_class::<types::EdgeWithProps>()?;
  m.add_class::<types::NodePage>()?;
  m.add_class::<types::EdgePage>()?;

  // Result types from options (ExportResult, ImportResult, BackupResult)
  m.add_class::<options::ExportResult>()?;
  m.add_class::<options::ImportResult>()?;
  m.add_class::<options::BackupResult>()?;

  // Traversal result classes
  m.add_class::<traversal::PyTraversalResult>()?;
  m.add_class::<traversal::PyPathResult>()?;
  m.add_class::<traversal::PyPathEdge>()?;

  // Vector search classes
  m.add_class::<vector::PyIvfIndex>()?;
  m.add_class::<vector::PyIvfPqIndex>()?;
  m.add_class::<vector::PyIvfConfig>()?;
  m.add_class::<vector::PyPqConfig>()?;
  m.add_class::<vector::PySearchOptions>()?;
  m.add_class::<vector::PySearchResult>()?;
  m.add_class::<vector::PyIvfStats>()?;

  // Standalone functions
  m.add_function(wrap_pyfunction!(database::open_database, m)?)?;
  m.add_function(wrap_pyfunction!(database::collect_metrics, m)?)?;
  m.add_function(wrap_pyfunction!(database::health_check, m)?)?;
  m.add_function(wrap_pyfunction!(database::create_backup, m)?)?;
  m.add_function(wrap_pyfunction!(database::restore_backup, m)?)?;
  m.add_function(wrap_pyfunction!(database::get_backup_info, m)?)?;
  m.add_function(wrap_pyfunction!(database::create_offline_backup, m)?)?;
  m.add_function(wrap_pyfunction!(version, m)?)?;
  m.add_function(wrap_pyfunction!(vector::brute_force_search, m)?)?;

  Ok(())
}

/// Get KiteDB version
#[cfg(feature = "python")]
#[pyfunction]
pub fn version() -> String {
  env!("CARGO_PKG_VERSION").to_string()
}