MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-07-04 10:18:52 +02:00
Code Issues Projects Releases Wiki Activity

Add some clarifications to README.md in the database schema directory. (#6615)

Browse source 
Signed-off-by: Ruben Barkow-Kuder <github@r.z11.de>
This commit is contained in:
Ruben Barkow-Kuder 2020-02-20 11:37:57 +01:00 committed by GitHub
parent 7b7c3cedf2
commit 4fb5f4d0ce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/6615.misc Normal file
View file

@ -0,0 +1 @@
Add some clarifications to `README.md` in the database schema directory.

24
synapse/storage/data_stores/main/schema/full_schemas/README.md
View file

@ -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.