Add additional instruction in finalise section

What does this MR do?

From this Zendesk ticket(Internal Only), I've learned that we do not explicitly mention the need to escape the , in the arguments obtained from either the logs or the database. If you run a command using arguments from the database or logs without escaping the ,, it will result in this error.

 sudo gitlab-rake gitlab:background_migrations:finalize[CopyColumnUsingBackgroundMigrationJob,merge_request_metrics,id,'[["id"],["id_convert_to_bigint"]]'] --trace
** Invoke gitlab:background_migrations:finalize (first_time)
** Invoke environment (first_time)
** Execute environment
** Execute gitlab:background_migrations:finalize
rake aborted!
JSON::ParserError: unexpected character (after [1]) at line 1, column 7 [parse.c:733] in '[["id"]
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/json.rb:107:in `rescue in adapter_load'
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/json.rb:102:in `adapter_load'
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/json.rb:28:in `parse'
/opt/gitlab/embedded/service/gitlab-rails/lib/tasks/gitlab/background_migrations.rake:76:in `finalize_migration'
/opt/gitlab/embedded/service/gitlab-rails/lib/tasks/gitlab/background_migrations.rake:18:in `block (3 levels) in <top (required)>'
/opt/gitlab/embedded/bin/bundle:23:in `load'
/opt/gitlab/embedded/bin/bundle:23:in `<main>'

Caused by:
EncodingError: unexpected character (after [1]) at line 1, column 7 [parse.c:733] in '[["id"]
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/json.rb:105:in `load'
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/json.rb:105:in `adapter_load'
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/json.rb:28:in `parse'
/opt/gitlab/embedded/service/gitlab-rails/lib/tasks/gitlab/background_migrations.rake:76:in `finalize_migration'
/opt/gitlab/embedded/service/gitlab-rails/lib/tasks/gitlab/background_migrations.rake:18:in `block (3 levels) in <top (required)>'
/opt/gitlab/embedded/bin/bundle:23:in `load'
/opt/gitlab/embedded/bin/bundle:23:in `<main>'
Tasks: TOP => gitlab:background_migrations:finalize

So by adding a backslash (\) before the command resolves this

Example.

For database results, here

job_class_name                                 |         table_name          | column_name |                     job_arguments                      | status 

-----------------------------------------------+-----------------------------+-------------+--------------------------------------------------------+--------
 CopyColumnUsingBackgroundMigrationJob         | merge_request_metrics       | id          | [["id"], ["id_convert_to_bigint"]]                     |      1

The command should be sudo gitlab-rake gitlab:background_migrations:finalize[CopyColumnUsingBackgroundMigrationJob,merge_request_metrics,id,'[["id"]\,["id_convert_to_bigint"]]'] --trace

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.
Edited by David Wainaina

Merge request reports

Loading