Update batched background migrations docs
What does this MR do and why?
Adds information about the column_name
requirements for batched background migrations.
The column needs to be one the migration can iterate over. This will prevent constraint errors such as the following from occurring:
PG::CheckViolation: ERROR: new row for relation "batched_background_migrations" violates check constraint "check_max_value_in_range"
DETAIL: Failing row contains (106, 2024-07-31 13:58:08.840032+00, 2024-07-31 13:58:08.840032+00, 1, 0, 1000, 100, 120, 1, AlterWebhookDeletedAuditEvent, PrimaryKeyBatchingStrategy, audit_events, target_details, [], null, 100, null, 2024-07-31 13:58:08.838238+00, null, gitlab_main, null, 20240729133817).
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.
Edited by Carla Drago