Skip to content

Docs: Add "refresh collation" step for all reindex variants

Niklas Janz requested to merge njanz-refresh-collation into master

What does this MR do?

It adds the ALTER COLLATION <collation_name> REFRESH VERSION; for all "rebuild indexes" guides.

I've tried running "Rebuild all indexes, with Geo secondary sites" for a Geo site which displayed the following:

gitlabhq_production=# select                                                                                                                   collname as collation_name,                                                                                                                  collversion as version,                                                                                                                      pg_collation_actual_version(oid) AS actual_version                                                                                         from pg_collation                                                                                                                            where collprovider = 'c';
 collation_name | version | actual_version
----------------+---------+----------------
 C              |         |
 POSIX          |         |
 ucs_basic      |         |
 C.UTF-8        |         |
 en_US.utf8     | 2.31    | 2.39
 en_US          | 2.31    | 2.39
(6 rows)

The output remained unchanged after running REINDEX DATABASE gitlabhq_production;

I had to manually run the following to get back to the "known-good" output (where version==actual_version):

ALTER COLLATION "en_US.utf8" REFRESH VERSION;
ALTER COLLATION "en_US" REFRESH VERSION;

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports