2019-10-12 21:52:04 +05:30
# Database Review Guidelines
This page is specific to database reviews. Please refer to our
[code review guide ](code_review.md ) for broader advice and best
practices for code review in general.
## General process
A database review is required for:
- Changes that touch the database schema or perform data migrations,
including files in:
- `db/`
- `lib/gitlab/background_migration/`
2020-04-08 14:13:33 +05:30
- Changes to the database tooling. For example:
2019-10-12 21:52:04 +05:30
- migration or ActiveRecord helpers in `lib/gitlab/database/`
- load balancing
- Changes that produce SQL queries that are beyond the obvious. It is
generally up to the author of a merge request to decide whether or
not complex queries are being introduced and if they require a
database review.
A database reviewer is expected to look out for obviously complex
queries in the change and review those closer. If the author does not
point out specific queries for review and there are no obviously
complex queries, it is enough to concentrate on reviewing the
migration only.
It is preferable to review queries in SQL form and generally accepted
to ask the author to translate any ActiveRecord queries in SQL form
for review.
### Roles and process
2020-03-13 15:44:24 +05:30
A Merge Request **author** 's role is to:
2019-10-12 21:52:04 +05:30
- Decide whether a database review is needed.
- If database review is needed, add the ~database label.
2019-12-04 20:38:33 +05:30
- [Prepare the merge request for a database review ](#how-to-prepare-the-merge-request-for-a-database-review ).
2019-10-12 21:52:04 +05:30
A database **reviewer** 's role is to:
- Perform a first-pass review on the MR and suggest improvements to the author.
- Once satisfied, relabel the MR with ~"database::reviewed", approve it, and
reassign MR to the database **maintainer** suggested by Reviewer
Roulette.
A database **maintainer** 's role is to:
- Perform the final database review on the MR.
- Discuss further improvements or other relevant changes with the
database reviewer and the MR author.
- Finally approve the MR and relabel the MR with ~"database::approved"
- Merge the MR if no other approvals are pending or pass it on to
other maintainers as required (frontend, backend, docs).
### Distributing review workload
Review workload is distributed using [reviewer roulette ](code_review.md#reviewer-roulette )
2020-03-13 15:44:24 +05:30
([example](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25181#note_147551725)).
2019-10-12 21:52:04 +05:30
The MR author should then co-assign the suggested database
**reviewer**. When they give their sign-off, they will hand over to
the suggested database **maintainer** .
If reviewer roulette didn't suggest a database reviewer & maintainer,
make sure you have applied the ~database label and rerun the
`danger-review` CI job, or pick someone from the
[`@gl-database` team ](https://gitlab.com/groups/gl-database/-/group_members ).
2019-12-04 20:38:33 +05:30
### How to prepare the merge request for a database review
2019-10-12 21:52:04 +05:30
2020-03-13 15:44:24 +05:30
In order to make reviewing easier and therefore faster, please take
the following preparations into account.
2019-10-12 21:52:04 +05:30
2020-03-13 15:44:24 +05:30
#### Preparation when adding migrations
2020-04-22 19:07:51 +05:30
- Ensure `db/structure.sql` is updated.
2020-03-13 15:44:24 +05:30
- Make migrations reversible by using the `change` method or include a `down` method when using `up` .
- Include either a rollback procedure or describe how to rollback changes.
2020-04-22 19:07:51 +05:30
- Add the output of both migrating and rolling back for all migrations into the MR description
- Ensure the down method reverts the changes in `db/structure.sql`
- Update the migration output whenever you modify the migrations during the review process
2020-04-08 14:13:33 +05:30
- Add tests for the migration in `spec/migrations` if necessary. See [Testing Rails migrations at GitLab ](testing_guide/testing_migrations_guide.md ) for more details.
2020-04-22 19:07:51 +05:30
- When [high-traffic ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/migration_helpers.rb#L12 ) tables are involved in the migration, use the [`with_lock_retries` ](migration_style_guide.md#retry-mechanism-when-acquiring-database-locks ) helper method. Review the relevant [examples in our documentation ](migration_style_guide.md#examples ) for use cases and solutions.
- Ensure RuboCop checks are not disabled unless there's a valid reason to.
2020-03-13 15:44:24 +05:30
#### Preparation when adding or modifying queries
- Write the raw SQL in the MR description. Preferably formatted
nicely with [sqlformat.darold.net ](http://sqlformat.darold.net ) or
[paste.depesz.com ](https://paste.depesz.com ).
- Include the output of `EXPLAIN (ANALYZE, BUFFERS)` of the relevant
queries in the description. If the output is too long, wrap it in
`<details>` blocks, paste it in a GitLab Snippet, or provide the
link to the plan at: [explain.depesz.com ](https://explain.depesz.com ).
- When providing query plans, make sure it hits enough data:
- You can use a GitLab production replica to test your queries on a large scale,
through the `#database-lab` Slack channel or through [chatops ](understanding_explain_plans.md#chatops ).
- Usually, the `gitlab-org` namespace (`namespace_id = 9970`) and the
`gitlab-org/gitlab-foss` (`project_id = 13083`) or the `gitlab-org/gitlab` (`project_id = 278964`)
projects provide enough data to serve as a good example.
- For query changes, it is best to provide the SQL query along with a
plan _before_ and _after_ the change. This helps to spot differences
quickly.
- Include data that shows the performance improvement, preferably in
the form of a benchmark.
#### Preparation when adding foreign keys to existing tables
- Include a migration to remove orphaned rows in the source table **before** adding the foreign key.
- Remove any instances of `dependent: ...` that may no longer be necessary.
#### Preparation when adding tables
- Order columns based on the [Ordering Table Columns ](ordering_table_columns.md ) guidelines.
- Add foreign keys to any columns pointing to data in other tables, including [an index ](migration_style_guide.md#adding-foreign-key-constraints ).
- Add indexes for fields that are used in statements such as `WHERE` , `ORDER BY` , `GROUP BY` , and `JOIN` s.
2020-04-08 14:13:33 +05:30
#### Preparation when removing columns, tables, indexes, or other structures
2020-03-13 15:44:24 +05:30
- Follow the [guidelines on dropping columns ](what_requires_downtime.md#dropping-columns ).
2020-04-08 14:13:33 +05:30
- Generally it's best practice (but not a hard rule) to remove indexes and foreign keys in a post-deployment migration.
2020-03-13 15:44:24 +05:30
- Exceptions include removing indexes and foreign keys for small tables.
2020-04-08 14:13:33 +05:30
- If you're adding a composite index, another index might become redundant, so remove that in the same migration.
For example adding `index(column_A, column_B, column_C)` makes the indexes `index(column_A, column_B)` and `index(column_A)` redundant.
2019-10-12 21:52:04 +05:30
### How to review for database
- Check migrations
- Review relational modeling and design choices
- Review migrations follow [database migration style guide ](migration_style_guide.md ),
for example
- [Check ordering of columns ](ordering_table_columns.md )
- [Check indexes are present for foreign keys ](migration_style_guide.md#adding-foreign-key-constraints )
- Ensure that migrations execute in a transaction or only contain
concurrent index/foreign key helpers (with transactions disabled)
2020-04-22 19:07:51 +05:30
- Check consistency with `db/structure.sql` and that migrations are [reversible ](migration_style_guide.md#reversibility )
2019-10-12 21:52:04 +05:30
- Check queries timing (If any): Queries executed in a migration
2019-12-04 20:38:33 +05:30
need to fit comfortably within `15s` - preferably much less than that - on GitLab.com.
2020-01-01 13:55:28 +05:30
- For column removals, make sure the column has been [ignored in a previous release ](what_requires_downtime.md#dropping-columns )
2019-10-12 21:52:04 +05:30
- Check [background migrations ](background_migrations.md ):
2020-01-01 13:55:28 +05:30
- Establish a time estimate for execution on GitLab.com. For historical purposes,
it's highly recommended to include this estimation on the merge request description.
- If a single `update` is below than `1s` the query can be placed
2019-10-12 21:52:04 +05:30
directly in a regular migration (inside `db/migrate` ).
2020-01-01 13:55:28 +05:30
- Background migrations are normally used, but not limited to:
- Migrating data in larger tables.
- Making numerous SQL queries per record in a dataset.
2019-10-12 21:52:04 +05:30
- Review queries (for example, make sure batch sizes are fine)
- Because execution time can be longer than for a regular migration,
it's suggested to treat background migrations as post migrations:
place them in `db/post_migrate` instead of `db/migrate` . Keep in mind
that post migrations are executed post-deployment in production.
- Check [timing guidelines for migrations ](#timing-guidelines-for-migrations )
2019-12-21 20:55:43 +05:30
- Check migrations are reversible and implement a `#down` method
- Check data migrations:
- Establish a time estimate for execution on GitLab.com.
2020-04-08 14:13:33 +05:30
- Depending on timing, data migrations can be placed on regular, post-deploy, or background migrations.
2019-12-21 20:55:43 +05:30
- Data migrations should be reversible too or come with a description of how to reverse, when possible.
This applies to all types of migrations (regular, post-deploy, background).
2019-10-12 21:52:04 +05:30
- Query performance
- Check for any obviously complex queries and queries the author specifically
points out for review (if any)
- If not present yet, ask the author to provide SQL queries and query plans
2020-04-08 14:13:33 +05:30
(for example, by using [chatops ](understanding_explain_plans.md#chatops ) or direct
2019-10-12 21:52:04 +05:30
database access)
- For given queries, review parameters regarding data distribution
- [Check query plans ](understanding_explain_plans.md ) and suggest improvements
to queries (changing the query, schema or adding indexes and similar)
- General guideline is for queries to come in below 100ms execution time
- If queries rely on prior migrations that are not present yet on production
(eg indexes, columns), you can use a [one-off instance from the restore
pipeline](https://ops.gitlab.net/gitlab-com/gl-infra/gitlab-restore/postgres-gprd)
2020-04-08 14:13:33 +05:30
in order to establish a proper testing environment. If you don't have access to this project, reach out to #database on Slack to get advice on how to proceed.
2020-03-13 15:44:24 +05:30
- Avoid N+1 problems and minimalize the [query count ](merge_request_performance_guidelines.md#query-counts ).
2019-10-12 21:52:04 +05:30
2019-12-21 20:55:43 +05:30
### Timing guidelines for migrations
2019-10-12 21:52:04 +05:30
In general, migrations for a single deploy shouldn't take longer than
1 hour for GitLab.com. The following guidelines are not hard rules, they were
estimated to keep migration timing to a minimum.
NOTE: **Note:** Keep in mind that all runtimes should be measured against GitLab.com.
|
|----|----|---|
2020-04-08 14:13:33 +05:30
| Regular migrations on `db/migrate` | `3 minutes` | A valid exception are index creation as this can take a long time. |
2019-10-12 21:52:04 +05:30
| Post migrations on `db/post_migrate` `10 minutes` | |
2020-04-08 14:13:33 +05:30
| `1 second` execution time with cold caches. |
