diff options
| author | Ruben Barkow-Kuder <rubo77@users.noreply.github.com> | 2020-02-20 11:37:57 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-20 10:37:57 +0000 |
| commit | 4fb5f4d0ce0444d1d3c2f0b9576b5a91b6307372 (patch) | |
| tree | 586612605a24b95843e91c5bdcd284f3a5325409 | |
| parent | Minor perf fixes to `get_auth_chain_ids`. (diff) | |
| download | synapse-4fb5f4d0ce0444d1d3c2f0b9576b5a91b6307372.tar.xz | |
Add some clarifications to README.md in the database schema directory. (#6615)
Signed-off-by: Ruben Barkow-Kuder <github@r.z11.de>
| -rw-r--r-- | changelog.d/6615.misc | 1 | ||||
| -rw-r--r-- | synapse/storage/data_stores/main/schema/full_schemas/README.md | 24 |
2 files changed, 17 insertions, 8 deletions
diff --git a/changelog.d/6615.misc b/changelog.d/6615.misc new file mode 100644 index 0000000000..9f93152565 --- /dev/null +++ b/changelog.d/6615.misc @@ -0,0 +1 @@ +Add some clarifications to `README.md` in the database schema directory. diff --git a/synapse/storage/data_stores/main/schema/full_schemas/README.md b/synapse/storage/data_stores/main/schema/full_schemas/README.md index bbd3f18604..c00f287190 100644 --- a/synapse/storage/data_stores/main/schema/full_schemas/README.md +++ b/synapse/storage/data_stores/main/schema/full_schemas/README.md @@ -1,13 +1,21 @@ -# Building full schema dumps +# Synapse Database Schemas -These schemas need to be made from a database that has had all background updates run. +These schemas are used as a basis to create brand new Synapse databases, on both +SQLite3 and Postgres. -To do so, use `scripts-dev/make_full_schema.sh`. This will produce -`full.sql.postgres ` and `full.sql.sqlite` files. +## Building full schema dumps + +If you want to recreate these schemas, they need to be made from a database that +has had all background updates run. + +To do so, use `scripts-dev/make_full_schema.sh`. This will produce new +`full.sql.postgres ` and `full.sql.sqlite` files. Ensure postgres is installed and your user has the ability to run bash commands -such as `createdb`. +such as `createdb`, then call + + ./scripts-dev/make_full_schema.sh -p postgres_username -o output_dir/ -``` -./scripts-dev/make_full_schema.sh -p postgres_username -o output_dir/ -``` +There are currently two folders with full-schema snapshots. `16` is a snapshot +from 2015, for historical reference. The other contains the most recent full +schema snapshot. |