matrix-docker-ansible-deploy/docs/importing-synapse-sqlite.md

# Importing an existing SQLite database from another Synapse installation (optional)

Run this if you'd like to import your database from a previous default installation of Synapse.
(don't forget to import your `media_store` files as well - see [the importing-synapse-media-store guide](importing-synapse-media-store.md)).

While this playbook always sets up PostgreSQL, by default a Synapse installation would run
using an SQLite database.

If you have such a Synapse setup and wish to migrate it here (and over to PostgreSQL), this command is for you.


## Prerequisites

Before doing the actual import, **you need to upload your SQLite database file to the server** (any path is okay).


## Importing

Run this command (make sure to replace `<server-path-to-homeserver.db>` with a file path on your server):

	ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_homeserver_db=<server-path-to-homeserver.db>' --tags=import-synapse-sqlite-db

**Notes**:

- `<server-path-to-homeserver.db>` must be a file path to a `homeserver.db` **file on the server** (not on your local machine!).
- if the SQLite database is from an older version of Synapse, the **importing procedure may run migrations on it to bring it up to date**. That is, your SQLite database file may get modified and become unusable with your older Synapse version. Keeping a copy of the original is probably wise.
Rename some doc files and commands related to importing Since we'll likely have generic SQLite database importing via [pgloader](https://pgloader.io/) for migrating bridge databases from SQLite to Postgres, we'd rather avoid calling the "import Synapse SQLite database" command as just `--tags=import-sqlite-db`. Similarly, for the media store, we'd like to mention that it's related to Synapse as well. We'd like to be more explicit, so as to be less confusing, especially in light of other homeserver implementations coming in the future. 2020-12-14 07:48:36 +08:00			`# Importing an existing SQLite database from another Synapse installation (optional)`
Split README into a bunch of files in docs/ 2018-08-08 15:07:02 +08:00
Do not refer to Synapse as "Matrix Synapse" 2019-04-23 15:20:56 +08:00			`Run this if you'd like to import your database from a previous default installation of Synapse.`
Rename some doc files and commands related to importing Since we'll likely have generic SQLite database importing via [pgloader](https://pgloader.io/) for migrating bridge databases from SQLite to Postgres, we'd rather avoid calling the "import Synapse SQLite database" command as just `--tags=import-sqlite-db`. Similarly, for the media store, we'd like to mention that it's related to Synapse as well. We'd like to be more explicit, so as to be less confusing, especially in light of other homeserver implementations coming in the future. 2020-12-14 07:48:36 +08:00			(don't forget to import your `media_store` files as well - see [the importing-synapse-media-store guide](importing-synapse-media-store.md)).
Split README into a bunch of files in docs/ 2018-08-08 15:07:02 +08:00
Do not refer to Synapse as "Matrix Synapse" 2019-04-23 15:20:56 +08:00			`While this playbook always sets up PostgreSQL, by default a Synapse installation would run`
Split README into a bunch of files in docs/ 2018-08-08 15:07:02 +08:00			`using an SQLite database.`

Do not refer to Synapse as "Matrix Synapse" 2019-04-23 15:20:56 +08:00			`If you have such a Synapse setup and wish to migrate it here (and over to PostgreSQL), this command is for you.`
Split README into a bunch of files in docs/ 2018-08-08 15:07:02 +08:00

Make SQLite database import work with server files, not local This is a simplification and a way to make it consistent with how we do Postgres imports (see 6d89319822f4b2ecb), using files coming from the server, not from the local machine. 2019-01-01 21:16:13 +08:00			`## Prerequisites`
Split README into a bunch of files in docs/ 2018-08-08 15:07:02 +08:00
Update documentation 2019-01-01 21:35:33 +08:00			`Before doing the actual import, you need to upload your SQLite database file to the server (any path is okay).`
Make SQLite database import work with server files, not local This is a simplification and a way to make it consistent with how we do Postgres imports (see 6d89319822f4b2ecb), using files coming from the server, not from the local machine. 2019-01-01 21:16:13 +08:00

			`## Importing`

			Run this command (make sure to replace `<server-path-to-homeserver.db>` with a file path on your server):

Rename some doc files and commands related to importing Since we'll likely have generic SQLite database importing via [pgloader](https://pgloader.io/) for migrating bridge databases from SQLite to Postgres, we'd rather avoid calling the "import Synapse SQLite database" command as just `--tags=import-sqlite-db`. Similarly, for the media store, we'd like to mention that it's related to Synapse as well. We'd like to be more explicit, so as to be less confusing, especially in light of other homeserver implementations coming in the future. 2020-12-14 07:48:36 +08:00			`ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_homeserver_db=<server-path-to-homeserver.db>' --tags=import-synapse-sqlite-db`
Make SQLite database import work with server files, not local This is a simplification and a way to make it consistent with how we do Postgres imports (see 6d89319822f4b2ecb), using files coming from the server, not from the local machine. 2019-01-01 21:16:13 +08:00
Add additional notice to SQLite importing docs 2020-10-07 14:06:59 +08:00			`Notes:`

			- `<server-path-to-homeserver.db>` must be a file path to a `homeserver.db` file on the server (not on your local machine!).
			`- if the SQLite database is from an older version of Synapse, the importing procedure may run migrations on it to bring it up to date. That is, your SQLite database file may get modified and become unusable with your older Synapse version. Keeping a copy of the original is probably wise.`