docker-mysql-init

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

Overview

This Dockerfile is a wrapper over the MySQL Command-Line Tool.

This Dockerfile is similar to senzing/mysql, but differs in the following ways:

1. The command is only run once. A "Sentinel File" is created on the first run. It prevents future runs. The file should be located on an external volume. Default location: /opt/senzing/mysql-init.sentinel.
2. On the first run, the command loops until it succeeds. This is useful in docker-compose formations where the mysql command needs to wait for mysql server to come up. An example is at senzing/docker-compose-mysql-demo.

Contents

1. Create Docker container
2. Docker network
3. Run Docker container

Legend

1. 🤔 - A "thinker" icon means that a little extra thinking may be required. Perhaps you'll need to make some choices. Perhaps it's an optional step.
2. ✏️ - A "pencil" icon means that the instructions may need modification before performing.
3. ⚠️ - A "warning" icon means that something tricky is happening, so pay attention.

Create docker container

1. Build docker container. Example:

   sudo docker build \
     --tag senzing/mysql-init \
     https://github.com/senzing-garage/docker-mysql-init.git#main

Docker network

🤔 Optional: Use if docker container is part of a docker network.

1. List docker networks. Example:

   sudo docker network ls

2. ✏️ Specify docker network. Choose value from NAME column of docker network ls. Example:

   export SENZING_NETWORK=*nameofthe_network*

3. Construct parameter for docker run. Example:

   export SENZING_NETWORK_PARAMETER="--net ${SENZING_NETWORK}"

Run Docker container

1. ✏️ Identify the file of SQL to be run. Example: If the actual file pathname is /path/to/mysqlfile.sql

   export MYSQL_DIR=/path/to
   export MYSQL_FILE=mysqlfile.sql

2. ✏️ Identify the database username and password. Example:

   export MYSQL_USERNAME=root
   export MYSQL_PASSWORD=root

3. ✏️ Identify the database that is the target of the SQL statements. Example:

   export MYSQL_DATABASE=mydatabase

4. ✏️ Identify the host running mySQL servers. Example:

   sudo docker ps
   
   # Choose value from NAMES column of docker ps
   export MYSQL_HOST=docker-container-name

5. ✏️ Identify where the "sentinel file" should be located. The file should be on an external volume. Example:

   export SENZING_SENTINEL_FILE="${MYSQL_DIR}/mysql-init.sentinel"

6. Create the docker container. Note: parameters after senzing/mysql-init are mysql CLI options.

   sudo docker run -it  \
     --volume ${MYSQL_DIR}:/sql \
     --env SENZING_SENTINEL_FILE=${SENZING_SENTINEL_FILE} \
     ${SENZING_NETWORK_PARAMETER} \
     senzing/mysql-init \
       --user=${MYSQL_USERNAME} \
       --password=${MYSQL_PASSWORD} \
       --host=${MYSQL_HOST} \
       --database=${MYSQL_DATABASE} \
       --execute="source /sql/${MYSQL_FILE}"