Skip to content

README.md

Latest commit

 

History

History
33 lines (19 loc) · 1.5 KB

README.md

File metadata and controls

33 lines (19 loc) · 1.5 KB

Datahub database

This package is the database connector needed to read and write Datahub data. To connect to the database via the Research App, ensure the environment variable DATABASE_URL is set in apps/researcher/.env.local. If you want to connect to the database outside the app to run scripts, add the DATABASE_URL to packages/database/.env.local.

Connecting to the local MySQL database with Docker.

You can create a MySQL database with Docker. Use the following command to start your MySQL container. It will create a new Docker volume called 'mysql'.

docker run --name mysql -d \
    -p 3306:3306 \
    -e MYSQL_ROOT_PASSWORD=change-me \
    -v mysql:/var/lib/mysql \
    mysql:8

More commands can be found in the helpful blog How to Use Docker for Your MySQL Database.

Create a new database with:

npm run db:create -w @colonial-collections/database

Set the DATABASE_URL to:

DATABASE_URL='mysql://root:{password}@localhost:3306/{database_name}'

Schema migrations

Whenever you make changes to the database schema in src/db/schema.ts, you need to run npm run db:generate, which will generate a SQL migration file for you.

To push the changes to your local database, run npm run db:migrate.

Drizzle Studio

With Drizzle Studio, you can explore the SQL database. Depending on the DATABASE_URL, you can explore both local and PlanetScale databases. Open Drizzle Studio with npm run db:studio -w @colonial-collections/database.