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¶
- Since v0.32.0
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¶
- Since v0.29.0
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¶
- Since v0.29.0
If you need to enable authentication, you can use WithAuthentication
option. By default, it is disabled.
WithStrictMode¶
- Since v0.29.0
If you need to enable the strict mode for SurrealDB, you can use WithStrictMode
option. By default, it is disabled.
WithAllowAllCaps¶
- Since v0.29.0
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¶
WithExposedPorts
Since v0.37.0WithEnv
Since v0.29.0WithWaitStrategy
Since v0.20.0WithAdditionalWaitStrategy
Since v0.38.0WithWaitStrategyAndDeadline
Since v0.20.0WithAdditionalWaitStrategyAndDeadline
Since v0.38.0WithEntrypoint
Since v0.37.0WithEntrypointArgs
Since v0.37.0WithCmd
Since v0.37.0WithCmdArgs
Since v0.37.0WithLabels
Since v0.37.0
Lifecycle Options¶
WithLifecycleHooks
Since v0.38.0WithAdditionalLifecycleHooks
Since v0.38.0WithStartupCommand
Since v0.25.0WithAfterReadyCommand
Since v0.28.0
Files & Mounts Options¶
WithFiles
Since v0.37.0WithMounts
Since v0.37.0WithTmpfs
Since v0.37.0WithImageMount
Since v0.37.0
Build Options¶
WithDockerfile
Since v0.37.0
Logging Options¶
WithLogConsumers
Since v0.28.0WithLogConsumerConfig
Since v0.38.0WithLogger
Since v0.29.0
Image Options¶
WithAlwaysPull
Since v0.38.0WithImageSubstitutors
Since v0.26.0WithImagePlatform
Since v0.38.0
Networking Options¶
WithNetwork
Since v0.27.0WithNetworkByName
Since v0.38.0WithBridgeNetwork
Since v0.38.0WithNewNetwork
Since v0.27.0
Advanced Options¶
WithHostPortAccess
Since v0.31.0WithConfigModifier
Since v0.20.0WithHostConfigModifier
Since v0.20.0WithEndpointSettingsModifier
Since v0.20.0CustomizeRequest
Since v0.20.0WithName
Since v0.38.0WithNoStart
Since v0.38.0WithProvider
Not available until the next release main
Experimental Options¶
WithReuseByName
Since v0.37.0
Container Methods¶
The SurrealDB container exposes the following methods:
URL¶
- Since v0.29.0
This method returns the websocket URL string to connect to the SurrealDB API, using the 8000
port.
url, err := ctr.URL(ctx)