Firebird¶

Not available until the next release main

Introduction¶

The Testcontainers module for Firebird, a relational database that runs on Linux, Windows, and Unix platforms. It exposes a firebird:// connection string on port 3050.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a Firebird container

ctx := context.Background()

firebirdContainer, err := firebird.Run(ctx,
    "jacobalberty/firebird:v3.0",
    firebird.WithDatabase("test.fdb"),
    firebird.WithUsername("test"),
    firebird.WithPassword("test"),
)
defer func() {
    if err := testcontainers.TerminateContainer(firebirdContainer); 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 Firebird module exposes one entrypoint function to create the Firebird 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(), "ghcr.io/jacobalberty/firebird:v3.0").

Container Options¶

When starting the Firebird 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 Firebird Docker image on GitHub.

WithDatabase¶

Not available until the next release main

Sets the FIREBIRD_DATABASE environment variable. The default database name is test.fdb.

firebird.WithDatabase("mydb.fdb")

WithUsername¶

Not available until the next release main

Sets the FIREBIRD_USER environment variable. The default username is test.

firebird.WithUsername("myuser")

WithPassword¶

Not available until the next release main

Sets the FIREBIRD_PASSWORD environment variable. The default password is test.

firebird.WithPassword("mypassword")

WithSYSDBAPassword¶

Not available until the next release main

Sets the ISC_PASSWORD environment variable, which is the SYSDBA master password. The default is masterkey.

firebird.WithSYSDBAPassword("mysysdbapassword")

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¶

ConnectionString¶

Not available until the next release main

This method returns the connection string to connect to the Firebird container, using the firebird:// scheme on the default port 3050.

Get connection string

connStr, err := ctr.ConnectionString(ctx)