Skip to content
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

Update src/README with instructions on using sqlite #161

Merged
merged 8 commits into from
Dec 22, 2023
20 changes: 20 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,26 @@ Follow these directions for easier database editing.
- `npx prisma db push`
- Run the application and confirm it works

# Prisma SQLite
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a note on why someone would want to use SQLite?


- Update the schema.prisma file to use the following provider

`provider = "sqlite"`

- Update the env file to specify the database file

`DATABASE_URL="file:./db.sqlite"`

- Run the following command to update the database

```bash
npx prisma db push
```

> **_NOTE:_** SQLite is a [cross-platform](https://en.wikipedia.org/wiki/Cross-platform_software) database management system that provides a highly reliable, fast, and lightweight SQL database engine for everyone to use for any purpose.
>
>Learn more of why someone would want to use this free & open source library here: [When to use SQLite?](https://www.sqlite.org/whentouse.html)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The benefit to using SQLite is that it may be an easier alternative to stand up to SQL Server if someone is trying to run the project locally. A caveat is the demographic questions won't load because those are hard coded in the SQL migrations. Add something like the following below the title:

Motivation

SQLite is a light-weight alternative to Microsoft SQL Server which may be easier to stand up if you're running the project locally.

Note: The demographic questions will not populate because they are hard-coded in the SQL migrations.


# Working with prisma

When the data model changes, run the following to update your local database with the latest migrations
Expand Down