Wait until database connection can be successfully established

Go to file

Markus Pesch 760c55f48e continuous-integration/drone/push Build is passing Details fix(oracle): check via v$instance		2021-09-22 11:27:48 +02:00
cmd	Initial Commit	2021-09-15 22:18:06 +02:00
pkg/dbwait	fix(oracle): check via v$instance	2021-09-22 11:27:48 +02:00
.dockerignore	Initial Commit	2021-09-15 22:18:06 +02:00
.drone.yml	fix(ci): build images only for repo volker.raschek/db-wait	2021-09-22 11:25:36 +02:00
.editorconfig	Initial Commit	2021-09-15 22:18:06 +02:00
.gitattributes	Initial Commit	2021-09-15 22:18:06 +02:00
.gitignore	Initial Commit	2021-09-15 22:18:06 +02:00
.golangci.yml	Initial Commit	2021-09-15 22:18:06 +02:00
.markdownlint.yaml	Initial Commit	2021-09-15 22:18:06 +02:00
Dockerfile	Initial Commit	2021-09-15 22:18:06 +02:00
LICENSE	Initial Commit	2021-09-15 22:18:06 +02:00
Makefile	Initial Commit	2021-09-15 22:18:06 +02:00
README.md	Initial Commit	2021-09-15 22:18:06 +02:00
go.mod	Initial Commit	2021-09-15 22:18:06 +02:00
go.sum	Initial Commit	2021-09-15 22:18:06 +02:00
main.go	Initial Commit	2021-09-15 22:18:06 +02:00
manifest.tmpl	Initial Commit	2021-09-15 22:18:06 +02:00

README.md

db-wait

With db-wait is it possible to wait in CI/CD environments until a database connection can be established and SQL queries are possible.

This is very useful for example when a database is started for an integration test and it needs time to start and initialize all schemes before the test connects to it.

Usage

As argument db-wait expects a database URI. This can be different depending on the backend. Currently only oracle and postgres are supported. The supported URI patterns can be found in the respective library or directly in the documentation of the database backend.

For example:

# postgres
db-wait postgres://user:password@localhost:5432/postgres?sslmode=disable

# oracle
db-wait oracle://user:password@localhost:1521/xe

More about URI Pattern is documented here for oracle and postgres.

Installation

There are two ways to install db-wait. Directly via go or via make in combination with git and go. The advantage of the second option is that the binary is installed with all the additional files that the developer specifies.

# go
$ go install git.cryptic.systems/volker.raschek/db-wait

# git, make, go
$ git clone https://git.cryptic.systems/volker.raschek/db-wait.git && \
  cd db-wait && \
  make install PREFIX=/usr

Usage as container image

Alternatively can be db-wait used as container image. A local installation is not necessary.

# postgres
$ docker run --rm --network host docker.io/volkerraschek/db-wait:latest \
    postgres://user:password@localhost:5432/postgres?sslmode=disable

# oracle
$ docker run --rm --network host docker.io/volkerraschek/db-wait:latest \
    oracle://user:password@localhost:1521/xe