DynamoDB
DynamoDB
Since v0.34.0
Introduction
The Testcontainers module for DynamoDB.
Adding this module to your project dependencies
Please run the following command to add the DynamoDB module to your Go dependencies:
go get github.com/testcontainers/testcontainers-go/modules/dynamodbUsage example
Creating a DynamoDB container
ctx := context.Background()
ctr, err := tcdynamodb.Run(ctx, "amazon/dynamodb-local:2.2.1")
defer func() {
if err := testcontainers.TerminateContainer(ctr); err != nil {
log.Printf("failed to terminate container: %s", err)
}
}()
if err != nil {
log.Printf("failed to run dynamodb container: %s", err)
return
}Module Reference
Run function
- Since v0.34.0
The DynamoDB module exposes one entrypoint function to create the DynamoDB container, and this function receives three parameters:
func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*DynamoDBContainer, 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(), "amazon/dynamodb-local:2.2.1").
Container Options
When starting the DynamoDB container, you can pass options in a variadic way to configure it.
WithSharedDB
- Since v0.34.0
The WithSharedDB option tells the DynamoDB container to use a single database file. At the same time, it marks the container as reusable, which causes that successive calls to the Run function will return the same container instance, and therefore, the same database file.
WithDisableTelemetry
- Since v0.34.0
You can turn off telemetry when starting the DynamoDB container, using the option WithDisableTelemetry.
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 DynamoDB container exposes the following methods:
ConnectionString
- Since v0.34.0
The ConnectionString method returns the connection string to the DynamoDB container. This connection string can be used to connect to the DynamoDB container from your application, using the AWS SDK or any other DynamoDB client of your choice.
Creating a client
var errs []error
hostPort, err := c.ConnectionString(context.Background())
if err != nil {
errs = append(errs, fmt.Errorf("get connection string: %w", err))
}
cfg, err := config.LoadDefaultConfig(context.Background(), config.WithCredentialsProvider(credentials.StaticCredentialsProvider{
Value: aws.Credentials{
AccessKeyID: "DUMMYIDEXAMPLE",
SecretAccessKey: "DUMMYEXAMPLEKEY",
},
}))
if err != nil {
errs = append(errs, fmt.Errorf("load default config: %w", err))
}
require.NoError(t, errors.Join(errs...))
return dynamodb.NewFromConfig(cfg, dynamodb.WithEndpointResolverV2(&dynamoDBResolver{HostPort: hostPort}))The above example uses github.com/aws/aws-sdk-go-v2/service/dynamodb to create a client and connect to the DynamoDB container.
评论
登录后参与评论
KnowForge