Typesense¶

Not available until the next release main

Introduction¶

The Testcontainers module for Typesense.

Typesense is a blazing-fast, typo-tolerant, open-source search engine optimised for instant search-as-you-type experiences. It is an easy-to-use alternative to Algolia and a developer-friendly alternative to Elasticsearch.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a Typesense container

ctx := context.Background()

typesenseContainer, err := typesense.Run(
    ctx,
    "typesense/typesense:26.0",
    typesense.WithAPIKey("my-api-key"),
)
defer func() {
    if err := testcontainers.TerminateContainer(typesenseContainer); 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 Typesense module exposes one entrypoint function to create the Typesense 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(), "typesense/typesense:26.0").

Container Options¶

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

WithAPIKey¶

Not available until the next release main

Sets the API key used to authenticate requests to the Typesense container. The API key is required for all Typesense API calls. If not set, the default value test-api-key is used.

typesense.WithAPIKey("my-api-key")

WithDataDir¶

Not available until the next release main

Sets the data directory inside the container where Typesense stores its data. If not set, the default value /tmp is used.

typesense.WithDataDir("/data")

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 Typesense container exposes the following methods:

Address¶

Not available until the next release main

The Address method retrieves the HTTP address of the Typesense container (e.g. http://localhost:8108).

APIKey¶

Not available until the next release main

The APIKey method returns the API key configured for the Typesense container. The API key is required to authenticate all requests to the Typesense API.