Matrix-Mirrors/forked-synapse
1
0
Fork 0
mirror of https://mau.dev/maunium/synapse.git synced 2024-07-16 08:01:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add example directory structures in doc

Browse Source
This commit is contained in:
Erik Johnston 2015-03-04 14:20:14 +00:00
parent 16dd87d848
commit f701197227
1 changed files with 36 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
synapse/storage/__init__.py
View File

@ -608,10 +608,27 @@ def _setup_new_database(cur):
The "full_schemas" directory has subdirectories named after versions. This The "full_schemas" directory has subdirectories named after versions. This
function searches for the highest version less than or equal to function searches for the highest version less than or equal to
`SCHEMA_VERSION` and excutes all .sql files in that directory. `SCHEMA_VERSION` and executes all .sql files in that directory.
The function will then apply all deltas for all versions after the base The function will then apply all deltas for all versions after the base
version. version.
Example directory structure:
schema/
delta/
...
full_schemas/
3/
test.sql
...
11/
foo.sql
bar.sql
...
In the example foo.sql and bar.sql would be run, and then any delta files
for versions strictly greater than 11.
""" """
current_dir = os.path.join(dir_path, "schema", "full_schemas") current_dir = os.path.join(dir_path, "schema", "full_schemas")
directory_entries = os.listdir(current_dir) directory_entries = os.listdir(current_dir)
@ -675,6 +692,24 @@ def _upgrade_existing_database(cur, current_version, delta_files, upgraded):
This is a no-op of current_version == SCHEMA_VERSION. This is a no-op of current_version == SCHEMA_VERSION.
Example directory structure:
schema/
delta/
11/
foo.sql
...
12/
foo.sql
bar.py
...
full_schemas/
...
In the example, if current_version is 11, then foo.sql will be run if and
only if `upgraded` is True. Then `foo.sql` and `bar.py` would be run in
some arbitrary order.
Args: Args:
cur (Cursor) cur (Cursor)
current_version (int): The current version of the schema current_version (int): The current version of the schema