Skip to content

MySQL

Since v0.20.0

Introduction

The Testcontainers module for MySQL.

Adding this module to your project dependencies

Please run the following command to add the MySQL module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/mysql

Usage example

ctx := context.Background()

mysqlContainer, err := mysql.Run(ctx,
    "mysql:8.0.36",
    mysql.WithConfigFile(filepath.Join("testdata", "my_8.cnf")),
    mysql.WithDatabase("foo"),
    mysql.WithUsername("root"),
    mysql.WithPassword("password"),
    mysql.WithScripts(filepath.Join("testdata", "schema.sql")),
)
defer func() {
    if err := testcontainers.TerminateContainer(mysqlContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

Module Reference

Run function

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

The MySQL module exposes one entrypoint function to create the container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*MySQLContainer, error)
  • context.Context, the Go context.
  • string, the Docker image to use.
  • testcontainers.ContainerCustomizer, a variadic argument for passing options.

Image

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "mysql:8.0.36").

Container Options

When starting the MySQL container, you can pass options in a variadic way to configure it.

Tip

You can find all the available configuration and environment variables for the MySQL Docker image on Docker Hub.

Set username, password and database name

If you need to set a different database, and its credentials, you can use WithUsername, WithPassword, WithDatabase options.

Info

The default values for the username is root, for password is test and for the default database name is test.

WithInitScripts

If you would like to perform DDL or DML operations in the MySQL container, add one or more *.sql, *.sql.gz, or *.sh scripts to the container request, using the WithScripts(scriptPaths ...string). Those files will be copied under /docker-entrypoint-initdb.d.

CREATE TABLE IF NOT EXISTS profile (
    id MEDIUMINT NOT NULL AUTO_INCREMENT,
    name VARCHAR(30) NOT NULL,
    PRIMARY KEY (id)
);

INSERT INTO profile (name) values ('profile 1');

WithConfigFile

If you need to set a custom configuration, you can use WithConfigFile option to pass the path to a custom configuration file.

The following options are exposed by the testcontainers package.

Basic Options

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

ConnectionString

This method returns the connection string to connect to the MySQL container, using the default 3306 port. It's possible to pass extra parameters to the connection string, e.g. tls=skip-verify or application_name=myapp, in a variadic way.

connectionString, err := ctr.ConnectionString(ctx, "tls=skip-verify")

MustConnectionString

Same as ConnectionString, but panics if an error occurs while getting the connection string.