Skip to content

Dolt

Since v0.31.0

Introduction

The Testcontainers module for Dolt.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

doltContainer, err := dolt.Run(ctx,
    "dolthub/dolt-sql-server:1.32.4",
    dolt.WithConfigFile(filepath.Join("testdata", "dolt_1_32_4.cnf")),
    dolt.WithDatabase("foo"),
    dolt.WithUsername("root"),
    dolt.WithPassword("password"),
    dolt.WithScripts(filepath.Join("testdata", "schema.sql")),
)
defer func() {
    if err := testcontainers.TerminateContainer(doltContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to run dolt 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 Dolt module exposes one entrypoint function to create the Dolt container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DoltContainer, 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(), "dolthub/dolt-sql-server:1.32.4").

Container Options

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

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.

WithScripts

If you would like to perform DDL or DML operations in the Dolt 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.

WithDoltCloneRemoteUrl

If you would like to clone data from a remote into the Dolt container, add an *.sh scripts to the container request, using the WithScripts(scriptPaths ...string). Additionally, use WithDoltCloneRemoteUrl(url string) to specify the remote to clone, and use WithDoltCredsPublicKey(key string) along with WithCredsFile(credsFile string) to authorize the Dolt container to clone from the remote.

#!/bin/bash

# use credentials for remote
if [ -n "$DOLT_CREDS_PUB_KEY" ]; then
  dolt creds use "$DOLT_CREDS_PUB_KEY"
fi

# clone
dolt sql -q "CALL DOLT_CLONE('$DOLT_REMOTE_CLONE_URL', '$DOLT_DATABASE');"

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 Dolt 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)