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.

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

Jump to bottom

docs: discourage the use of SQLite #23794

Merged
merged 2 commits into from
Apr 26, 2023
Merged

docs: discourage the use of SQLite #23794

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28a1ac7
docs: discourage the use of SQLite
dpgaspar Apr 24, 2023
a3b03b2
improvement
dpgaspar Apr 24, 2023
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
9 changes: 5 additions & 4 deletions docs/docs/installation/configuring-superset.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,11 @@ WTF_CSRF_EXEMPT_LIST = [‘’]

### Using a production metastore

By default Superset is configured to use SQLite, it's a simple and fast way to get you started
(no installation needed). But for production environments you should use a different database engine on
a separate host or container.
By default, Superset is configured to use SQLite, which is a simple and fast way to get started
(without requiring any installation). However, for production environments,
using SQLite is highly discouraged due to security, scalability, and data integrity reasons.
It's important to use only the supported database engines and consider using a different
database engine on a separate host or container.
Comment on lines +77 to +78
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
It's important to use only the supported database engines and consider using a different
database engine on a separate host or container.
We recommend using another supported database engine on a separate host or container.

Copy link
Member Author

Choose a reason for hiding this comment

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

shorter but seems a bit confusing to say "another supported database engine on a separate host"


Superset supports the following database engines/versions:

Expand All @@ -89,7 +91,6 @@ Use the following database drivers and connection strings:
| ----------------------------------------- | --------------------------------- | ------------------------------------------------------------------------ |
| [PostgreSQL](https://www.postgresql.org/) | `pip install psycopg2` | `postgresql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| [MySQL](https://www.mysql.com/) | `pip install mysqlclient` | `mysql://<UserName>:<DBPassword>@<Database Host>/<Database Name>` |
| SQLite | No additional library needed | `sqlite://` |

To configure Superset metastore set `SQLALCHEMY_DATABASE_URI` config key on `superset_config`
to the appropriate connection string.
Expand Down