Skip to content

Databend

Since v0.34.0

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

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

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

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

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

The Databend container exposes the following methods:

ConnectionString

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.

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

MustGetConnectionString

MustConnectionString panics if the address cannot be determined.