Skip to content
Snippets Groups Projects
Unverified Commit 4fb5f4d0 authored by Ruben Barkow-Kuder's avatar Ruben Barkow-Kuder Committed by GitHub
Browse files

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

parent 7b7c3ced
No related branches found
No related tags found
No related merge requests found
Add some clarifications to `README.md` in the database schema directory.
# 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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment