linkrs-api 0.1.0

Transport-independent core API for Linkrs
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

//! Embedded API module
//!
//! Provide an embedded Linkrs interface for standalone use, with a similar usage approach to SQLite.
//!
//! # Get started quickly
//!
//! ```rust
//! use linkrs_api::embedded::{GraphDatabase, DatabaseConfig};
//!
//! # fn example() -> Result<(), Box<dyn std::error::Error>> {
// Open the database
//! let db = GraphDatabase::open("my_database")?;
//!
// Create a session
//! let mut session = db.session()?;
//!
// Switch to the image space
//! session.use_space("test_space")?;
//!
// Execute the query
//! let result = session.execute("MATCH (n) RETURN n")?;
//!
// Using a transaction
//! let txn = session.begin_transaction()?;
//! txn.execute("CREATE TAG user(name string)")?;
//! txn.commit()?;
//!
// The database is automatically closed when the `db` variable goes out of scope.
//! # Ok(())
//! # }
//! ```

// Submodule
pub mod batch;
pub mod busy_handler;
pub mod config;
pub mod database;
pub mod hooks;
pub mod migration;
pub mod result;
pub mod session;
pub mod statistics;
pub mod transaction;

// C API module: compiled only for callers that ask for the FFI surface.
#[cfg(feature = "c_api")]
pub mod c_api;

// Re-export the main types
pub use batch::{BatchError, BatchInserter, BatchItemType, BatchResult};
pub use busy_handler::{BusyConfig, BusyHandler, BusyResult};
pub use config::DatabaseConfig;
pub use database::GraphDatabase;
pub use hooks::HookBus;
pub use linkrs_config::SyncMode;
pub use result::{QueryResult, ResultMetadata, Row};
pub use session::Session;
pub use statistics::QueryStatistics;
pub use transaction::{Transaction, TransactionConfig, TransactionInfo};

// Re-export SessionStatistics from core
pub use linkrs_core::SessionStatistics;

// C API re-export
#[cfg(feature = "c_api")]
pub use c_api::{
    error::linkrs_error_code_t,
    statistics::linkrs_session_statistics_t as CApiSessionStatistics,
    types::{
        linkrs_batch_t, linkrs_config_t, linkrs_result_t, linkrs_session_t, linkrs_string_t,
        linkrs_t, linkrs_txn_t, linkrs_value_data_t, linkrs_value_t, linkrs_value_type_t,
    },
};

// Error type
pub use crate::api_core::error::CoreError as EmbeddedError;