Hyperdb
HyperDB is an in-memory hyper-fast key-value store with an HTTP API written in Rust.
Project Details
HyperDB
Author: Afaan Bilal
Introduction
HyperDB is an in-memory hyper-fast key-value store with an HTTP API written in Rust.
Run with Docker 
$ docker run --rm -it -p 8765:8765 afaanbilal/hyperdb
[HyperDB v0.1.0 (https://afaan.dev)]: Server starting on 0.0.0.0:8765
Build and Run 
$ cargo run
[HyperDB v0.1.0 (https://afaan.dev)]: Server starting on 0.0.0.0:8765
Configuration
The following environment variables configure the HTTP server.
| Environment Variable | Default value | Description |
|---|---|---|
| HYPERDB_HOST | 0.0.0.0 | HyperDB HTTP Server Bind Host. |
| HYPERDB_PORT | 8765 | HyperDB HTTP Server Port. |
| HYPERDB_AUTH | [blank] | Set to 1 to enable JWT authentication. |
| HYPERDB_SECRET | [blank] | Set the JWT signing secret. Must be set if authentication is enabled. |
| HYPERDB_USERNAME | [blank] | Set the username. Must be set if authentication is enabled. |
| HYPERDB_PASSWORD | [blank] | Set the password. Must be set if authentication is enabled. |
Clients
| Language | Source | Package | Install | |
|---|---|---|---|---|
 | Javascript | HyperDB JS | hyperdb-js | npm i hyperdb-js |
 | PHP | HyperDB PHP | hyperdb-php | composer require afaanbilal/hyperdb-php |
 | Go | HyperDB Go | hyperdb-go | go get -u github.com/AfaanBilal/hyperdb-go |
 | Python | HyperDB Py | hyperdb-py | pip install hyperdb-py |
 | Rust | HyperDB Rust | hyperdb-rs | cargo add hyperdb-rs |
CLI
HyperDB CLI is a command line interface to interact with the HyperDB server.
docker run --rm -it afaanbilal/hyperdb-cli -a http://host.docker.internal:8765
HTTP API Endpoints
| Method | Path | Auth? | Description |
|---|---|---|---|
| GET | / | ⬜ | Version. Example: [HyperDB v0.1.0 (https://afaan.dev)]. |
| GET | /ping | ⬜ | Ping (returns PONG). |
| POST | /auth | ⬜ | Returns the generated JWT on success, otherwise INVALID_CREDENTIALS. |
| GET | /has/{key} | ✅ | Returns YES if key is present, otherwise NO. |
| GET | /data/{key} | ✅ | Returns the value for the key if present, otherwise "". |
| POST | /data/{key} | ✅ | Sets the value for the key to the request body. |
| DELETE | /data/{key} | ✅ | Deletes the key and any value associated with it. Returns OK on success. |
| GET | /data | ✅ | Get all stored data. Returns the stored data as a JSON string. |
| DELETE | /data | ✅ | Delete all stored data. Returns OK on success. |
| GET | /empty | ✅ | Returns YES if the store is empty, otherwise NO. |
| POST | /save | ✅ | Persist store to file. Returns OK on success. |
| POST | /reload | ✅ | Reload store from file. Returns OK on success. |
| DELETE | /reset | ✅ | Delete all stored data from memory and disk. Returns OK on success. |
Authentication
- Generating JWT: Post to
/authwith headersusernameandpassword. Returns JWT on success. - All auth required requests: Add header
Authwith the JWT as the value. - Token lifetime: 6 hours.
- Token invalid or expired:
AUTH_FAILEDis returned as response.
Benchmarks
Load test using autocannon.
Reading Data (50,675.2 requests per second)
$ autocannon -c 100 -d 30 -p 10 http://127.0.0.1:8765/data/hello
Running 30s test @ http://127.0.0.1:8765/data/hello
100 connections with 10 pipelining factor
┌─────────┬───────┬───────┬───────┬───────┬──────────┬─────────┬───────┐
│ Stat │ 2.5% │ 50% │ 97.5% │ 99% │ Avg │ Stdev │ Max │
├─────────┼───────┼───────┼───────┼───────┼──────────┼─────────┼───────┤
│ Latency │ 15 ms │ 17 ms │ 36 ms │ 39 ms │ 19.39 ms │ 6.59 ms │ 72 ms │
└─────────┴───────┴───────┴───────┴───────┴──────────┴─────────┴───────┘
┌───────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┬─────────┐
│ Stat │ 1% │ 2.5% │ 50% │ 97.5% │ Avg │ Stdev │ Min │
├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ Req/Sec │ 46559 │ 46559 │ 51039 │ 53791 │ 50675.2 │ 1887.99 │ 46542 │
├───────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
│ Bytes/Sec │ 5.63 MB │ 5.63 MB │ 6.18 MB │ 6.51 MB │ 6.13 MB │ 229 kB │ 5.63 MB │
└───────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
Req/Bytes counts sampled once per second.
# of samples: 30
1521k requests in 30.27s, 184 MB read
Writing Data (49,797.34 requests per second)
$ autocannon -c 100 -d 30 -p 10 -b WORLD -m POST http://127.0.0.1:8765/data/hello
Running 30s test @ http://127.0.0.1:8765/data/hello
100 connections with 10 pipelining factor
┌─────────┬───────┬───────┬───────┬───────┬──────────┬─────────┬───────┐
│ Stat │ 2.5% │ 50% │ 97.5% │ 99% │ Avg │ Stdev │ Max │
├─────────┼───────┼───────┼───────┼───────┼──────────┼─────────┼───────┤
│ Latency │ 14 ms │ 17 ms │ 36 ms │ 38 ms │ 19.74 ms │ 6.95 ms │ 94 ms │
└─────────┴───────┴───────┴───────┴───────┴──────────┴─────────┴───────┘
┌───────────┬─────────┬─────────┬─────────┬─────────┬──────────┬─────────┬─────────┐
│ Stat │ 1% │ 2.5% │ 50% │ 97.5% │ Avg │ Stdev │ Min │
├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
│ Req/Sec │ 43647 │ 43647 │ 49951 │ 52479 │ 49797.34 │ 1497.74 │ 43630 │
├───────────┼─────────┼─────────┼─────────┼─────────┼──────────┼─────────┼─────────┤
│ Bytes/Sec │ 5.28 MB │ 5.28 MB │ 6.05 MB │ 6.35 MB │ 6.03 MB │ 181 kB │ 5.28 MB │
└───────────┴─────────┴─────────┴─────────┴─────────┴──────────┴─────────┴─────────┘
Req/Bytes counts sampled once per second.
# of samples: 30
1495k requests in 30.26s, 181 MB read
Test
$ cargo test
Finished test [unoptimized + debuginfo] target(s) in 0.11s
Running unittests src\main.rs (target\debug\deps\hyperdb-11cc96418dbb140b.exe)
running 12 tests
test hyper::tests::has_file ... ok
test hyper::tests::key_not_present ... ok
test hyper::tests::not_empty ... ok
test hyper::tests::it_clears ... ok
test hyper::tests::key_is_deleted ... ok
test hyper::tests::len_not_zero ... ok
test hyper::tests::key_is_stored ... ok
test hyper::tests::start_from_empty ... ok
test hyper::tests::start_len_zero ... ok
test hyper::tests::value_is_stored ... ok
test hyper::tests::saves_to_file ... ok
test hyper::tests::reloads_from_file ... ok
test result: ok. 12 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s
Contributing
All contributions are welcome. Please create an issue first for any feature request
or bug. Then fork the repository, create a branch and make any changes to fix the bug
or add the feature and create a pull request. That's it!
Thanks!
License
HyperDB is released under the MIT License.
Check out the full license here.
License
MIT License
Copyright (c) 2023 Afaan Bilal
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.