6 releases (3 breaking)
0.4.0 | Jun 11, 2020 |
---|---|
0.3.0 | Sep 6, 2019 |
0.2.1 | Oct 27, 2018 |
0.1.1 | Oct 1, 2018 |
0.1.0 | Sep 28, 2018 |
#821 in Database interfaces
260KB
6K
SLoC
Actor and REST interface for LEDB
The LEDB is an attempt to implement simple but efficient, lightweight but powerful document storage.
The abbreviation LEDB may be treated as an Lightweight Embedded DB, also Low End DB, also Literium Engine DB, also LitE DB, and so on.
Links
- ledb-actix Crate on crates.io
- ledb-actix API Docs on docs.rs
- ledb Crate on crates.io
- ledb API Docs on docs.rs
- ledb-types Crate on crates.io
- ledb-types API Docs on docs.rs
- ledb-derive Crate on crates.io
- ledb-derive API Docs on docs.rs
REST-interface
LEDB HTTP interface 0.1.0
Storage API
get database info
GET /info
get database statistics
GET /stats
Collection API
get list of collections
GET /collection
create new empty collection
POST /collection?name=_$collection_name_
drop collection with all documents
DELETE /collection/$collection_name
Index API
get indexes of collection
GET /collection/$collection_name/index
create new index for collection
POST /collection/$collection_name/index?path=_$field_name_&kind=_$index_kind_&key=_$key_type_
drop index of collection
DELETE /collection/$collection_name/document/$index_name
Document API
find documents using query
GET /collection/$collection_name/document?filter=_$query_&order=_$ordering_&offset=_$skip_&length=_$take_
GET /collection/$collection_name?filter=_$query_&order=_$ordering_&offset=_$skip_&length=_$take_
modify documents using query
PUT /collection/$collection_name/document?filter=_$query_&modify=_$modifications_
PATCH /collection/$collection_name?filter=_$query_&modify=_$modifications_
remove documents using query
DELETE /collection/$collection_name/document?filter=_$query_
PUT /collection/$collection_name?filter=_$query_
insert new document
POST /collection/$collection_name/document
POST /collection/$collection_name
get document by id
GET /collection/$collection_name/document/$document_id
GET /collection/$collection_name/$document_id
replace document
PUT /collection/$collection_name/document/$document_id
PUT /collection/$collection_name/$document_id
remove document
DELETE /collection/$collection_name/document/$document_id
DELETE /collection/$collection_name/$document_id
Supported index kinds
- uni -- Unique key
- dup -- Duplicated keys
Supported key types
- int -- 64-bit signed integer
- float -- 64-bit floating point number
- bool -- boolean value
- string -- UTF-8 string
- binary -- binary data
Actor
Usage example
use std::env;
use serde::{Deserialize, Serialize};
use serde_json::json;
use ledb_actix::{query, Document, Options, Primary, Storage, StorageAddrExt};
use log::info;
use serde_json::from_value;
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Document)]
struct BlogPost {
#[document(primary)]
pub id: Option<Primary>,
pub title: String,
pub tags: Vec<String>,
pub content: String,
}
#[actix_rt::main]
async fn main() {
env::set_var("RUST_LOG", "info");
pretty_env_logger::init();
let _ = std::fs::remove_dir_all("example_db");
let addr = Storage::new("example_db", Options::default())
.unwrap()
.start(1);
let id = addr
.send_query(query!(
insert into blog {
"title": "Absurd",
"tags": ["absurd", "psychology"],
"content": "Still nothing..."
}
))
.await
.unwrap();
info!("Inserted document id: {}", id);
assert_eq!(id, 1);
let id = addr.send_query(query!(
insert into blog {
"title": "Lorem ipsum",
"tags": ["lorem", "ipsum"],
"content": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
}
)).await.unwrap();
info!("Inserted document id: {}", id);
assert_eq!(id, 2);
addr.send_query(query!(
index for blog tags string
))
.await
.unwrap();
info!("Indexing is ok");
let mut docs = addr
.send_query(query!(
find BlogPost in blog
where tags == "psychology"
order asc
))
.await
.unwrap();
info!("Number of found documents: {}", docs.size_hint().0);
assert_eq!(docs.size_hint(), (1, Some(1)));
let doc = docs.next().unwrap().unwrap();
info!("Found document: {:?}", doc);
let doc_data: BlogPost = from_value(json!({
"id": 1,
"title": "Absurd",
"tags": ["absurd", "psychology"],
"content": "Still nothing..."
}))
.unwrap();
assert_eq!(&doc, &doc_data);
assert!(docs.next().is_none());
}
Dependencies
~11–16MB
~302K SLoC