Skip to content

Pinecone

Since v0.36.0

Introduction

The Testcontainers module for Pinecone.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

pineconeContainer, err := tcpinecone.Run(ctx, "ghcr.io/pinecone-io/pinecone-local:v0.7.0")
defer func() {
    if err := testcontainers.TerminateContainer(pineconeContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

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

fmt.Println(state.Running)

// httpConnection {
host, err := pineconeContainer.HttpEndpoint()
if err != nil {
    log.Printf("failed to get container state: %s", err)
    return
}
// }

pc, err := pinecone.NewClient(pinecone.NewClientParams{
    ApiKey: "testcontainers-go", // API key is required, else use headers
    Host:   host,
})
if err != nil {
    log.Printf("failed to create pinecone client: %s", err)
    return
}

indexName := "my-serverless-index"

idx, err := pc.CreateServerlessIndex(ctx, &pinecone.CreateServerlessIndexRequest{
    Name:      indexName,
    Dimension: 3,
    Metric:    pinecone.Cosine,
    Cloud:     pinecone.Aws,
    Region:    "us-east-1",
    Tags:      &pinecone.IndexTags{"environment": "development"},
})
if err != nil {
    log.Printf("failed to create serverless index: %s", err)
    return
}

fmt.Println(idx.Name)

// Output:
// true
// my-serverless-index

Module Reference

Run function

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

The Pinecone module exposes one entrypoint function to create the Pinecone 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(), "ghcr.io/pinecone-io/pinecone-local:latest").

Container Options

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

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

HttpEndpoint

The HttpEndpoint method returns the location where the Pinecone container is listening. It returns a string with the format http://<host>:<port>.

host, err := pineconeContainer.HttpEndpoint()
if err != nil {
    log.Printf("failed to get container state: %s", err)
    return
}