forked from matrix-org/synapse
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some clarifications to README.md in the database schema directory. (
matrix-org#6615) Signed-off-by: Ruben Barkow-Kuder <[email protected]>
- Loading branch information
Showing
2 changed files
with
17 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
24
synapse/storage/data_stores/main/schema/full_schemas/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ | ||
|
||
``` | ||
./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. |