Skip to content

Commit e568d52

Browse files
rubo77phil-flex
authored andcommitted
Add some clarifications to README.md in the database schema directory. (matrix-org#6615)
Signed-off-by: Ruben Barkow-Kuder <[email protected]>
1 parent c901b44 commit e568d52

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

changelog.d/6615.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add some clarifications to `README.md` in the database schema directory.
Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1-
# Building full schema dumps
1+
# Synapse Database Schemas
22

3-
These schemas need to be made from a database that has had all background updates run.
3+
These schemas are used as a basis to create brand new Synapse databases, on both
4+
SQLite3 and Postgres.
45

5-
To do so, use `scripts-dev/make_full_schema.sh`. This will produce
6-
`full.sql.postgres ` and `full.sql.sqlite` files.
6+
## Building full schema dumps
7+
8+
If you want to recreate these schemas, they need to be made from a database that
9+
has had all background updates run.
10+
11+
To do so, use `scripts-dev/make_full_schema.sh`. This will produce new
12+
`full.sql.postgres ` and `full.sql.sqlite` files.
713

814
Ensure postgres is installed and your user has the ability to run bash commands
9-
such as `createdb`.
15+
such as `createdb`, then call
16+
17+
./scripts-dev/make_full_schema.sh -p postgres_username -o output_dir/
1018

11-
```
12-
./scripts-dev/make_full_schema.sh -p postgres_username -o output_dir/
13-
```
19+
There are currently two folders with full-schema snapshots. `16` is a snapshot
20+
from 2015, for historical reference. The other contains the most recent full
21+
schema snapshot.

0 commit comments

Comments
 (0)