KurrentDB¶

Not available until the next release main

Introduction¶

The Testcontainers module for KurrentDB, an event-native database for storing application state changes as immutable events. KurrentDB is the rebrand of EventStoreDB and uses the kurrent:// connection string scheme.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a KurrentDB container

ctx := context.Background()

kurrentdbContainer, err := kurrentdb.Run(ctx, "kurrentplatform/kurrentdb:26.1.1")
defer func() {
    if err := testcontainers.TerminateContainer(kurrentdbContainer); 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¶

Not available until the next release main

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, 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(), "kurrentplatform/kurrentdb:latest").

Container Options¶

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

WithInsecure¶

Not available until the next release main

By default, KurrentDB runs in insecure mode (no TLS), which is suitable for local development and testing. The WithInsecure option makes this explicit:

Run with insecure mode

ctx := context.Background()

// withInsecure {
kurrentdbContainer, err := kurrentdb.Run(ctx,
    "kurrentplatform/kurrentdb:26.1.1",
    kurrentdb.WithInsecure(),
)
// }
defer func() {
    if err := testcontainers.TerminateContainer(kurrentdbContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

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

fmt.Println(connStr != "")

// Output:
// true

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 · Chainable since main
WithHostConfigModifier Since v0.20.0 · Chainable since main
WithEndpointSettingsModifier Since v0.20.0 · Chainable since main
CustomizeRequest Since v0.20.0
WithName Since v0.38.0
WithNoStart Since v0.38.0
WithProvider Since v0.39.0

Experimental Options¶

WithReuseByName Since v0.37.0

Container Methods¶

The KurrentDB container exposes the following methods:

ConnectionString¶

Not available until the next release main

The ConnectionString(ctx) method returns the connection string to connect to the KurrentDB container using the kurrent:// scheme. When the container runs in insecure mode, ?tls=false is appended.

Get connection string

connStr, err := kurrentdbContainer.ConnectionString(ctx)