CrateDB
CrateDB
Since v0.44.0
Introduction
The Testcontainers module for CrateDB.
CrateDB is a distributed SQL database that combines the power of Lucene-based full-text search with the convenience of standard SQL. It offers PostgreSQL wire-protocol compatibility, making it easy to connect with existing PostgreSQL drivers and tools, and is optimised for real-time analytics on large datasets.
Adding this module to your project dependencies
Please run the following command to add the CrateDB module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/cratedbUsage example
Creating a CrateDB container
ctx := context.Background()
cratedbContainer, err := cratedb.Run(ctx,
"crate:5.7",
)
defer func() {
if err := testcontainers.TerminateContainer(cratedbContainer); 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
- Since v0.44.0
The CrateDB module exposes one entrypoint function to create the CrateDB 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.
Container Ports
Here you can find the list with the default ports used by the CrateDB container.
Container Ports
httpPort = "4200/tcp"
pgPort = "5432/tcp"Image
Use the second argument in the Run function to set a valid Docker image. For example: Run(context.Background(), "crate:5.7").
Container Options
When starting the CrateDB container, you can pass options in a variadic way to configure it.
WithHeapSize
- Since v0.44.0
Sets the JVM heap size for the CrateDB process via the CRATE_HEAP_SIZE environment variable. The default value is 512m.
cratedb.WithHeapSize("1g")The following options are exposed by the testcontainers package.
Basic Options
WithExposedPortsSince v0.37.0WithEnvSince v0.29.0WithWaitStrategySince v0.20.0WithAdditionalWaitStrategySince v0.38.0WithWaitStrategyAndDeadlineSince v0.20.0WithAdditionalWaitStrategyAndDeadlineSince v0.38.0WithEntrypointSince v0.37.0WithEntrypointArgsSince v0.37.0WithCmdSince v0.37.0WithCmdArgsSince v0.37.0WithLabelsSince v0.37.0
Lifecycle Options
WithLifecycleHooksSince v0.38.0WithAdditionalLifecycleHooksSince v0.38.0WithStartupCommandSince v0.25.0WithAfterReadyCommandSince v0.28.0
Files & Mounts Options
WithFilesSince v0.37.0WithMountsSince v0.37.0WithTmpfsSince v0.37.0WithImageMountSince v0.37.0
Build Options
WithDockerfileSince v0.37.0
Logging Options
WithLogConsumersSince v0.28.0WithLogConsumerConfigSince v0.38.0WithLoggerSince v0.29.0
Image Options
WithAlwaysPullSince v0.38.0WithImageSubstitutorsSince v0.26.0WithImagePlatformSince v0.38.0
Networking Options
WithNetworkSince v0.27.0WithNetworkByNameSince v0.38.0WithBridgeNetworkSince v0.38.0WithNewNetworkSince v0.27.0
Advanced Options
WithHostPortAccessSince v0.31.0WithConfigModifierSince v0.20.0 · Chainable since mainWithHostConfigModifierSince v0.20.0 · Chainable since mainWithEndpointSettingsModifierSince v0.20.0 · Chainable since mainCustomizeRequestSince v0.20.0WithNameSince v0.38.0WithNoStartSince v0.38.0WithProviderSince v0.39.0
Experimental Options
WithReuseByNameSince v0.37.0
Container Methods
The CrateDB container exposes the following methods:
HTTPEndpoint
- Since v0.44.0
Returns the HTTP endpoint (Admin UI and REST API) of the CrateDB container on port 4200/tcp.
endpoint, err := cratedbContainer.HTTPEndpoint(ctx)
// endpoint: "http://localhost:32768"PGConnectionString
- Since v0.44.0
Returns the PostgreSQL wire-protocol connection string for the CrateDB container on port 5432/tcp. CrateDB's built-in superuser is crate with no password, and the default schema is doc. Accepts an optional variadic list of extra query parameters, e.g. "sslmode=disable" or "connect_timeout=10".
connStr, err := cratedbContainer.PGConnectionString(ctx, "sslmode=disable")
// connStr: "postgres://crate@localhost:32769/doc?sslmode=disable"评论
登录后参与评论
KnowForge