diff options
| author | Andreas Brandl <abrandl@gitlab.com> | 2019-07-25 16:30:45 +0000 |
|---|---|---|
| committer | Andreas Brandl <abrandl@gitlab.com> | 2019-07-25 19:35:50 +0200 |
| commit | 412a0a6722baf54c638416e5f9052215991885a4 (patch) | |
| tree | 5e604c82739e54752b1a7e31578bbaec92800d81 | |
| parent | 9eea3623fa9d59d76f08250947b876abeff89810 (diff) | |
| download | gitlab-ce-ab-dbreview-prep.tar.gz | |
Add points how to prepare for database reviewsab-dbreview-prep
Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/65126.
Came up in the database office hours call on 2019-07-25.
| -rw-r--r-- | doc/development/database_review.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/development/database_review.md b/doc/development/database_review.md index 1413c2f69fb..3d10a0c84e5 100644 --- a/doc/development/database_review.md +++ b/doc/development/database_review.md @@ -68,6 +68,17 @@ 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). +### How to prepare for speedy database reviews + +In order to make reviewing easier and therefore faster, please consider preparing a comment +and details for a database reviewer: + +- Provide queries in SQL form rather than ActiveRecord. +- Format any queries with a SQL query formatter, for example with [sqlformat.darold.net](http://sqlformat.darold.net). +- Consider providing query plans via a link to [explain.depesz.com](https://explain.depesz.com) or another tool instead of textual form. +- 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. +- When providing query plans, make sure to use good parameter values, so that the query executed is a good example and also hits enough data. Usually, the `gitlab-org` namespace (`namespace_id = 9970`) and the `gitlab-org/gitlab-ce` project (`project_id = 13083`) provides enough data to serve as a good example. + ### How to review for database - Check migrations |