Service for OpenSlides which wraps the database, which includes reader and writer functionality. For an overview of the core concepts and available methods see the wiki. As a starting point for developing begin with the basic repository layout.
A Makefile is used to encapsulate all docker related commands. It is recommended to use the docker setup to run the datastore, so you need make, docker and docker-compose installed on your system as the only requirements.
For the productive mode two images openslides-datastore-reader and openslides-datastore-writer must be build via Make:
make build
You can run the datastore (with or without logs) and stop it:
make run
make stop
# with logs:
make run-verbose # Ctrl+C to quit
If you want to include the Datastore in other projects (e.g. as a dependency for testing), refer to the development documentation.
To create initial data, see development documentation.
After you started the productive environment, you can issue requests e.g. via curl. First, create a model:
curl http://localhost:9011/internal/datastore/writer/write -H "Content-Type: application/json" -d '{"user_id": 1, "information": {}, "locked_fields": {}, "events": [{"type": "create", "fqid": "a/1", "fields": {"f": 1}}]}'
Then you can get that model with:
curl http://localhost:9010/internal/datastore/reader/get -H "Content-Type: application/json" -d '{"fqid": "a/1"}'
All other commands work analogous to this.
Please refer to the development documentation.
The datastore can be configured with the following environment variables:
DATASTORE_MIN_CONNECTIONS: The minimum amount of connections to the database that will be created. Default: 0DATASTORE_MAX_CONNECTIONS: The maximum amount of connections to the database that will be created. If this is set to 1, only one connection can access the database at a time. The writer always runs in single-access mode, so no write errors occur. Default: 1DATASTORE_MAX_RETRIES: The amount of times a request to the database is retried before giving up. Minimum: 1, Default: 3DATASTORE_RETRY_TIMEOUT: How long to wait before retrying a request to the database, in ms. Set 0 to disable waiting between requests. Default: 10