Skip to content

SurrealDB

Since v0.29.0

Introduction

The Testcontainers module for SurrealDB.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

surrealdbContainer, err := surrealdb.Run(ctx, "surrealdb/surrealdb:v1.1.1")
defer func() {
    if err := testcontainers.TerminateContainer(surrealdbContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Print(err)
    return
}

Module Reference

Run function

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*SurrealDBContainer, 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(), "surrealdb/surrealdb:v1.1.1").

Container Options

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

Set username and password

If you need to set different credentials, you can use WithUsername and WithPassword options.

Info

The default values for the username and the password are root.

WithAuthentication

If you need to enable authentication, you can use WithAuthentication option. By default, it is disabled.

WithStrictMode

If you need to enable the strict mode for SurrealDB, you can use WithStrictMode option. By default, it is disabled.

WithAllowAllCaps

If you need to enable the all caps mode for SurrealDB, you can use WithAllowAllCaps option. By default, it is disabled.

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

URL

This method returns the websocket URL string to connect to the SurrealDB API, using the 8000 port.

url, err := ctr.URL(ctx)