WooriDB
WooriDB is a general purpose (EXPERIMENTAL) time serial database, which means it contains all entities registries indexed by DateTime. It is schemaless, key-value storage and uses its own query syntax that is similar to SparQL and Crux's Datalog.
Some other features are:
- Hashing keys content with
ENCRYPTkeyword. - Hashed values are filtered out and can only be checked with
CHECKkeyword. Ronschemas for input and output.- JSON to be supported via feature.
- EDN to be supported via feature.
- Entities are indexed by
entity_name(Entity Tree),DateTime(Time Serial) andUuid(Entity ID). Entity format is a HashMap where keys are strings and values are supportedTypes. - Stores persistent data locally.
-
S3as a backend is to be developed. -
Postgresas a backend is to be developed. -
DynamoDBas a backend is to be developed.
-
- Able to handle very large numbers when using the
Psuffix.- Ex:
98347883122138743294728345738925783257325789353593473247832493483478935673.9347324783249348347893567393473247832493483478935673P.
- Ex:
- Configuration is done via environment variables.
- Non sensitive configurations are done with
Config.toml. - CORS
- Non sensitive configurations are done with
- Authentication and Authorization via session token
- Creating and removing ADMINs/new users.
- Conditional Update
- Possible Relation Algebra
- Entity history
Woori means our and although I developed this DB initially alone, it is in my culture to call everything that is done for our community and by our community ours.
This project is hugely inspired by:
- Crux;
- Datomic;
- Prometheus
- SparQL.
- Database Internals
- Database System Concept
- Designing Data Intensive Application
- Professor Andy Pavlo Database classes.
Installation
To run WooriDB it is necessary to have Rust installed in the machine. There are two ways to do this:
- Go to rustup.rs and copy the command there, for unix it is
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh. - Clone WooriDB and execute
make setup.
Executing WooriDB
Release mode performance:make releasein project root for performance optimization.Release mode size:make runin project root for size optimization.Debug mode:make debugin project root.
Docker
you can find the latest docker image at naomijub/wooridb. The current most stable tag is beta-2. To execute the docker container run:
docker run -p 1438:1438 naomijubs/wooridb:beta-2 debugfor debug mode.docker run -p 1438:1438 -e AUTH_HASHING_COST=8 -e ADMIN=your-admin-id -e ADMIN_PASSWORD=your-admin-pswd naomijubs/wooridb:beta-2 runfor size optimization.docker run -p 1438:1438 -e AUTH_HASHING_COST=8 -e ADMIN=your-admin-id -e ADMIN_PASSWORD=your-admin-pswd naomijubs/wooridb:beta-2 releasefor performance optimization.- All
-e/--envcan be replaced by a--env-file path/to/your/.env. Your.envfile should contain the following fields:
HASHING_COST=16
PORT=1438
AUTH_HASHING_COST=8
ADMIN=your-admin-id
ADMIN_PASSWORD=your-admin-pswd
Usage
- Responses are in
RONformat. Support forJSONandEDNwill be done later by using features. - For now only persistent local memory is used. Support for
S3,PostgresandDynamoDBwill also be done later by using features. - Precise floats or numbers larger than f64::MAX/i128::MAX can be defined with an UPPERCASE
Pat the end.- Note: This type cannot be updated with
UPDATE CONTENT. - Ex.:
INSERT {a: 98347883122138743294728345738925783257325789353593473247832493483478935673.9347324783249348347893567393473247832493483478935673P, } INTO my_entity.
- Note: This type cannot be updated with
BLOBwill not be supported. Check out To BLOB or Not To BLOB: Large Object Storage in a Database or a Filesystem.- To configure hashing cost and port some environment variables are required:
HASHING_COST=16
PORT=1438
TODOS
Current Benchmarks
MacBook Pro, 2.2 GHz Intel Core i7, 16 GB 2400 MHz DDR4
create_entitytime: [15.269 ms 15.332 ms 15.396 ms]insert_entitytime: [27.438 ms 28.177 ms 28.958 ms]update_set_entitytime: [24.110 ms 24.857 ms 25.695 ms]update_content_entitytime: [25.076 ms 25.819 ms 26.584 ms]delete_entitytime: [41.999 ms 42.719 ms 43.492 ms] - Filtered 400sevict_entity_idtime: [41.387 ms 42.029 ms 42.731 ms] - Filtered 400sevict_entitytime: [31.582 ms 31.805 ms 32.039 ms] - Filtered 400s
