Skip to main content

How to run db helpers

Db everywhere

These are helpers command for your db_services.

  # this will show you help message
  corgi

  # before running db commands you need to create corgi-compose.yml file, add services config there and run corgi init, so that there is db_services folder, that is created

  # example to run db service
  corgi db

  # example to show help commands
  corgi db -h
  corgi -h

You can run cli with flags, without specifying service, to do smth with all databases, for example:

  # run db service and start all databases
  corgi db -u
  # similar to
  corgi db -upAll

  # stop, remove and start all databases 
  corgi db  -r -s -u
  # similar to
  corgi db  -rsu
  # similar to
  corgi db  -removeAll -stopAll -upAll

You can run each service individually, e.g. corgi db. It will show you interactive menu to choose one of the service databases, that are located in corgi_services/db_services folder.

Use the arrow keys to navigate: ↓ ↑ → ← 
? Select service: 
  ▸ 🛑  close program
    analytics
    backend
    backoffice

This menu helps to choose target service and its commands, that are located in Makefile of targeted service (we choose backoffice service for example)

Connection info to backoffice:

PORT 5432
USER corgi
PASSWORD corgiPassword
DB corgi-adm

backoffice ist running 🔴
Use the arrow keys to navigate: ↓ ↑ → ← 
? Select command: 
  ▸ ⬅️  go back
    down
    help
    id
    listDocker
    seed
↓   up

Database seeding​

If you want to do seeding manually to do database seeding (population with data), you can do it:

Add seedSource in corgi-compose.yml and then run

corgi run --seed

It will create dump of data and then seed it to your database.

Tip You can add in seedFromDbEnvPath the path to env config with db in the form of:

DB_HOST=host_of_db_from_which_to_get_dump
DB_NAME=name_of_db_from_which_to_get_dump
DB_USER=user_of_db_from_which_to_get_dump
DB_PASSWORD=password_of_db_from_which_to_get_dump
DB_PORT=port_of_db_from_which_to_get_dump

If you provided seedSource in corgi-compose.yml, than you can do:

  1. corgi db-> choose service -> Choose dump
  2. corgi db-> choose service -> Choose seed

If no seedSource provided:

  1. Create database dump, name it dump.sql and place it in targeted service, e.g. place it in corgi_services/db_services/backoffice folder
  2. Run corgi db from root folder
  3. Choose service
  4. Choose seed. It will populate db.

Important: seeding is best to do on newly created db.

Main docs