wunderDB

README

wunderDB

wunderDb is a JSON-based in-memory Data Store.

Quickstart

To run wunderDb, download the wunderdb binary of the latest release based on your OS and Architecture. Once downloaded, run the binary to start wunderdb.

./wunderdb

This should start a wunderDb instance. For configuration documentation, check this.

Running wunderDB Container

To run wunderDB on docker, use the docker-compose to start wunderDB with basic configurations.

docker compose up

For more details refer to this.

wdbctl - CLI Tool

For ease of use, we've also developed a command-line tool for wunderDb - wdbctl.

# install wdbctl
brew tap TanmoySG/TanmoySG
brew install wdbctl

# starting wunderDB
wdbctl start

For more about wdbctl, refer to the documentation.

Migrations

Certain versions of wdb introduces model changes that need additional migrations from the wdb instance admin. See the MIGRATION.md documentation.

Usage

wunderDb APIs are completely RESTful and all actions can be performed using simple HTTP Requests. Feel free to browse the documentation for usage instructions and other important concepts used in wunderDb.

• Get Started
  • Persistence of Data
  • Configurations
• Tools - wdbctl
• Users, Roles and Access Control
  • Users
  • Roles and RBAC
  • Privileges
• Databases, Collections
  • Databases
  • Collections
• Data
  • Filter
  • Schema

Client Libraries

• wdb-go Go client library for wunderDb. [ Documentation ]

wunderDB-Retro

The first version, based on Python Flask will not be phased out any time soon. To keep it accessible and so that the version 1 doesn't get lost in the version list, I have moved the v0 to a new repository here - wdb-retro.

The wdb-retro repo has all the version 0 code as well as the Docker Image with the new name - so that when I publish the wunderDB v2 Docker Images are published the v1 Image doesnt get lost and anyone planning to use that still can. The version 1 will not be actively maintained.

Check out the final release of v1 https://github.com/TanmoySG/wdb-retro/releases/tag/v1.1.0