eris-db-client

Misc

We must pass our commands to the Docker container. This is a really long command:

docker-compose -f docker-compose.cli.yml run --rm yarn

For this reason, it is recommended to create an alias for docker-compose -f docker-compose.cli.yml run --rm and call it dcli (Docker CLI).

echo "alias dcli='docker-compose -f docker-compose.cli.yml run --rm'" >> ~/.bashrc
source ~/.bashrc

Execution

To execute the project it's necessary configure de environment variables, we have a .env.dist file to facilitate.

We use the docker-compose to run the project.

First, you need to clone the repository.

git clone [email protected]:tenzen/eris-db-client.git

After that you need to install the dependencies.

cp docker-compose.override.yml.dist docker-compose.override.yml && cp .env.dist .env

Build and pull the development images

docker-compose build --pull

Initialize docker development environment to continue:

docker-compose up -d

Install/Update packages

dcli yarn

Tests

Unit

dcli yarn test

E2e

dcli yarn test:e2e

Prisma Migrations

Just create the migration.sql and down.sql files

dcli yarn db:migrate:up <name>

Revert the migration version when the folder of migration does not exists

dcli yarn db:migrate:down

Apply the migrations to the database

dcli yarn db:migrate:deploy

Hasura

To apply metadata

dcli yarn hasura:metadata:apply

Run

After the docker configuration and running is possible to open the Hasura console http://localhost:9695

usage example

#!/usr/bin/env node

import { database } from 'eris-db-client'

const getSkinToneCount = async () => {
  const count = await database.skinTone.count()

  console.log({ count })
}

getSkinToneCount()

After ran all of these you should be completly sure you apply new changes to the db schema

How to update db Schema dbml

dcli yarn prisma:generate