diff options
Diffstat (limited to 'doc/api/database_migrations.md')
| -rw-r--r-- | doc/api/database_migrations.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/api/database_migrations.md b/doc/api/database_migrations.md new file mode 100644 index 00000000000..d7aea7ad57e --- /dev/null +++ b/doc/api/database_migrations.md @@ -0,0 +1,33 @@ +--- +stage: Data Stores +group: Database +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Database migrations API **(FREE SELF)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/123408) in GitLab 16.2. + +This API is for managing database migrations used in the development of GitLab. + +All methods require administrator authorization. + +## Mark a migration as successful + +Mark pending migrations as successfully executed to prevent them from being +executed by the `db:migrate` tasks. Use this API to skip failing +migrations after they are determined to be safe to skip. + +```plaintext +POST /api/v4/admin/migrations/:version/mark +``` + +| Attribute | Type | Required | Description | +|-----------------|----------------|----------|----------------------------------------------------------------------------------| +| `version` | integer | yes | Version timestamp of the migration to be skipped | +| `database` | string | no | The database name for which the migration is skipped. Defaults to `main`. | + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" \ + --url "https://gitlab.example.com/api/v4/admin/migrations/:version/mark" +``` |