MariaDB¶

Not available until the next release of testcontainers-go main

Introduction¶

The Testcontainers module for MariaDB.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a MariaDB container

container, err := RunContainer(ctx)
if err != nil {
    t.Fatal(err)
}

Module reference¶

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

func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomizer) (*MariaDBContainer, error)

context.Context, the Go context.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Container Options¶

When starting the MariaDB 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 MariaDB Docker image on Docker Hub.

Image¶

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

Custom Image

container, err := RunContainer(ctx, testcontainers.WithImage("mariadb:11.0.3"),
    WithConfigFile(filepath.Join("testdata", "my.cnf")))
if err != nil {
    t.Fatal(err)
}

Info

From MariaDB docs:

From tag 10.2.38, 10.3.29, 10.4.19, 10.5.10 onwards, and all 10.6 and later tags, the MARIADB_* equivalent variables are provided. MARIADB_* variants will always be used in preference to MYSQL_* variants.

The MariaDB module will take all the environment variables that start with MARIADB_ and duplicate them with the MYSQL_ prefix.

Wait Strategies¶

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

Info

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.

Docker type modifiers¶

If you need an advanced configuration for MariaDB, 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. By default, the username, the password and the database name is test.

Custom Database initialization

container, err := RunContainer(ctx,
    WithDatabase("foo"),
    WithUsername("root"),
    WithPassword(""))
if err != nil {
    t.Fatal(err)
}

Info

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 MariaDB container, add one or more *.sql, *.sql.gz, or *.sh scripts to the container request. Those files will be copied under /docker-entrypoint-initdb.d.

Include init scripts

container, err := RunContainer(ctx,
    WithScripts(filepath.Join("testdata", "schema.sql")))
if err != nil {
    t.Fatal(err)
}

Custom configuration¶

If you need to set a custom configuration, you can use WithConfigFile option.

Custom MariaDB config file

container, err := RunContainer(ctx, testcontainers.WithImage("mariadb:11.0.3"),
    WithConfigFile(filepath.Join("testdata", "my.cnf")))
if err != nil {
    t.Fatal(err)
}

Container Methods¶

The MariaDB container exposes the following methods:

ConnectionString¶

This method returns the connection string to connect to the MariaDB container, using the default 3306 port. It's possible to pass extra parameters to the connection string, e.g. tls=false, in a variadic way.

Info

By default, MariaDB transmits data between the server and clients without encrypting it.

Get connection string

// By default, MariaDB transmits data between the server and clients without encrypting it.
connectionString, err := container.ConnectionString(ctx, "tls=false")
if err != nil {
    t.Fatal(err)
}