Skip to content

add manual installation sqlite #1118

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 21, 2022
Merged

add manual installation sqlite #1118

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4dccf3
add manual installation sqlite
quiloos39 Sep 8, 2022
d1d49f8
Update docs/developer-docs/latest/setup-deployment-guides/configurati…
quiloos39 Sep 20, 2022
0f0a6ca
Update docs/developer-docs/latest/setup-deployment-guides/configurati…
quiloos39 Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions ...eveloper-docs/latest/setup-deployment-guides/configurations/databases/sqlite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/setup-deployment-guid

SQLite is the default ([Quick Start](/developer-docs/latest/getting-started/quick-start.md)) and recommended database to quickly create an app locally.

## Install SQLite locally
## Install SQLite using starter

Simply use one of the following commands.
Use one of the following commands:

<code-group>

Expand All @@ -34,6 +34,40 @@ This will create a new project and launch it in the browser.
The [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md) is a complete step-by-step tutorial.
:::

## Install SQLite manually

In terminal, run the following command:

<code-group>

<code-block title="NPM">
```sh
npm install better-sqlite3
```
</code-block>

<code-block title="YARN">
```sh
yarn add better-sqlite3
```
</code-block>

</code-group>

Add the following to your `./config/database.js` file:

```js
module.exports = ({ env }) => ({
connection: {
client: 'sqlite',
connection: {
filename: path.join(__dirname, '..', env('DATABASE_FILENAME', '.tmp/data.db')),
},
useNullAsDefault: true,
},
});
```

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 the following code for TypeScript as well (using the code-group/code block like above)?

import path from 'path';

export default ({ env }) => ({
  connection: {
    client: 'sqlite',
    connection: {
      filename: path.join(__dirname, '..', '..', env('DATABASE_FILENAME', '.tmp/data.db')),
    },
    useNullAsDefault: true,
  },
});

## Other SQL Databases (PostgreSQL, MySQL)

Refer to the [configuration section](/developer-docs/latest/setup-deployment-guides/configurations/required/databases.md) for all supported options to setup Strapi with your SQL database.
Expand Down