Skip to content

Latest commit

 

History

History
68 lines (58 loc) · 3.01 KB

README.md

File metadata and controls

68 lines (58 loc) · 3.01 KB
Raw

Shower 🚿

Actions Status Docker Pulls

What it is?

A container base on official MS SQL Server Tools for Linux with a purpose of making a simple app that will help you seed your database.

Motivation

I wanted to have something light and handy that can run on any OS as long as it has Docker installed.
It's nothing special, all this can be done manually, but when it comes to running local or experimental setups that usually means that environment(s) will be created from scrtach multiple times most likely on daily basis, so a possiblity of having the seeding step automated sounded very appealing to me.
Since I am and was in that kind of situation I finally made myself sit and build the 🚿 a wee utility script that runs in a container and seeds your favorite SQL server instance.

How it works?

All you need to provide is couple of environment variables and a volume that contains the scripts. NOTE: :shower: will first health check specified SQL server instance. It will try for 5 times with 5 second pauses between each try. If after 5 tries server is still unreachable :shower: will crash.

Environment variables

  • USER_ID: the SQL user id that will be used for executing scripts
  • PASSWORD: the adequate password for the provider user
  • SERVER_INSTANCE: the target SQL server

Where should I put my scripts?

In order to tell 🚿 where to find the scripts and how to execute them two requirements must be met:

1. The playlist file

It must be called playlist and it should contain a list of scripts to be executed. For example it can look like this:

logins.sql
database1.sql
seedTables.sql
roles.sql

Note: Ordering IS important the first script will be executed first! (In above example that would be: logins.sql

The scripts folder

It must be called scripts.
The folder should contain all scripts that are named in the playlist file if you add scripts that do not have entry in the playlist file they will be ignored.

So, to be sure we are on the same page the folder structure should look like this:

someFolder/
- playlist
- scripts/
  - logins.sql
  - database1.sql
  - seedTables.sql
  - roles.sql

Example

An example using docker-compose with minimal amount of configuration:

shower:
  image: mirzamerdovic/shower:latest
  environment:
    - SERVER_INSTANCE=sqlserver
    - USER_ID=sa
    - PASSWORD=Password1!
  volumes:
    - {some_folder_that_container_playlist_and_scripts}:/opt/mssql-tools/shower

Credits

Thanks to the person that has created the ASCII art :-)

TODOs:

  • Remove the hard requirements for the names of playlist file and the scripts folder
  • Add support to seed multiple SQL servers at the same time e.g. I have 2 servers that need to be seeded with different data