2022-08-28 12:18:12 +00:00
|
|
|
//! This library provides the low-level database library implementation, and query language
|
|
|
|
//! definition, for [SurrealDB](https://surrealdb.com), the ultimate cloud database for
|
|
|
|
//! tomorrow's applications. SurrealDB is a scalable, distributed, collaborative, document-graph
|
|
|
|
//! database for the realtime web.
|
2022-05-03 23:38:16 +00:00
|
|
|
//!
|
2022-08-28 12:18:12 +00:00
|
|
|
//! This library can be used to start an embedded in-memory datastore, an embedded datastore
|
|
|
|
//! persisted to disk, a browser-based embedded datastore backed by IndexedDB, or for connecting
|
|
|
|
//! to a distributed [TiKV](https://tikv.org) key-value store.
|
2022-05-03 23:38:16 +00:00
|
|
|
|
2022-12-07 19:30:29 +00:00
|
|
|
#![doc(html_favicon_url = "https://surrealdb.s3.amazonaws.com/favicon.png")]
|
|
|
|
#![doc(html_logo_url = "https://surrealdb.s3.amazonaws.com/icon.png")]
|
|
|
|
|
2022-02-22 14:16:50 +00:00
|
|
|
#[macro_use]
|
|
|
|
extern crate log;
|
|
|
|
|
|
|
|
#[macro_use]
|
|
|
|
mod mac;
|
|
|
|
|
|
|
|
mod cnf;
|
|
|
|
mod ctx;
|
|
|
|
mod dbs;
|
|
|
|
mod doc;
|
|
|
|
mod err;
|
2022-09-21 01:27:28 +00:00
|
|
|
mod exe;
|
2022-02-22 14:16:50 +00:00
|
|
|
mod fnc;
|
|
|
|
mod key;
|
|
|
|
mod kvs;
|
|
|
|
|
2022-12-07 19:30:29 +00:00
|
|
|
// ENV
|
|
|
|
pub mod env;
|
|
|
|
|
2022-05-13 20:51:59 +00:00
|
|
|
// SQL
|
2022-02-22 14:16:50 +00:00
|
|
|
pub mod sql;
|
|
|
|
|
2022-05-13 20:51:59 +00:00
|
|
|
// Exports
|
2022-02-22 14:16:50 +00:00
|
|
|
pub use dbs::Auth;
|
|
|
|
pub use dbs::Response;
|
|
|
|
pub use dbs::Session;
|
2022-05-03 23:38:16 +00:00
|
|
|
pub use err::Error;
|
2022-02-22 14:16:50 +00:00
|
|
|
pub use kvs::Datastore;
|
|
|
|
pub use kvs::Key;
|
|
|
|
pub use kvs::Transaction;
|
|
|
|
pub use kvs::Val;
|
2022-05-13 20:51:59 +00:00
|
|
|
|
|
|
|
// Re-exports
|
2022-05-15 19:38:46 +00:00
|
|
|
pub mod channel {
|
|
|
|
pub use channel::bounded as new;
|
|
|
|
pub use channel::Receiver;
|
|
|
|
pub use channel::Sender;
|
|
|
|
}
|
2022-12-07 19:30:29 +00:00
|
|
|
|
|
|
|
// Version
|
|
|
|
#[doc(inline)]
|
|
|
|
pub use env::VERSION;
|