https://github.com/zaida04/drizzle-playground
📙 A code playground for teaching other people how to use the Drizzle ORM.
https://github.com/zaida04/drizzle-playground
Last synced: 9 months ago
JSON representation
📙 A code playground for teaching other people how to use the Drizzle ORM.
- Host: GitHub
- URL: https://github.com/zaida04/drizzle-playground
- Owner: zaida04
- Created: 2024-01-04T05:25:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T05:45:00.000Z (over 2 years ago)
- Last Synced: 2025-03-31T02:33:43.388Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Playground
This is a quick playground on how drizzle works and playing around with it.
The important bits are `package.json` (where utility short scripts live and our dependencies are specified), all the `*.sql` files under `drizzle/` and all the `*.ts` files under `src/`
Under `src/client.ts` that's where we connect to postgres and also set up drizzle
Under `src/schema.ts` that's where we define things like our tables. Whenever any tables are added, deleted, or changed, we run this using `npm run generate-migrations`. This generates SQL files for table stuff under `drizzle/*` using drizzle magic.
Under `src/run-migrations.ts` that's where we run our migrations. This doesn't run every time we run our application, we run it manually indepdently from (before) running our application to make sure the tables are ready beforehand. We run this using `npm run run-migrations`. That just runs this exact file.
Under `src/playground.ts` you have fun using drizzle.
## File Order
- `src/client.ts`
- `src/schema.ts`
- `src/run-migrations.ts`
- `src/playground.ts`
## Command Order
This is usually the order you should run the commands. The first two only need to be run once every time you **change the tables in any way**. The last one is ran every time you want to test your changes
- `npm run generate-migrations`
- `npm run run-migrations`
- `npm run playground`