https://github.com/kazooki123/lunardb
LunarDB is a multi-model database made in Rust
https://github.com/kazooki123/lunardb
cache cache-storage database key-value-store multimodal nosql rust
Last synced: 13 days ago
JSON representation
LunarDB is a multi-model database made in Rust
- Host: GitHub
- URL: https://github.com/kazooki123/lunardb
- Owner: Kazooki123
- License: mit
- Created: 2024-09-14T02:48:04.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-04T12:56:55.000Z (3 months ago)
- Last Synced: 2025-04-04T13:39:32.625Z (3 months ago)
- Topics: cache, cache-storage, database, key-value-store, multimodal, nosql, rust
- Language: Rust
- Homepage: https://lunardbdocs.vercel.app/
- Size: 58.5 MB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
🌑LunarDB: A cache key-value database
⚡A Blazingly Fast Cache database written in Rust⚡
## 🔗What is it?
`NOTE`: The maintainer of this project has rewritten the source codes from C++ to Rust.
LunarDB is a **multi-model, key-value store, cache, memory based database** that loads keys and values in a file when saved by command.
## Install
A Guide to **Installing LunarDB**!
### Git clone 💽 (Recommended)
If you want the full source code of **LunarDB** for yourself then you can run:
```bash
git clone https://github.com/Kazooki123/LunarDB.git
```
### Rust 🦀
By using Cargo, simply run:
```bash
cargo add lunardb
```
### 💻 CLI
`NOTE`: If you want to install the `CLI` of LunarDB, you can check the repo in [here](https://github.com/Kazooki123/lunardb-cli)
For Rust using Cargo, you can do:
```bash
cargo install lunardb-cli
```
## 📖 Documentation
**💫LunarDB** has a documentation website with a guide for users who are new and learning to use LunarDB!
**🌐Visit** [here](https://lunardbdocs.vercel.app/docs/)
## 🔗 Commands
**🧭 Basic commands:**
SET key value [ttl] - Set a key-value pair with optional TTL in seconds.
GET key - Get the value for a key.
DEL key - Delete a key-value pair.
MSET key1 value1 key2 value2 ... - Set multiple key-value pairs
MGET key1 key2 ... - Get multiple values
KEYS - List all keys
LUA dofile ('./path/to/your/lua/file.lua')
HASH SHA256 key - Hashes a key using SHA-256
HASH MURMUR3 key - Hashes a key using the MURMUR3 encryption method
HASH ROTATE input shift - Rotates a hash base on the amount of shifts
CLEAR - Clear all key-value pairs
SIZE - Get the number of key-value pairs
CLEANUP - Remove expired entries
SAVE filename - Save the cache to a file
LOAD filename - Load the cache from a file
LPUSH key value - Push an element to the head of the list
LPOP key - Remove and return an element from the head of the list
RPUSH key value - Push an element to the tail of the list
RPOP key - Remove and return an element from the tail of the list
LRANGE key start stop - Get a range of elements from the list
LLEN key - Get the length of the list
QUIT - Exit the program
### Additional Notes
For more commands you can run the **CLI** executable or read our **Documentation Page**.
## 🫂 Community
**Join** the LunarDB Community!
- [Discord](https://discord.gg/KgxNzAZ5)
## 🤝 CONTRIBUTIONS
Feel free to contribution as it is open for all developers! Just make sure to follow the [CONTRIBUTION](CONTRIBUTING.md) rules and be respectful.
## ©️ LICENSE
LunarDB is under the LICENSE of [MIT](https://github.com/Kazooki123/LunarDB/blob/main/LICENSE)
And the [LunarDB License Agreement (LLA)](https://github.com/Kazooki123/LunarDB/blob/main/LUNARDB_LICENSE.txt)