KnowForge/Testcontainers for Go
Quickstart

CouchDB

qianmoQqianmoQ· 更新于 2026-10-14· 阅读 26 分钟· 0 次阅读
登录后可跨设备保存划线和私人笔记登录

CouchDB

Since v0.44.0

Introduction

The Testcontainers module for Apache CouchDB, a document-oriented NoSQL database that uses JSON to store data, JavaScript as its query language using MapReduce, and HTTP for an API.

Adding this module to your project dependencies

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

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

Usage example

Creating a CouchDB container

ctx := context.Background()

couchdbContainer, err := couchdb.Run(ctx, "couchdb:3",
    couchdb.WithAdminCredentials("admin", "password"),
)
defer func() {
    if err := testcontainers.TerminateContainer(couchdbContainer); 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

The CouchDB module exposes one entrypoint function to create the CouchDB 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(), "couchdb:3").

Container Options

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

WithAdminCredentials

Sets the admin username and password for the CouchDB container. These credentials are used to authenticate against the CouchDB HTTP API and are reflected in the connection string returned by ConnectionString.

The default credentials are admin / password.

E.g. couchdb.WithAdminCredentials("myuser", "mypassword").

The following options are exposed by the testcontainers package.

Basic Options

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

The CouchDB container exposes the following methods:

ConnectionString

The ConnectionString method returns the connection string to connect to the CouchDB container. It returns a string with the format http://user:password@host:5984.

E.g. http://admin:password@localhost:32768.

It can be used to configure a CouchDB HTTP client:

Using ConnectionString

ctx := context.Background()

couchdbContainer, err := couchdb.Run(ctx, "couchdb:3",
    couchdb.WithAdminCredentials("admin", "password"),
)
defer func() {
    if err := testcontainers.TerminateContainer(couchdbContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

评论

登录后参与评论

正在加载评论…