Skip to content

Doc: clarify SQLite usage as backend option #446

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Doc: clarify SQLite usage as backend option #446

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e82da57
Update migrate-to-sql-backend.mdx
WanYixian May 15, 2025
416a2d1
revision
WanYixian May 21, 2025
5774cfe
Merge branch 'main' into wyx/remove-sqlite-from-backend-options
WanYixian Jul 8, 2025
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
10 changes: 5 additions & 5 deletions deploy/migrate-to-sql-backend.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Starting from **v1.9.0**, RisingWave has introduced support for using a SQL back
The SQL backend currently supports these databases:

* **PostgreSQL** (Recommended for production environments.)
* **SQLite** (Limited to testing and pilot deployments.)
* **MySQL** (Limited to testing and pilot deployments.)
* **MySQL** (Suited for testing and pilot deployments.)
* **SQLite** (Intended for local testing only.)

Transitioning to a SQL backend offers numerous benefits, including enhanced stability, performance, and observability. In this guide, we will walk through the process of migrating an existing cluster from the etcd backend to a SQL backend.

Expand All @@ -21,13 +21,13 @@ Ensure the following before starting the migration:

You need to have a SQL backend service running and accessible. Depending on your choice of SQL backend, here are the general requirements:

* SQLite
* Provide a writable directory where the SQLite database file can be stored.
* SQLite operates directly from a file, so no separate service needs to be started.
* PostgreSQL
* Ensure that a PostgreSQL server is running and a database is prepared for use with RisingWave.
* MySQL
* Ensure that a MySQL server is running and a database is prepared for use with RisingWave.
* SQLite
* Provide a writable directory where the SQLite database file can be stored.
* SQLite operates directly from a file, so no separate service needs to be started.

Make sure the SQL backend service is operational and you have the necessary credentials and access configurations to connect to it from the server where RisingWave is deployed.

Expand Down
2 changes: 1 addition & 1 deletion deploy/risingwave-docker-compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ In the `docker-compose-with-obs.yml` file, specify the bucket name via the `humm

For meta store, RisingWave uses [postgresql](#postgresql) as the default meta store backend and also supports the following meta store backends:

* [SQLite](#sqlite)
* [MySQL or MySQL-compatible storage](#mysql-or-mysql-compatible-storage)
* [SQLite](#sqlite)

To customize the meta store backend, you need to configure the following settings.

Expand Down
Loading