Menu
Introduction
Getting Started
ID Card
Update Biota Database
Release notes
Technical documentations
Version
Publication date

Mar 9, 2022

Confidentiality
Public
Reactions
0
Share

Biota DB Downloader

TASK
15 times
73.33 %
9 minutes, 24 seconds
Typing name :  TASK.gws_biota.BiotaDbDownloader Brick :  gws_biota

Start the Biota MariaDB database using Docker Compose

Biota DB Downloader

A task that starts the Biota MariaDB database using Docker Compose.

Overview

This task deploys and starts a MariaDB container with the Biota database using Docker Compose. It loads the docker-compose.yml configuration from the brick's db folder, validates parameters, and initiates the Docker Compose deployment through the Docker service.

Input/Output

  • Inputs: None
  • Output: JSONDict resource containing the Docker Compose operation response

Configuration Parameters

Parameter Type Required Description
db_url StrParam Yes URL to download the Biota database from

Behavior

  1. Load Configuration: Reads the docker-compose.yml from the brick's db folder
  2. Environment Handling: Environment variables are managed externally
  3. Deployment: Starts the Docker Compose using the YAML configuration
  4. Wait for Ready: Waits for the database container to reach UP status
  5. Response: Returns a structured JSON response with deployment status

Output Format

The output JSONDict contains:

  • status: Current status of the Docker Compose (e.g., "UP")
  • info: Additional information about the compose status
  • brick_name: The brick name used for deployment
  • unique_name: The unique name assigned to this compose instance

Exceptions

  • Docker service exceptions: May be raised during compose deployment
  • Exception: Raised if the Docker Compose does not reach UP status within the timeout period

Notes

  • The docker-compose.yml file must exist at the relative path docker-compose.yml
  • Environment variables (BIOTA_DB_PASSWORD, BIOTA_DB_USER, etc.) are handled externally
  • The task waits up to 20 attempts for the database to be ready

Output

Docker Compose Response
Response from Docker Compose start operation

Configuration

db_url

Optional

URL to download the Biota database from

Type : string
Shine Logo
Technical bricks to reuse or customize

Have you developed a brick?

Share it to accelerate projects for the entire community.