a126b5f5aa
* WIP converted all sqlite models into prisma calls * modify db setup and fix ApiKey model calls in admin.js * renaming function params to be consistent * converted adminEndpoints to utilize prisma orm * converted chatEndpoints to utilize prisma orm * converted inviteEndpoints to utilize prisma orm * converted systemEndpoints to utilize prisma orm * converted workspaceEndpoints to utilize prisma orm * converting sql queries to prisma calls * fixed default param bug for orderBy and limit * fixed typo for workspace chats * fixed order of deletion to account for sql relations * fix invite CRUD and workspace management CRUD * fixed CRUD for api keys * created prisma setup scripts/docs for understanding how to use prisma * prisma dependency change * removing unneeded console.logs * removing unneeded sql escape function * linting and creating migration script * migration from depreciated sqlite script update * removing unneeded migrations in prisma folder * create backup of old sqlite db and use transactions to ensure all operations complete successfully * adding migrations to gitignore * updated PRISMA.md docs for info on how to use sqlite migration script * comment changes * adding back migrations folder to repo * Reviewing SQL and prisma integraiton on fresh repo * update inline key replacement * ensure migration script executes and maps foreign_keys regardless of db ordering * run migration endpoint * support new prisma backend * bump version * change migration call --------- Co-authored-by: timothycarambat <rambat1010@gmail.com>
2.8 KiB
Prisma Setup and Usage Guide
This guide will help you set up and use Prisma for the project. Prisma is a powerful ORM for Node.js and TypeScript, helping developers build faster and make fewer errors. Follow the guide to understand how to use Prisma and the scripts available in the project to manage the Prisma setup.
Setting Up Prisma
To get started with setting up Prisma, you should run the setup script from the project root directory:
yarn setup
This script will install the necessary node modules in both the server and frontend directories, set up the environment files, and set up Prisma (generate client, run migrations, and seed the database).
Prisma Scripts
In the project root's package.json, there are several scripts set up to help you manage Prisma:
- prisma:generate: Generates the Prisma client.
- prisma:migrate: Runs the migrations to ensure the database is in sync with the schema.
- prisma:seed: Seeds the database with initial data.
- prisma:setup: A convenience script that runs
prisma:generate,prisma:migrate, andprisma:seedin sequence. - sqlite:migrate: (To be run from the
serverdirectory) This script is for users transitioning from the old SQLite custom ORM setup to Prisma and will migrate all exisiting data over to Prisma. If you're a new user, your setup will already use Prisma.
To run any of these scripts, use yarn followed by the script name from the project root directory. For example:
yarn prisma:setup
Manual Prisma Commands
While the scripts should cover most of your needs, you may sometimes want to run Prisma commands manually. Here are some commands you might find useful, along with their descriptions:
npx prisma introspect: Introspects the database to update the Prisma schema by reading the schema of the existing database.npx prisma generate: Generates the Prisma client.npx prisma migrate dev --name init: Ensures the database is in sync with the schema, naming the migration 'init'.npx prisma migrate reset: Resets the database, deleting all data and recreating the schema.
These commands should be run from the server directory, where the Prisma schema is located.
Notes
- Always make sure to run scripts from the root level to avoid path issues.
- Before running migrations, ensure that the Prisma schema is correctly defined to prevent data loss or corruption.
- If you are adding a new feature or making changes that require a change in the database schema, create a new migration rather than editing existing migrations.
- For users transitioning from the old SQLite ORM, navigate to the
serverdirectory and run thesqlite:migratescript to smoothly transition to Prisma. If you're setting up the project fresh, this step is unnecessary as the setup will already be using Prisma.