Pull the image

docker pull docker.io/monetdb/vessel_ai

Container configuration

You can configure database name, user and password, store the database data in a docker volume and start the database with initialization scripts present in the host system.

Environment variables

• DB_NAME: Set the database name (default is vesselai)

• DB_USER: Set the user name for database access (default is monetdb)

• DB_PASSWORD: Set the password for database access in plain text (default is monetdb).

  NOTE: For non-testing purposes, consider using DB_PASSWORD_FILE to keep your password safe.

• DB_PASSWORD_FILE: Sets the Docker Secrets location for the password file. This is a safe way to set the database access password, without exposing the password as text in the docker run/docker compose command.

  NOTE: DB_PASSWORD_FILE takes precedence over DB_PASSWORD when setting the database password, when both variables are set.

• DB_FARM: Set where data is stored in the container's filesystem. The default is /var/monetdb5/dbfarm.

  NOTE: If you want to store the database data in a Docker Volume, you should set the target/destination of the volume to this DB_FARM directory.

Store data in a volume

To keep database data after the container is removed, use a docker volume to store your data. Examples on how to use volumes with docker run and docker compose can be found below.

By default, the database is stored in /var/monetdb5/dbfarm on the container's filesystem. However, if you change the value of DB_FARM, data will be stored at the set location.

Database init scripts

You can use SQL scripts to initialize the database before use. By using a bind mount, you can specify a directory in the host system's filesystem containing the scripts to be executed. The directory to mount to in the container's filesystem is /initdb/.

You can find examples on how to use bind mounts with docker run and docker compose below.

Docker secrets

To avoid exposing sensitive password data, you can use the DB_PASSWORD_FILE variable to safely transfer a file containing the database password to the container. The password file should only contain the text password for the admin user. The file will be stored in /run/secrets/<secret_name>.

Here is an example with Docker Compose, which also creates the secret by specifying where the db_password_file is in the host:

services:
    database:
      ...
      environment:
        DB_USER: "vesselai_user"
        DB_PASSWORD_FILE: "/run/secrets/db_password_file"
      secrets:
        - db_password_file

  secrets:
    db_password_file:
      file: ./db_password_file.txt

Contents of ./db_password_file.txt:

db_password_test

Alternatively, you can create the secret through docker secret create and then simply set the correct filename for DB_PASSWORD_FILE.

Start the container

Docker Compose example

NOTE: If you are a Mac or Windows user, use docker-compose to be able to connect to the database from the host machine. If you use docker run, you will only be able to connect through docker exec (connecting from the container).

Run container with custom username and password, without using docker volumes and no database initialization scripts.

services:
    database:
        image: monetdb/vessel_ai:latest
        ports: 
            - <LOCAL_PORT>:50000
        environment:
            DB_USER: "<USERNAME>"
            DB_PASSWORD: "<PASSWORD>"

Run container with custom database configuration, using a docker volume to store the database data and database initialization scripts in the current working directory.

services:
    database:
        image: monetdb/vessel_ai:latest
        ports: 
            - <LOCAL_PORT>:50000
        environment:
            DB_NAME: "<DATABASE_NAME>"
            DB_USER: "<USERNAME>"
            DB_PASSWORD: "<PASSWORD>"
        volumes:
            - database_storage:/var/monetdb5/dbfarm
            - type: bind
            source: ./
            target: /initdb/
    volumes:
        database_storage:

Docker Run examples

Run container with default database options, without using docker volumes and no database initialization scripts.

docker run -d -p <LOCAL_PORT>:50000 \
           --name <CONTAINER_NAME> \
           monetdb/vessel_ai:latest

Run container with custom username and password, and use a docker volume to store the data.

Note: the target value for the mount must be the same value as DB_FARM (default is /var/monetdb5/dbfarm).

docker run -d -p <LOCAL_PORT>:50000 \
           --name <CONTAINER_NAME> \
           -e DB_USER='<USERNAME>' \
           -e DB_PASSWORD='<PASSWORD>' \
           ---mount source=db_storage,target=/var/monetdb5/dbfarm \
           monetdb/vessel_ai:latest

Run container with a custom database name and execute database initialization scripts in the current working directory.

Note: the /initdb/ directory in the container is always used to store init scripts.

docker run -d -p <LOCAL_PORT>:50000 \
           --name <NAME> \
           -e DB_NAME='<DATABASE_NAME>' \
           --mount type=bind,source="$(pwd)",target=/initdb/ \
           monetdb/vessel_ai:latest

Connect to the database server

From the host machine

You can use all the different clients available for MonetDB to connect to the server and use the database.

Using the mclient CLI tool:

mclient -p <LOCAL_PORT> -d <DATABASE_NAME> -u <USERNAME>

TODO: pymonetdb example

Using docker exec

Using docker exec or docker-compose exec you can connect to the container and use the client on the container itself. This can be useful if using Docker Desktop for Mac and Windows, which have limited capacity for connection from the host machine.

docker exec -it <CONTAINER_NAME> mclient -d <DATABASE_NAME> -u <USERNAME>
# or for compose
docker-compose exec <SERVICE_NAME> mclient -d <DATABASE_NAME> -u <USERNAME>