OS Manuals

/usr/local/bin/synapse_port_db

Compat package for upstream Docker image paths

From synapse-compat 1.164.2-r0 (enterprise-packages), captured 2026-11-08 by running synapse_port_db --help (exit 0). permalink

usage: synapse_port_db [-h] [-v] --sqlite-database SQLITE_DATABASE
                       --postgres-config POSTGRES_CONFIG [--curses] [--batch-size BATCH_SIZE]

A script to port an existing synapse SQLite database to a new PostgreSQL database.

options:
  -h, --help            show this help message and exit
  -v
  --sqlite-database SQLITE_DATABASE
                        The snapshot of the SQLite database file. This must not be currently used
                        by a running synapse server
  --postgres-config POSTGRES_CONFIG
                        The database config file for the PostgreSQL database
  --curses              display a curses based progress UI
  --batch-size BATCH_SIZE
                        The number of rows to select from the SQLite table each iteration
                        [default=1000]
Options (6)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
-vhelp
--sqlite-database SQLITE_DATABASEThe snapshot of the SQLite database file.help
--postgres-config POSTGRES_CONFIGThe database config file for the PostgreSQL databasehelp
--cursesdisplay a curses based progress UIhelp
--batch-size BATCH_SIZEThe number of rows to select from the SQLite table each iteration [default=1000]help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.