luci-go: github.com/luci/luci-go/common/spantest Index | Files

package spantest

import "github.com/luci/luci-go/common/spantest"

Package spantest implements creation/destruction of a temporary Spanner database.

Index

Package Files

spantest.go

type TempDB Uses

type TempDB struct {
    Name string
    // contains filtered or unexported fields
}

TempDB is a temporary Spanner database.

func NewTempDB Uses

func NewTempDB(ctx context.Context, cfg TempDBConfig) (*TempDB, error)

NewTempDB creates a temporary database with a random name. The caller is responsible for calling Drop on the returned TempDB to cleanup resources after usage.

func (*TempDB) Client Uses

func (db *TempDB) Client(ctx context.Context) (*spanner.Client, error)

Client returns a spanner client connected to the database.

func (*TempDB) Drop Uses

func (db *TempDB) Drop(ctx context.Context) error

Drop deletes the database.

type TempDBConfig Uses

type TempDBConfig struct {
    // InstanceName is the name of Spannner instance where to create the
    // temporary database.
    // Format: projects/{project}/instances/{instance}.
    // Defaults to chromeinfra.TestSpannerInstance.
    InstanceName string

    // TokenSource will be used to authenticate to Spanner.
    // If nil, auth.Authenticator with SilentLogin and chrome-infra auth options
    // will be used.
    // This means that that the user may have to login with luci-auth tool.
    TokenSource oauth2.TokenSource

    // InitScriptPath is a path to a DDL script to initialize the database.
    //
    // In lieu of a proper DDL parser, it is parsed using regexes.
    // Therefore the script MUST:
    //   - Use `#`` and/or `--`` for comments. No block comments.
    //   - Separate DDL statements with `;\n`.
    //
    // If empty, the database is created with no tables.
    InitScriptPath string
}

TempDBConfig specifies how to create a temporary database.

Package spantest imports 16 packages (graph). Updated 2019-10-21. Refresh now. Tools for package owners.