#actor #rest #storage #json #lmdb

ledb-actix

LEDB Actor for Actix actor framework and storage REST-interface

1 unstable release

0.1.0 Sep 28, 2018

#12 in #lmdb

Download history 17/week @ 2018-10-04 2/week @ 2018-10-11 7/week @ 2018-10-18 1/week @ 2018-10-25 27/week @ 2018-11-01 34/week @ 2018-11-08

1 downloads per month

MIT license

261KB
6K SLoC

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

extern crate actix;
extern crate futures;
extern crate tokio;

#[macro_use]
extern crate serde_derive;
#[macro_use]
extern crate serde_json;
#[macro_use]
extern crate ledb;
#[macro_use]
extern crate ledb_actix;
// This allows define typed documents easy
#[macro_use]
extern crate ledb_derive;
extern crate ledb_types;

#[macro_use]
extern crate log;
extern crate pretty_env_logger;

use actix::System;
use futures::Future;
use ledb_actix::{Options, Storage, StorageAddrExt, Primary};
use serde_json::from_value;
use std::env;
use tokio::spawn;

#[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,
}

fn main() {
    env::set_var("RUST_LOG", "info");
    pretty_env_logger::init().unwrap();

    let _ = std::fs::remove_dir_all("example_db");

    System::run(|| {
        let addr = Storage::new("example_db", Options::default()).unwrap().start(1);

        spawn(
            addr.clone().send_query(query!(
                insert into blog {
                    "title": "Absurd",
                    "tags": ["absurd", "psychology"],
                    "content": "Still nothing..."
                }
            )).and_then({ let addr = addr.clone(); move |id| {
                info!("Inserted document id: {}", id);
                assert_eq!(id, 1);
                
                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."
                    }
                ))
            } }).and_then({ let addr = addr.clone(); move |id| {
                info!("Inserted document id: {}", id);
                assert_eq!(id, 2);

                addr.send_query(query!(
                    index for blog tags string
                ))
            } }).and_then({ let addr = addr.clone(); move |_| {
                info!("Indexing is ok");
                
                addr.send_query(query!(
                    find BlogPost in blog
                    where tags == "psychology"
                        order asc
                ))
            } }).map(|mut docs| {
                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!({
                    "title": "Absurd",
                    "tags": ["absurd", "psychology"],
                    "content": "Still nothing..."
                })).unwrap();
                
                assert_eq!(doc.get_data(), &doc_data);
                assert!(docs.next().is_none());
                
                System::current().stop();
            }).map_err(|err| {
                error!("Error: {:?}", err);
            })
        );
    });
}

Dependencies

~11MB
~211K SLoC