Administration ScriptsΒΆ

Most administration features are available to administrators through the user interface. Some features which are rarely used or which would be useful for scripting purposes are available as scripts, so that they can be run using the SampleDB command line interface.

If you are running SampleDB using Docker, you can execute these scripts using docker exec -it <container_name> sampledb, e.g. if you named the container sampledb-server, you could get the list of actions like this:

docker exec -it sampledb-server sampledb list_actions

To make it easier, you can set an alias like so:

alias sampledb="docker exec -it <container_name> sampledb"

Add this in your .bashrc or .zshrc depending if you use respectively bash or zsh as shell.

To get a list of all available scripts, you can run:

sampledb help

To then get a list of all actions, for example, you can run:

sampledb list_actions

To get information on how to run one of these scripts, you can run pass the help parameter to it:

sampledb list_actions help