-
Notifications
You must be signed in to change notification settings - Fork 188
Add Telescope Prisma docs #3503
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| sidebar_position: 11 | ||
| --- | ||
|
|
||
| # Prisma | ||
|
|
||
| ## Our Database | ||
|
|
||
| [Supabase](./supabase.md) is one of the technologies that Telescope uses. Because it is built on top of Postgres, we have full access to a Postgres DB that can be used to store all sorts of data used by both frontend and backend. | ||
|
|
||
| > PostgreSQL is a highly stable database backed by more than 20 years of development by the open-source community. | ||
|
|
||
| ## Database Schema | ||
|
|
||
| Our database schema is defined in [schema.prisma](https://github.com/Seneca-CDOT/telescope/blob/master/src/db/prisma/schema.prisma). This is where we define models and their relations using Prisma's schema syntax. | ||
|
|
||
| Managing the database schema using Prisma, we can track granular changes to the database schema. These granular changes are reflected as separate SQL script files. That way, our granular schema changes are reflected as code that can be captured with any version control software. This makes sure that the local development database or the production database is always up to date with the latest Schema. | ||
|
|
||
| ## Database migration | ||
|
|
||
| Whenever we start up the DB container or after updating our schema, we should run a migration to apply new changes to the database if any. | ||
|
|
||
| ## Running migration | ||
|
|
||
| ```bash | ||
| cd src/db | ||
| cp env.example .env | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Question: should we default to this somehow vs. making it a requirement? That is, do we ever need to change the values in this file? If not, maybe we should hard-code it into the script.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, we don't have a way to run migrations on the remote DB.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we hardcode the DATABASE_URL if the DB password on dev and production are different? |
||
| pnpm migrate | ||
| ``` | ||
|
|
||
| See also [DB maintenance on staging and production](../contributing/database-maintenance.md). | ||
|
|
||
| ## Creating migration | ||
|
|
||
| For a migration that has a "narrowing" nature such as dropping a table, dropping a column or converting data types or similar changes, running a migration requires attention to make sure the data loss is under control. Prisma is smart enough to warn us about any potential data loss. | ||
|
|
||
| ### Schema change | ||
|
|
||
| Simply edit the schema in [schema.prisma](https://github.com/Seneca-CDOT/telescope/blob/master/src/db/prisma/schema.prisma) and apply the migration. | ||
|
|
||
| ```bash | ||
| cd src/db | ||
| cp env.example .env | ||
| pnpm migrate | ||
| ``` | ||
|
|
||
| ### Custom migration | ||
|
|
||
| Sometimes, we want to make changes other than the modifying the schema, for example, adding new RLS policies to a table. We can do so by creating an empty migration file, which is an empty SQL script where we write our own SQL queries to be applied to the database. | ||
|
|
||
| ```bash | ||
| cd src/db | ||
| cp env.example .env | ||
| pnpm create-migration | ||
| ``` | ||
|
|
||
| After creating the empty migration file, you can write SQL queries inside the newly created `migration.sql`. After writing the desired statements, you can apply the migration: | ||
|
|
||
| ```bash | ||
| pnpm migrate | ||
| ``` | ||
Uh oh!
There was an error while loading. Please reload this page.