Actor and REST interface for LEDB

License: MIT Travis-CI Build Status Appveyor Build status Crates.io Package Docs.rs API Documentation

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

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=$collectionname_

drop collection with all documents

DELETE /collection/$collectionname_

Index API

get indexes of collection

GET /collection/$collectionname_/index

create new index for collection

POST /collection/$collectionname/index?path=$fieldname&kind=$indexkind&key=$keytype

drop index of collection

DELETE /collection/$collectionname/document/$indexname

Document API

find documents using query

GET /collection/$collectionname/document?filter=$query&order=$ordering&offset=$skip&length=$take_

GET /collection/$collectionname?filter=$query&order=$ordering&offset=$skip&length=$take_

modify documents using query

PUT /collection/$collectionname/document?filter=$query&modify=$modifications_

PATCH /collection/$collectionname?filter=$query&modify=$modifications_

remove documents using query

DELETE /collection/$collectionname/document?filter=$query_

PUT /collection/$collectionname?filter=$query_

insert new document

POST /collection/$collectionname_/document

POST /collection/$collectionname_

get document by id

GET /collection/$collectionname/document/$documentid

GET /collection/$collectionname/$documentid

replace document

PUT /collection/$collectionname/document/$documentid

PUT /collection/$collectionname/$documentid

remove document

DELETE /collection/$collectionname/document/$documentid

DELETE /collection/$collectionname/$documentid

Supported index kinds

Supported key types

Actor

Usage example

```rust use std::env;

use serde::{Deserialize, Serialize}; use serde_json::json;

use ledbactix::{query, Document, Options, Primary, Storage, StorageAddrExt}; use log::info; use serdejson::from_value;

[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Document)]

struct BlogPost { #[document(primary)] pub id: Option, pub title: String, pub tags: Vec, pub content: String, }

[actix_rt::main]

async fn main() { env::setvar("RUSTLOG", "info"); prettyenvlogger::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());

} ```