Timeplus
Timeplus
Since v0.44.0
Introduction
The Testcontainers module for Timeplus.
Timeplus is a simple, powerful, and cost-efficient stream processing platform. It is compatible with the ClickHouse wire protocol, so any ClickHouse client library can connect to a Timeplus instance.
Adding this module to your project dependencies
Please run the following command to add the Timeplus module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/timeplusUsage example
Creating a Timeplus container
ctx := context.Background()
timeplusContainer, err := timeplus.Run(ctx, "timeplus/timeplusd:2.3.37")
defer func() {
if err := testcontainers.TerminateContainer(timeplusContainer); 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 Timeplus module exposes one entrypoint function to create the Timeplus 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(), "timeplus/timeplusd:2.3").
Container Ports
Here you can find the list with the default ports used by the Timeplus container.
Container Ports
httpPort = "8123/tcp"
nativePort = "8463/tcp"Container Options
When starting the Timeplus container, you can pass options in a variadic way to configure it.
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 Timeplus container exposes the following methods:
HTTPEndpoint
- Since v0.44.0
This method returns the HTTP endpoint of the Timeplus container for the ClickHouse-compatible HTTP API (port 8123), in the form http://host:port.
Get HTTP endpoint
ctx := context.Background()
timeplusContainer, err := timeplus.Run(ctx, "timeplus/timeplusd:2.3.37")
defer func() {
if err := testcontainers.TerminateContainer(timeplusContainer); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to start container: %s", err)
return
}
httpEndpoint, err := timeplusContainer.HTTPEndpoint(ctx)
if err != nil {
log.Printf("failed to get HTTP endpoint: %s", err)
return
}
fmt.Println(len(httpEndpoint) > 0)
// Output:
// trueInfo
Because Timeplus is wire-protocol compatible with ClickHouse, you can use any ClickHouse client library to connect to a Timeplus container via the HTTP endpoint returned by HTTPEndpoint.
评论
登录后参与评论
KnowForge