Dare-DB

Here's the official documentation.

Dare-DB is a project that provides an in-memory database utilizing Redis-inspired hashtables implemented in Go package go-redis-hashtable. It offers a lightweight and efficient solution for storing data in memory and accessing it through simple HTTP operations.

Project Purpose

The primary goal of this project is to offer an in-memory database that leverages hashtables for efficient data storage and retrieval. The Go implementation allows using this database as a component in other Go services or integrating it into applications that require rapid access to in-memory data.

Running the Database

Using Docker

To run the database as a Docker image, ensure you have Docker installed on your system. First, navigate to the root directory of your project and execute the following command to build the Docker image:

docker build -t dare-db:latest .

Once the image is built, you can run the database as a Docker container with the following command (note: a configuration option -e DARE_HOST="0.0.0.0" is explicitly set to enable connections from the host machine to the database running within the Docker container):

docker run -d -p "127.0.0.1:2605:2605" -e DARE_HOST="0.0.0.0" dare-db 

This command will start the database as a Docker container in detached mode, exposing port 2605 of the container to port 2605 on your localhost 127.0.0.1.

Using TLS Version in Docker

Build special Docker image, which will generate certificates

docker build -t dare-db-tls:latest -f Dockerfile.tls.yml .

Once the image is built, you can run the database as a Docker container with the following command:

docker run -d -p "127.0.0.1:2605:2605" -e DARE_HOST="0.0.0.0" -e DARE_PORT=2605 -e DARE_TLS_ENABLED="True" -e DARE_CERT_PRIVATE="/app/settings/cert_private.pem" -e DARE_CERT_PUBLIC="/app/settings/cert_public.pem" dare-db-tls

Access API over HTTPS on https://127.0.0.1:2605

How to Use: Core API Overview

The in-memory database provides three simple HTTP endpoints to interact with stored data. By default endpoints are protected by JWT:

POST /login

Get the JWT token. For credentials check file: config.toml:

curl --insecure -X POST -u ADMIN:PASSWORD https://127.0.0.1:2605/login

• --insecure is a workaround to overcome issues for TLS version working with self-signed certificates
• -H "Authorization: <TOKEN> is how thw JWT must be passed by, note there is no Bearer in the header

GET /get/{key}

This endpoint retrieves an item from the hashtable using a specific key.

Example usage with cURL:

curl -X GET -H "Authorization: <TOKEN>" http://127.0.0.1:2605/get/myKey

SET /set

This endpoint inserts a new item into the hashtable. The request body should contain the key and value of the new item.

Example usage with cURL:

curl -X POST -H "Authorization: <TOKEN>" -d '{"myKey":"myValue"}' http://127.0.0.1:2605/set

DELETE /delete/{key}

This endpoint deletes an item from the hashtable using a specific key.

Example usage with cURL:

curl -X DELETE -H "Authorization: <TOKEN>" http://127.0.0.1:2605/delete/myKey

How to Use: Examples

A number of examples to demonstrate, how to use the database in a Go application:

• daredb_basic.go
• daredb_jwt_basic.go

A number of examples to demonstrate, how to use the database in a Python application:

• daredb_jwt_collection.py

OpenAPI 3.0 Specification

For latest OpenAPI spec see: openapi

How to Contribute

All sorts of contributions to this project! Here's how you can get involved:

How to Contribute: Overview

How to Contribute: Steps

• Found a bug? Let us know! Open an issue and briefly describe the problem.
• Have a great idea for a new feature? Open an issue to discuss it. If you'd like to implementing it yourself, you can assign this issue to yourself and create a pull request once the code/improvement/fix is ready.
• Want to talk about something related to the project? Discussion threads are the perfect place to brainstorm ideas

Here is how you could add your new code/improvement/fix with a pull request:

1. Fork the repository (e.g., latest changes must be in develop branch)

   git clone -b develop https://github.com/dmarro89/dare-db
   

2. Create a new branch for your feature. Use number of a newly created issue and keywords (e.g., 10-implement-feature-ABC)

   git checkout -b 10-implement-feature-ABC
   

3. Add changes to the branch

   git add .
   

4. Commit your changes

   git commit -am 'add new feature ABC'
   

5. Push to the branch

   git push origin 10-implement-feature-ABC
   

6. Open a pull request based on a new branch
7. Provide a short notice in the pull request according to the following template:
   • Added: ...
   • Changed: ...
   • Fixed: ...
   • Dependencies: ...

How to Contribute: Dependencies

How to Contribute: Dependencies

• task (a.k.a.: taskfile)
  • Install as Go module (globally)

     go install github.com/go-task/task/v3/cmd/task@latest

• wgo - watcher-go
  • Install as Go module (globally)

     go install github.com/bokwoon95/wgo@latest

• Lefhook (polyglot Git hooks manager)
  • Install as Go module (globally)

     go install github.com/evilmartians/lefthook@latest