Skip to content

Weaviate

Since v0.29.0

Introduction

The Testcontainers module for Weaviate.

Adding this module to your project dependencies

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

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

Usage example

ctx := context.Background()

weaviateContainer, err := tcweaviate.Run(ctx, "semitechnologies/weaviate:1.29.0")
defer func() {
    if err := testcontainers.TerminateContainer(weaviateContainer); 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

Info

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

The Weaviate module exposes one entrypoint function to create the Weaviate container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*WeaviateContainer, 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(), "semitechnologies/weaviate:1.23.9").

Container Options

When starting the Weaviate 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 Weaviate container exposes the following methods:

HTTP Host Address

This method returns the Schema and Host for the Weaviate container, using the default 8080 port.

Info

At the moment, the Weaviate module only supports the HTTP schema.

scheme, host, err := weaviateContainer.HttpHostAddress(ctx)
if err != nil {
    log.Printf("failed to get http schema and host: %s", err)
    return
}

gRPC Host Address

This method returns the Schema and Host for the Weaviate container, using the default 443 port.

grpcHost, err := weaviateContainer.GrpcHostAddress(ctx)
if err != nil {
    log.Printf("failed to get gRPC host: %s", err)
    return
}

Examples

Getting a Weaviate client

The following example demonstrates how to create a Weaviate client using the Weaviate module.

First of all, you need to import the Weaviate client:

import (
    "github.com/weaviate/weaviate-go-client/v4/weaviate"
)

Then, you can create a Weaviate client using the Weaviate module:

ctx := context.Background()

weaviateContainer, err := tcweaviate.Run(ctx, "semitechnologies/weaviate:1.28.7")
defer func() {
    if err := testcontainers.TerminateContainer(weaviateContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

scheme, host, err := weaviateContainer.HttpHostAddress(ctx)
if err != nil {
    log.Printf("failed to get http schema and host: %s", err)
    return
}

grpcHost, err := weaviateContainer.GrpcHostAddress(ctx)
if err != nil {
    log.Printf("failed to get gRPC host: %s", err)
    return
}

connectionClient := &http.Client{}
headers := map[string]string{
    // put here the custom API key, e.g. for OpenAPI
    "Authorization": "Bearer custom-api-key",
}

cli := weaviate.New(weaviate.Config{
    Scheme: scheme,
    Host:   host,
    GrpcConfig: &grpc.Config{
        Secured: false, // set true if gRPC connection is secured
        Host:    grpcHost,
    },
    Headers:          headers,
    AuthConfig:       nil, // put here the weaviate auth.Config, if you need it
    ConnectionClient: connectionClient,
})

err = cli.WaitForWeavaite(5 * time.Second)

ctx := context.Background()

enableModules := []string{
    "backup-filesystem",
    "text2vec-openai",
    "text2vec-cohere",
    "text2vec-huggingface",
    "generative-openai",
}
envs := map[string]string{
    "ENABLE_MODULES":         strings.Join(enableModules, ","),
    "BACKUP_FILESYSTEM_PATH": "/tmp/backups",
}

opts := []testcontainers.ContainerCustomizer{
    testcontainers.WithEnv(envs),
}

weaviateContainer, err := tcweaviate.Run(ctx, "semitechnologies/weaviate:1.25.5", opts...)
defer func() {
    if err := testcontainers.TerminateContainer(weaviateContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

// httpHostAddress {
scheme, host, err := weaviateContainer.HttpHostAddress(ctx)
if err != nil {
    log.Printf("failed to get http schema and host: %s", err)
    return
}
// }

// grpcHostAddress {
grpcHost, err := weaviateContainer.GrpcHostAddress(ctx)
if err != nil {
    log.Printf("failed to get gRPC host: %s", err)
    return
}
// }

connectionClient := &http.Client{}
headers := map[string]string{
    // put here the custom API key, e.g. for OpenAPI
    "Authorization": "Bearer custom-api-key",
}

cli := weaviate.New(weaviate.Config{
    Scheme: scheme,
    Host:   host,
    GrpcConfig: &grpc.Config{
        Secured: false, // set true if gRPC connection is secured
        Host:    grpcHost,
    },
    Headers:          headers,
    AuthConfig:       nil, // put here the weaviate auth.Config, if you need it
    ConnectionClient: connectionClient,
})

err = cli.WaitForWeavaite(5 * time.Second)