Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

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

Merged
merged 1 commit into from
Feb 20, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/6615.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add some clarifications to `README.md` in the database schema directory.
24 changes: 16 additions & 8 deletions synapse/storage/data_stores/main/schema/full_schemas/README.md
Original file line number Diff line number Diff line change
@@ -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/

```
rubo77 marked this conversation as resolved.
Show resolved Hide resolved
./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.