zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-07-26 12:38:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

Make the DB update instructions more comprehensive (#335)

Browse source 
* Make the DB update instructions more comprehensive

They were missing some initial steps.
This commit is contained in:
Ben McIlwain 2019-10-31 14:07:57 -04:00 • committed by GitHub
parent 6fe9cced3e
commit 5e61adb396
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

26
db/README.md
View file

@ -29,18 +29,28 @@ changes not yet deployed are pushed.
Below are the steps to submit a schema change: Below are the steps to submit a schema change:
1. Write the incremental DDL script that makes your changes to the existing 1. Make your changes to entity classes, remembering to add new ones to
schema. It should be stored in a new file in the `core/src/main/resources/META-INF/persistence.xml` so they'll be picked up.
2. Run the `nomulus generate_sql_schema` command to generate a new version of
`db-schema.sql.generated`. The full command line to do this is:
`./gradlew registryTool --args="-e localhost generate_sql_schema --start_postgresql -o /path/to/nomulus/db/src/main/resources/sql/schema/db-schema.sql.generated"`
3. Write an incremental DDL script that changes the existing schema to your
new one. The generated SQL file from the previous step should help. New
create table statements can be used as is, whereas alter table statements
should be written to change any existing tables.
This script should be stored in a new file in the
`db/src/main/resources/sql/flyway` folder using the naming pattern `db/src/main/resources/sql/flyway` folder using the naming pattern
`V{id}__{description text}.sql`, where `{id}` is the next highest number `V{id}__{description text}.sql`, where `{id}` is the next highest number
following the existing scripts in that folder. Also note that it is a following the existing scripts in that folder. Note the double underscore in
**double** underscore in the naming pattern. the naming pattern.
2. Run the `:db:test` task from the Gradle root project. The SchemaTest will 4. Run the `:db:test` task from the Gradle root project. The SchemaTest will
fail because the new schema does not match the golden file. fail because the new schema does not match the golden file.
3. Copy db/build/resources/test/testcontainer/mount/dump.txt to the golden file 5. Copy `db/build/resources/test/testcontainer/mount/dump.txt` to the golden file
(db/src/main/resources/sql/schema/nomulus.golden.sql). Diff it against the `db/src/main/resources/sql/schema/nomulus.golden.sql`. Diff it against the
old version and verify that all changes are expected. old version and verify that all changes are expected.
4. Rerun the `:db:test` task. This time all tests should pass. 6. Re-run the `:db:test` task. This time all tests should pass.
Relevant files (under db/src/main/resources/sql/schema/): Relevant files (under db/src/main/resources/sql/schema/):