Databend¶

Introduction¶

The Testcontainers module for Databend.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a Databend container

package databend_test

import (
    "context"
    "database/sql"
    "fmt"
    "log"

    _ "github.com/datafuselabs/databend-go"

    "github.com/testcontainers/testcontainers-go"
    "github.com/testcontainers/testcontainers-go/modules/databend"
)

func ExampleRun() {
    ctx := context.Background()

    databendContainer, err := databend.Run(ctx,
        "datafuselabs/databend:v1.2.615",
        databend.WithUsername("test1"),
        databend.WithPassword("pass1"),
    )
    defer func() {
        if err := testcontainers.TerminateContainer(databendContainer); err != nil {
            log.Printf("failed to terminate container: %s", err)
        }
    }()
    if err != nil {
        log.Printf("failed to start container: %s", err)
        return
    }

    state, err := databendContainer.State(ctx)
    if err != nil {
        log.Printf("failed to get container state: %s", err)
        return
    }

    fmt.Println(state.Running)

    // Output:
    // true
}

func ExampleRun_connect() {
    ctx := context.Background()

    databendContainer, err := databend.Run(ctx,
        "datafuselabs/databend:v1.2.615",
        databend.WithUsername("root"),
        databend.WithPassword("password"),
    )
    defer func() {
        if err := testcontainers.TerminateContainer(databendContainer); err != nil {
            log.Printf("failed to terminate container: %s", err)
        }
    }()
    if err != nil {
        log.Printf("failed to start container: %s", err)
        return
    }

    connectionString, err := databendContainer.ConnectionString(ctx, "sslmode=disable")
    if err != nil {
        log.Printf("failed to get connection string: %s", err)
        return
    }

    db, err := sql.Open("databend", connectionString)
    if err != nil {
        log.Printf("failed to connect to Databend: %s", err)
        return
    }
    defer db.Close()

    var i int
    row := db.QueryRow("select 1")
    err = row.Scan(&i)
    if err != nil {
        log.Printf("failed to scan result: %s", err)
        return
    }

    fmt.Println(i)

    // Output:
    // 1
}

Module Reference¶

Run function¶

Since v0.34.0

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DatabendContainer, 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(), "datafuselabs/databend:v1.2.615").

Container Options¶

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

Set username, password¶

Since v0.34.0

If you need to set a different user/password/database, you can use WithUsername, WithPassword options.

Info

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

The following options are exposed by the testcontainers package.

Basic Options¶

WithExposedPorts Since v0.37.0
WithEnv Since v0.29.0
WithWaitStrategy Since v0.20.0
WithAdditionalWaitStrategy Since v0.38.0
WithWaitStrategyAndDeadline Since v0.20.0
WithAdditionalWaitStrategyAndDeadline Since v0.38.0
WithEntrypoint Since v0.37.0
WithEntrypointArgs Since v0.37.0
WithCmd Since v0.37.0
WithCmdArgs Since v0.37.0
WithLabels Since v0.37.0

Lifecycle Options¶

WithLifecycleHooks Since v0.38.0
WithAdditionalLifecycleHooks Since v0.38.0
WithStartupCommand Since v0.25.0
WithAfterReadyCommand Since v0.28.0

Files & Mounts Options¶

Build Options¶

WithDockerfile Since v0.37.0

Logging Options¶

Image Options¶

Networking Options¶

Advanced Options¶

WithHostPortAccess Since v0.31.0
WithConfigModifier Since v0.20.0
WithHostConfigModifier Since v0.20.0
WithEndpointSettingsModifier Since v0.20.0
CustomizeRequest Since v0.20.0
WithName Since v0.38.0
WithNoStart Since v0.38.0
WithProvider Not available until the next release main

Experimental Options¶

WithReuseByName Since v0.37.0

Container Methods¶

The Databend container exposes the following methods:

ConnectionString¶

Since v0.34.0

This method returns the connection string to connect to the Databend container, using the default 8000 port. It's possible to pass extra parameters to the connection string, e.g. sslmode=disable.

Get connection string

connectionString, err := ctr.ConnectionString(ctx, "sslmode=disable")

MustGetConnectionString¶

Since v0.34.0

MustConnectionString panics if the address cannot be determined.