Overview

This node interacts with the GitLab API to retrieve details about a specific batched background migration by its ID. It is useful for administrators or developers who need to monitor or manage background migration tasks within a GitLab instance. For example, it can be used to fetch the status or details of a migration job to ensure it is running correctly or to debug issues.

Use Case Examples

1. Retrieve the status of a batched background migration by providing its ID and optionally specifying the database to query.
2. Use the node to automate monitoring of background migrations in a GitLab CI/CD pipeline.

Properties

Name	Meaning
Skip Authentication	Determines whether to skip authentication for the API request.
Authentication	Specifies the authentication method to use, typically an API key credential for GitLab.
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	Optional query parameters for the request, including the database name to query.
Path Parameters	Path parameters required for the request, specifically the ID of the batched background migration to retrieve.

Output

JSON

• id - The unique identifier of the batched background migration.
• status - The current status of the migration (e.g., active, completed).
• job_class_name - The class name of the background migration job.
• table_name - The database table associated with the migration.
• column_name - The column in the table involved in the migration.
• interval - The interval at which the migration runs.
• batch_size - The size of each batch processed in the migration.
• 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.
• migrated - The number of items already migrated.
• total - The total number of items to migrate.
• database - The database name where the migration is running.

Dependencies

• GitLab API authentication token or API key credential

Troubleshooting

• Ensure the 'id' path parameter is provided and is a valid integer; missing or invalid IDs will cause request failures.
• Verify that the baseUrl is correct and accessible; incorrect URLs will result in connection errors.
• If authentication is enabled, ensure the API key or token is valid and has sufficient permissions to access admin batched background migrations.
• Check that the specified database in query parameters is one of the allowed values (main, ci, sec, embedding, geo) to avoid invalid parameter errors.

Links

• GitLab API Documentation - Get Batched Background Migration by ID - Official GitLab API documentation for retrieving a batched background migration by its ID.