https://github.com/markelca/sillydb
Trying to create my own database.
https://github.com/markelca/sillydb
Last synced: about 2 months ago
JSON representation
Trying to create my own database.
- Host: GitHub
- URL: https://github.com/markelca/sillydb
- Owner: MarkelCA
- Created: 2023-08-08T20:17:58.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-28T20:27:30.000Z (over 1 year ago)
- Last Synced: 2025-02-11T11:52:23.769Z (3 months ago)
- Language: C
- Homepage:
- Size: 175 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SillyDB it's a simple key-value store. To create it I'm being inspired from other key value stores like [LevelDB](https://github.com/google/leveldb/tree/main), [Redis](https://github.com/redis/redis), or [Bitcask](https://github.com/basho/bitcask).
This is a personal project meant to learn about databases. To do so I'm trying to create my own one, following the book *"Designing Data-Intensive Applications"* as a guideline from Martin Kleppmann.
I'm also learning C so that's the reason behind the language choice. Maybe I'll make implementations for C++ and Rust in the future.
# Build
## Using [CMake](https://cmake.org/)
Build it from the terminal using the `cmake` tool.
1. Clone the project
```bash
git clone https://github.com/MarkelCA/SillyDB.git
cd SillyDB
```
2. Create build folder
From the root folder:
```bash
mkdir build
cd build
cmake .. # Uses the CMakeLists.txt file from the parent folder
```
3. Compile the project using the created build folder
```bash
cmake --build ./build
```
## CLion
Compiling it from the [CLion IDE](https://www.jetbrains.com/clion/) has some advantages, one of them being the debugger capabilities that the IDE enables.
1. Clone the repo
```bash
git clone https://github.com/MarkelCA/SillyDB.git
cd SillyDB
```
2. Create the `cmake-build-debug` directory at the root folder.
From the root folder:
```bash
mkdir cmake-build-debug
```
2. Run the CMakeLists.txt file from the IDE using the `Debug CMake` button.
# Config
# Run
1. Start the server
```bash
./bin/start
```
2. Connect to the database
```bash
telnet localhost 8080
```
# Examples
This is a telnet prompt example with a bunch commands.
```
➜ ~ telnet localhost 8080
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
get foo
"bar"
get 1234
(nil)
set fizz buzz
"OK"
get fizz
"buzz"
set fizz bazz
"OK"
get fizz
"bazz"
get ae808cbc-f7e5-4a52-8187-aa8f5492308d
(nil)
set ae808cbc-f7e5-4a52-8187-aa8f5492308d {"firstName":"John","lastName":"Doe"}
"OK"
get ae808cbc-f7e5-4a52-8187-aa8f5492308d
"{"firstName":"John","lastName":"Doe"}"
list
"foo
x
ae808cbc-f7e5-4a52-8187-aa8f5492308d
fizz
a
b
"
```