MariaDB¶
Since v0.24.0
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¶
ctx := context.Background()
mariadbContainer, err := mariadb.Run(ctx,
"mariadb:11.0.3",
mariadb.WithConfigFile(filepath.Join("testdata", "my.cnf")),
mariadb.WithScripts(filepath.Join("testdata", "schema.sql")),
mariadb.WithDatabase("foo"),
mariadb.WithUsername("root"),
mariadb.WithPassword(""),
)
defer func() {
if err := testcontainers.TerminateContainer(mariadbContainer); 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¶
- Since v0.32.0
Info
The RunContainer(ctx, opts...)
function is deprecated and will be removed in the next major release of Testcontainers for Go.
The MariaDB module exposes one entrypoint function to create the MariaDB container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*MariaDBContainer, 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(), "mariadb:11.0.3")
.
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.
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.
Set username, password and database name¶
- Since v0.24.0
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
.
WithScripts¶
- Since v0.24.0
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, using theWithScripts(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¶
- Since v0.24.0
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¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Not available until the next release mainWithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Not available until the next release mainWithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Not available until the next release mainWithAdditionalLifecycleHooks
Not available until the next release mainWithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Not available until the next release mainWithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Not available until the next release mainWithImageSubstitutors
Since v0.26.0WithImagePlatform
Not available until the next release main
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Not available until the next release mainWithBridgeNetwork
Not available until the next release mainWithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Not available until the next release mainWithNoStart
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
The MariaDB container exposes the following methods:
ConnectionString¶
- Since v0.24.0
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.
// By default, MariaDB transmits data between the server and clients without encrypting it.
connectionString, err := ctr.ConnectionString(ctx, "tls=false")
MustConnectionString¶
- Since v0.30.0
Same as ConnectionString
, but panics if an error occurs while getting the connection string.