Overview

This node interacts with the GitLab API to retrieve information about batched background migrations in the GitLab admin area. It is useful for administrators who want to monitor or manage background migration tasks that are processed in batches within their GitLab instance. For example, an admin can use this node to fetch the status or details of these migrations to ensure they are running smoothly or to troubleshoot issues.

Use Case Examples

1. An admin wants to get a list of all batched background migrations running on the main database of their GitLab instance.
2. A DevOps engineer uses this node to monitor background migrations on different databases like 'ci' or 'geo' to maintain system health.

Properties

Name	Meaning
Skip Authentication	Determines whether to skip authentication when making the API request.
Authentication	Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl	The base URL of the GitLab instance to which the API request is sent.
Method	The HTTP method used for the API request, defaulting to GET.
Query Parameters	Additional query parameters for the API request, including the 'database' parameter to specify which database's migrations to retrieve.

Output

JSON

• id - The unique identifier of the batched background migration.
• job_class_name - The class name of the background migration job.
• table_name - The name of the database table affected by the migration.
• column_name - The name of the column affected by the migration.
• interval - The interval at which the migration runs.
• batch_size - The size of each batch processed in the migration.
• sub_batch_size - The size of each sub-batch within a batch.
• max_batch_size - The maximum size allowed for a batch.
• min_value - The minimum value for the migration range.
• max_value - The maximum value for the migration range.
• status - The current status of the migration.
• migrated - The number of items already migrated.
• total - The total number of items to migrate.
• migrated_rows - The number of rows migrated.
• paused - Indicates if the migration is paused.
• completion_time - The time when the migration completed.
• created_at - The creation timestamp of the migration.
• updated_at - The last update timestamp of the migration.

Dependencies

• GitLab API key credential

Troubleshooting

• Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access admin batched background migrations.
• If the node returns authentication errors, verify that 'Skip Authentication' is not enabled unless intentionally bypassing authentication.
• Check the 'baseUrl' to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
• If the API request fails, verify the 'database' query parameter is set to a valid value among 'main', 'ci', 'sec', 'embedding', or 'geo'.

Links

• GitLab Admin Batched Background Migrations API - Official GitLab documentation for the Admin Batched Background Migrations API endpoint.