Overview

This node operation retrieves details of a specific batched background migration in a GitLab instance by its ID. It is useful for administrators or developers who need to monitor or manage background migration tasks within GitLab, such as checking the status or progress of a migration job.

Use Case Examples

1. An admin wants to check the status of a particular background migration by providing its ID to ensure it completed successfully.
2. A developer queries the migration details to debug or audit the migration process in a GitLab environment.

Properties

Name	Meaning
Skip Authentication	Determines whether to skip authentication for 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, default is GET.
Query Parameters	Optional query parameters for the request, including the database name to query against.
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 migration job.
• table_name - The database table affected by the migration.
• column_name - The specific column in the table involved in the migration.
• interval - The interval at which the migration batches run.
• batch_size - The size of each batch processed in the migration.
• max_batch_size - The maximum allowed batch size for the migration.
• sub_batch_size - The size of sub-batches within the main batch.
• migrated_rows - The number of rows already migrated.
• total_rows - The total number of rows to migrate.
• min_value - The minimum value in the range of rows to migrate.
• max_value - The maximum value in the range of rows to migrate.
• database_name - The name of the database where the migration is running.
• created_at - Timestamp when the migration was created.
• updated_at - Timestamp when the migration was last updated.

Dependencies

• GitLab API key credential

Troubleshooting

• Ensure the 'id' path parameter is provided and is a valid integer; missing or invalid ID will cause request failure.
• Verify that the baseUrl is correctly set to the GitLab instance URL if not using the default https://gitlab.com.
• If authentication is enabled, ensure the GitLab API key credential is correctly configured and has sufficient permissions to access admin batched background migrations.
• Check network connectivity and API endpoint availability if requests time out or fail.

Links

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