OrientDB¶

Not available until the next release main

Introduction¶

The Testcontainers module for OrientDB, an open-source multi-model NoSQL database that combines graph, document, key/value, and object models in a single engine.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a OrientDB container

// runOrientDB {
ctx := context.Background()

orientdbContainer, err := orientdb.Run(ctx, "orientdb:3.2",
    orientdb.WithRootPassword("rootpwd"),
)
defer func() {
    if err := testcontainers.TerminateContainer(orientdbContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}
// }

state, err := orientdbContainer.State(ctx)
if err != nil {
    log.Printf("failed to get container state: %s", err)
    return
}

fmt.Println(state.Running)

// Output:
// true

Module Reference¶

Run function¶

Not available until the next release main

The OrientDB module exposes one entrypoint function to create the OrientDB 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(), "orientdb:3.2").

Container Options¶

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

WithRootPassword¶

Not available until the next release main

Sets the root password for the OrientDB instance by setting the ORIENTDB_ROOT_PASSWORD environment variable. The default password is rootpwd.

orientdb.WithRootPassword("mysecret")

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

ServerURL¶

Not available until the next release main

The ServerURL method returns the connection string for Java/JDBC clients using the OrientDB binary remote protocol, in the format remote:<host>:<port>.

serverURL, err := orientdbContainer.ServerURL(ctx)
// serverURL = "remote:localhost:2424"

StudioURL¶

Not available until the next release main

The StudioURL method returns the URL for the OrientDB Studio web UI, in the format http://<host>:<port>.

studioURL, err := orientdbContainer.StudioURL(ctx)
// studioURL = "http://localhost:2480"