How to Ensure MySQL Connection Readiness in Docker Compose?

Docker-compose: Determining MySQL Connection Readiness

In Docker Compose, ensuring the availability of a database connection before starting an application container can be a critical step in orchestration. To achieve this, the healthcheck and depends_on options offer a convenient solution.

However, configuring an effective health check for MySQL can pose challenges. Let's explore the approaches mentioned in the query and evaluate their limitations:

• Checking for the existence of the MySQL data directory: While this verifies the presence of the database files, it does not guarantee that MySQL is running and accepting connections.
• Getting the MySQL version: This approach confirms the presence of MySQL but still does not indicate readiness for connections.
• Pinging the admin: This action marks the container as healthy, but it does not ensure that the database is fully operational and accepting client requests.

The solution lies in a different health check command:

test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]

This command directly tests the availability of the MySQL server on the localhost and serves as a reliable indicator of its readiness for connections. By using this health check, you can ensure that your application container only starts once MySQL is fully initialized and accessible through network connections.

In your Docker Compose file, you can incorporate this health check as follows:

services:
    api:
        ...
        depends_on:
          db:
            condition: service_healthy
    db:
        ...
        healthcheck:
            test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
            timeout: 20s
            retries: 10

With this configuration, the api container will wait until the db container's health check succeeds before starting, ensuring that MySQL is ready to accept connections and minimizing the risk of pre-boot migrations or application failures.

The above is the detailed content of How to Ensure MySQL Connection Readiness in Docker Compose?. For more information, please follow other related articles on the PHP Chinese website!