Skip to content


Since testcontainers-go v0.20.0


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

Usage example

ctx := context.Background()

mysqlContainer, err := mysql.RunContainer(ctx,
    mysql.WithConfigFile(filepath.Join("testdata", "my_8.cnf")),
    mysql.WithScripts(filepath.Join("testdata", "schema.sql")),
if err != nil {

// Clean up the container
defer func() {
    if err := mysqlContainer.Terminate(ctx); err != nil {

Module Reference

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

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*MySQLContainer, error) {
  • context.Context, the Go context.
  • testcontainers.ContainerCustomizer, a variadic argument for passing options.

Container Options

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


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


If you need to set a different MySQL Docker image, you can use testcontainers.WithImage with a valid Docker image for MySQL. E.g. testcontainers.WithImage("mysql:5.6").

By default, the container will use the following Docker image:

const defaultImage = "mysql:8"

Wait Strategies

If you need to set a different wait strategy for the container, you can use testcontainers.WithWaitStrategy with a valid wait strategy.


The default deadline for the wait strategy is 60 seconds.

At the same time, it's possible to set a wait strategy and a custom deadline with testcontainers.WithWaitStrategyAndDeadline.

Startup Commands

  • Not available until the next release of testcontainers-go main

Testcontainers exposes the WithStartupCommand(e ...Executable) option to run arbitrary commands in the container right after it's started.


To better understand how this feature works, please read the Create containers: Lifecycle Hooks documentation.

It also exports an Executable interface, defining one single method: AsCommand(), which returns a slice of strings to represent the command and positional arguments to be executed in the container.

You could use this feature to run a custom script, or to run a command that is not supported by the module right after the container is started.

Docker type modifiers

If you need an advanced configuration for the container, you can leverage the following Docker type modifiers:

  • testcontainers.WithConfigModifier
  • testcontainers.WithHostConfigModifier
  • testcontainers.WithEndpointSettingsModifier

Please read the Create containers: Advanced Settings documentation for more information.

Set username, password and database name

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


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

Init Scripts

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.

    name VARCHAR(30) NOT NULL,
    PRIMARY KEY (id)

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

Custom configuration

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

Container Methods


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 := container.ConnectionString(ctx, "tls=skip-verify")