shopify/bigtable-emulator repository overview

⁠Bigtable emulator Docker image

This repository contains the Google Cloud Bigtable emulator, which is an in memory Go impliementation of Bigtable allowing to create integration tests and local development. Warning: this is not a production tool.

The emulator is offered in the Google Cloud SDK⁠. However, this might be difficult or overkill to install the SDK locally on every development and CI box. In that case, this image provides a lightweight alternative (< 17MB). It also provides an easy way to setup necessary tables and column families at startup.

⁠Using it

To start it, run the following command:

docker run -d -p 9035:9035 shopify/bigtable-emulator

You can specify the tables and column families you need using the -cf switch. The format is a comma separated list of <instance>.<table>.<column family>. Ex:

docker run -d -p 9035:9035 shopify/bigtable-emulator -cf dev.records.data,dev.records.metadata

⁠Connecting to it

You have to set the BIGTABLE_EMULATOR_HOST environment variable to the right docker host and container port. For example: localhost:9035. And then:

import (
  "cloud.google.com/go/bigtable"
  "golang.org/x/net/context"
  "golang.org/x/oauth2"
  "google.golang.org/api/option"
)

type devTokenSource struct{}

func (devTokenSource) Token() (*oauth2.Token, error) {
  return new(oauth2.Token), nil
}

func NewDevBigTableClient() (*bigtable.Client, error) {
  ctx := context.Background()
  project := "dev"
  instance := "dev"
  return bigtable.NewClient(
    ctx, 
    project, 
    instance,
    option.WithTokenSource(&devTokenSource{}),
  )
}

⁠License

This software is available under the MIT license (see 'LICENSE' file for more details).