wosDB

A database created using C which is able to store both key and value data and document-oriented data.

Instructions:

Building the project

Use the make all command to build the binary file for wosDB.

Running wosDB

Use the ./wosDB -flag command to run the database. The behavior of the database is determined by the flag and input.

Flags

• s: Starts the server and listens on port 8080 by default.
• -c <input>: Creates a database named after the input.
• -d <input>: Deletes a database named after the input.
• -l: Lists current databases in the manifest.

Starting the wosDB server

Use the following commands to start the server after building:

./bin/wosDB -s

starts server @8080 with local addr

Building with CMake

CMake is used to control the software compilation process using simple platform and compiler independent configuration files. CMake generates native makefiles and workspaces that can be used in the compiler environment of your choice.

Follow these steps to build the project using CMake:

1. Navigate to the project directory.

2. Create a new directory for the build outputs:

   mkdir build bin
   cd build

3. Run CMake to generate the Makefile:

   cmake ..

4. Build the project:

   make

5. Run the project:

   cd ../
   ./bin/wosDB -s

This will create the wosDB executable in the bin directory.

Immediate Goals:

• Improve Unit Tests for Key/Value and improve I/O rate and database schematic
• Store data seperatly and only grab it and place it in memory when it's needed otherwis keep in cold storage
• Create documentation for Key/Value database for to get an intial idea how it should work in the futureux
• Build out Key/Value functionaility for practical use and debugging
• Consider adding an HTTP alterative other than just using my own messagingProtocol for fallback
• Consider building small caches wherever is possible to help speed up performance

Plan:

• DB has its own server running to recieve request from the user
• [ in-progress ] Work on scalable messageProtocol used for DB
• Each DB has its own manifest
• DB has Key/Value Database
• [in-progress ] DB has Document Database
• Be able to find, add, delete data
• Test efficancy using it as a database I/O Rate (200-400 Operations per millisecond not definitive)
• Add the ability to regex documment to find matching tables and return it to the user
• Create ability to encode and decode data
• Create a hybrid type database (find,add,delete)
• Add diagnostic ability for database to check viability
• Add the ability to compress data
• Basic presistance with serialization and deserialization
• Create a long-term data storage type with maxium reliability

Test Tools:

• valgrind

Contributors ✨

Mattiwos 📖 👀 🔧