Merge pull request #33 from metabase/driver-docs-and-scripts

Make DB scripts consistent for driver development

Author: rileythomp

_run-druid.sh

@@ -0,0 +1,28 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-druid.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+kill-existing ${CONTAINER_NAME}
+
+docker run \
+       -p ${WEB_PORT}:8081 \
+       -p ${HOST_PORT}:8082 \
+       -p 8888:8888 \
+       -e CLUSTER_SIZE=nano-quickstart \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       -d metabase/druid:${DRUID_VERSION}
+
+cat <<EOF
+
+Started Druid ${DRUID_VERSION} on ports ${WEB_PORT}, ${HOST_PORT}, and 8888.
+
+Visit http://localhost:${WEB_PORT} in your browser to view the web console.
+
+EOF
+
+print-druid-vars

_run-mariadb.sh

@@ -0,0 +1,30 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-mariadb.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+kill-existing ${CONTAINER_NAME}
+
+docker run -p ${HOST_PORT}:3306 \
+       -e MYSQL_DATABASE=${DB_NAME} \
+       -e MYSQL_USER=${DB_USER} \
+       -e MYSQL_ALLOW_EMPTY_PASSWORD=yes \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       -d mariadb:${MARIADB_VERSION}
+
+cat <<EOF
+
+Started MariaDB ${MARIADB_VERSION} on port ${HOST_PORT}.
+
+Connect with the MySQL CLI tool:
+mysql --user=${DB_USER} --host=127.0.0.1 --port=${HOST_PORT} --database=${DB_NAME}
+
+JDBC URL: jdbc:mysql://localhost:${HOST_PORT}/${DB_NAME}?user=${DB_USER}
+
+EOF
+
+print-mariadb-vars

_run-mongo.sh

@@ -0,0 +1,25 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-mongo.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+kill-existing ${CONTAINER_NAME}
+
+docker run -p ${HOST_PORT}:27017 \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       -d mongo:${MONGO_VERSION}
+
+cat <<EOF
+
+Started MongoDB ${MONGO_VERSION} on port ${HOST_PORT}.
+
+Connect to the database with the MongoDB client:
+docker exec -it ${CONTAINER_NAME} mongosh
+
+EOF
+
+print-mongo-vars

_run-mysql.sh

@@ -0,0 +1,29 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-mysql.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+kill-existing ${CONTAINER_NAME}
+
+docker run -p ${HOST_PORT}:3306 \
+       -e MYSQL_DATABASE=${DB_NAME} \
+       -e MYSQL_ALLOW_EMPTY_PASSWORD=yes \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       -d mysql:${MYSQL_VERSION}
+
+cat <<EOF
+
+Started MySQL ${MYSQL_VERSION} on port ${HOST_PORT}.
+
+Connect with the MySQL CLI tool:
+mysql --user=${DB_USER} --host=127.0.0.1 --port=${HOST_PORT} --database=${DB_NAME}
+
+JDBC URL: jdbc:mysql://localhost:${HOST_PORT}/${DB_NAME}?user=${DB_USER}
+
+EOF
+
+print-mysql-vars

_run-oracle.sh

@@ -0,0 +1,28 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-oracle.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+kill-existing ${CONTAINER_NAME}
+
+docker run -p ${HOST_PORT}:1521 \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       -e ORACLE_PASSWORD=${DB_PASSWORD} \
+       -d gvenzl/oracle-xe:${ORACLE_VERSION}
+
+cat <<EOF
+
+Started Oracle Express Edition ${ORACLE_VERSION} on port ${HOST_PORT}.
+Wait 10-20 seconds for it to finish starting.
+
+JDBC URL: jdbc:oracle:thin:@//localhost:${HOST_PORT}/${DB_NAME}?user=${DB_USER}&password=${DB_PASSWORD}
+
+EOF
+
+print-oracle-vars
+
+

_run-postgres.sh

@@ -1,43 +1,41 @@
 #!/usr/bin/env bash
 
-set pipefail -euo
-
 SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-postgres.sh"
+
 source "$SOURCE_DIR/common.sh"
 
-CONTAINER_NAME=pgsql-${PG_VERSION}-metabase
-DB_NAME=metabase
-DB_USER=metabase
-DB_PASSWORD=Password1234
-HOST_PORT=${PGSQL_PORT:-5432}
-DATA_DIR=${PGSQL_DATA_DIR:-$HOME/metabase-pgsql-data}
+DATA_DIR=${HOME}/metabase-pgsql-${PG_VERSION}-data
 DOCKER_NETWORK=psql-metabase-network
 
-kill-existing $CONTAINER_NAME
-create-network-if-needed $DOCKER_NETWORK
+kill-existing ${CONTAINER_NAME}
+create-network-if-needed ${DOCKER_NETWORK}
 
 docker run \
        --rm \
        -d \
-       -p $HOST_PORT:5432 \
-       --network $DOCKER_NETWORK \
-       -e POSTGRES_USER=$DB_USER \
-       -e POSTGRES_DB=$DB_NAME \
-       -e POSTGRES_PASSWORD=$DB_PASSWORD \
+       -p ${HOST_PORT}:5432 \
+       --network ${DOCKER_NETWORK} \
+       -e POSTGRES_USER=${DB_USER} \
+       -e POSTGRES_DB=${DB_NAME} \
+       -e POSTGRES_PASSWORD=${DB_PASSWORD} \
        -e PGDATA=/var/lib/postgresql/data \
-       -v $DATA_DIR:/var/lib/postgresql/data:Z \
-       --name $CONTAINER_NAME \
+       -v ${DATA_DIR}:/var/lib/postgresql/data:Z \
+       --name ${CONTAINER_NAME} \
        postgres:${PG_VERSION}
 
 cat << EOF
-Started PostgreSQL ${PG_VERSION} port $HOST_PORT via Docker (container name: $CONTAINER_NAME). Data will be persisted in $DATA_DIR on the host machine (delete it to reset).
-
-JDBC URL: jdbc:postgres://localhost:$HOST_PORT/$DB_NAME?user=$DB_USER
 
-Environment variables for Metabase (to use as app DB):
-MB_DB_TYPE=postgres MB_DB_DBNAME=$DB_NAME MB_DB_HOST=localhost MB_DB_PASS=$DB_PASSWORD MB_DB_PORT=$HOST_PORT MB_DB_USER=$DB_USER MB_POSTGRES_TEST_USER=$DB_USER
+Started PostgreSQL ${PG_VERSION} on port ${HOST_PORT} via Docker (container name: ${CONTAINER_NAME}).
+Data will be persisted in ${DATA_DIR} on the host machine (delete it to reset).
 
 To open a SQL client session:
-docker run -it --rm --network $DOCKER_NETWORK postgres:12 psql -h $CONTAINER_NAME -U $DB_USER
-And enter the DB user password for $DB_USER: $DB_PASSWORD
+docker run -it --rm --network ${DOCKER_NETWORK} postgres:${PG_VERSION} psql -h ${CONTAINER_NAME} -U ${DB_USER}
+And enter the DB user password for ${DB_USER}: ${DB_PASSWORD}
+
+JDBC URL: jdbc:postgres://localhost:${HOST_PORT}/${DB_NAME}?user=${DB_USER}
+
 EOF
+
+print-postgres-vars

run-presto.sh _run-presto.shrun-presto.sh renamed to _run-presto.sh

@@ -1,29 +1,28 @@
 #! /usr/bin/env bash
 
-set -euo pipefail
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
 
-echo "Removing existing container..."
+source "$SOURCE_DIR/env-presto.sh"
 
-docker rm -fv presto 2>/dev/null || echo "Nothing to remove"
+source "$SOURCE_DIR/common.sh"
 
-docker run -p 8080:8080 \
+kill-existing ${CONTAINER_NAME}
+
+docker run -p ${HOST_PORT}:8080 \
        -p 8443:8443 \
-       --name presto \
+       --name ${CONTAINER_NAME} \
        --hostname presto \
        --rm \
-       -d metabase/presto-mb-ci
-
-SERVER_CA_PEM_FILE=/tmp/presto-ssl-ca.pem
-SERVER_CA_DER_FILE=/tmp/presto-ssl-ca.der
-MODIFIED_CACERTS_FILE=/tmp/cacerts-with-presto-ssl.jks
+       -d prestodb/presto:${PRESTO_VERSION}
 
 cat << EOF
-Started Presto on port 8080 (insecure HTTP) and port 8443 (secure HTTPS) on the host machine
+
+Started Presto on port ${HOST_PORT} (insecure HTTP) and port 8443 (secure HTTPS) on the host machine
 
 To make the self signed certificate that was generated for this Presto instance available to your Java application
 (ex: Metabase), perform the following steps after Presto is completely online.  You can run
 
-  docker logs --tail 5 presto
+  docker logs --tail 5 ${CONTAINER_NAME}
 
 to see the current output.  Once Presto is online, you will see a line containing something like the following:
 
@@ -44,4 +43,7 @@ also have the JAVA_HOME env var set for this all to work.
 Finally, this can be made available to Metabase by adding the following JVM args when starting:
 
   -Djavax.net.ssl.trustStore=$MODIFIED_CACERTS_FILE -Djavax.net.ssl.trustStorePassword=changeit
+
 EOF
+
+print-presto-vars

_run-sparksql.sh

@@ -0,0 +1,23 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-sparksql.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+kill-existing ${CONTAINER_NAME}
+
+docker run -p ${HOST_PORT}:10000 \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       -d metabase/spark:${SPARKSQL_VERSION}
+
+cat <<EOF
+
+Started Spark SQL ${SPARKSQL_VERSION} on port ${HOST_PORT}.
+
+JDBC URL:                jdbc:hive2://localhost:${HOST_PORT}/?user=${DB_USER}&password=${DB_PASSWORD}
+For a specific database: jdbc:hive2://localhost:${HOST_PORT}/${DB_NAME}?user=${DB_USER}&password=${DB_PASSWORD}
+
+EOF

_run-sqlserver.sh

@@ -0,0 +1,25 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-sqlserver.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+kill-existing ${CONTAINER_NAME} 
+
+docker run \
+       -p ${HOST_PORT}:1433 \
+       -e ACCEPT_EULA=Y \
+       -e SA_PASSWORD=${DB_PASSWORD} \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       -d mcr.microsoft.com/mssql/server:${SQLSERVER_VERSION}
+
+cat <<EOF
+
+Started SQL Server ${SQLSERVER_VERSION} on port ${HOST_PORT}.
+
+EOF
+
+print-sqlserver-vars

_run-vertica.sh

@@ -0,0 +1,31 @@
+#! /usr/bin/env bash
+
+SOURCE_DIR=`dirname "${BASH_SOURCE[0]}"`
+
+source "$SOURCE_DIR/env-vertica.sh"
+
+source "$SOURCE_DIR/common.sh"
+
+ENV=""
+if [[ $(uname -m) == 'arm64' ]]; then
+    echo "Warning! The database will be likely extremely slow on arm64!"
+    ENV+=" --env VERTICA_MEMDEBUG=2"
+fi
+
+kill-existing ${CONTAINER_NAME}
+
+docker run -p ${HOST_PORT}:5433 \
+       --name ${CONTAINER_NAME} \
+       --rm \
+       ${ENV} \
+       -d opentext/vertica-ce:${VERTICA_VERSION}
+
+cat <<EOF
+
+Started Vertica ${VERTICA_VERSION} on port ${HOST_PORT}.
+
+JDBC URL: jdbc:vertica://localhost:${HOST_PORT}/${DB_NAME}?user=${DB_USER}
+
+EOF
+
+print-vertica-vars