SYNAPSE_PORT_DB(1) General Commands Manual SYNAPSE_PORT_DB(1)
NAME
synapse_port_db - A script to port an existing synapse SQLite database
to a new PostgreSQL database.
SYNOPSIS
synapse_port_db [-v] --sqlite-database=dbfile --postgres-config=yaml-
config [--curses] [--batch-size=batch-size]
DESCRIPTION
synapse_port_db ports an existing synapse SQLite database to a new
PostgreSQL database.
SQLite database is specified with --sqlite-database option and Post-
greSQL configuration required to connect to PostgreSQL database is pro-
vided using --postgres-config configuration. The configuration is spec-
ified in YAML format.
OPTIONS
-v Print log messages in debug level instead of info level.
--sqlite-database
The snapshot of the SQLite database file. This must not be cur-
rently used by a running synapse server.
--postgres-config
The database config file for the PostgreSQL database.
--curses
Display a curses based progress UI.
CONFIG FILE
The postgres configuration file must be a valid YAML file with the fol-
lowing options.
○ database: Database configuration section. This section header can
be ignored and the options below may be specified as top level
keys.
○ name: Connector to use when connecting to the database. This value
must be psycopg2.
○ args: DB API 2.0 compatible arguments to send to the psycopg2 mod-
ule.
○ dbname - the database name
○ user - user name used to authenticate
○ password - password used to authenticate
○ host - database host address (defaults to UNIX socket if not pro-
vided)
○ port - connection port number (defaults to 5432 if not provided)
○ synchronous_commit: Optional. Default is True. If the value is
False, enable asynchronous commit and don't wait for the server to
call fsync before ending the transaction. See: https://www.post-
gresql.org/docs/current/static/wal-async-commit.html
Following example illustrates the configuration file format.
database:
name: psycopg2
args:
dbname: synapsedb
user: synapseuser
password: ORohmi9Eet=ohphi
host: localhost
synchronous_commit: false
COPYRIGHT
This man page was written by Sunil Mohan Adapa «sunil@medhas.org» for
Debian GNU/Linux distribution.
SEE ALSO
synctl(1), synapse_hash_password(1), synapse_register_new_ma-
trix_user(1)
March 2022 SYNAPSE_PORT_DB(1)
Generated by dwww version 1.15 on Tue Sep 2 07:28:40 CEST 2025.