vault: Index | Files

package spanner

import ""


Package Files

spanner.go spanner_ha.go


const (
    // LockRenewInterval is the time to wait between lock renewals.
    LockRenewInterval = 5 * time.Second

    // LockRetryInterval is the amount of time to wait if the lock fails before
    // trying again.
    LockRetryInterval = 5 * time.Second

    // LockTTL is the default lock TTL.
    LockTTL = 15 * time.Second

    // LockWatchRetryInterval is the amount of time to wait if a watch fails
    // before trying again.
    LockWatchRetryInterval = 5 * time.Second

    // LockWatchRetryMax is the number of times to retry a failed watch before
    // signaling that leadership is lost.
    LockWatchRetryMax = 5

func NewBackend Uses

func NewBackend(c map[string]string, logger log.Logger) (physical.Backend, error)

NewBackend creates a new Google Spanner storage backend with the given configuration. This uses the official Golang Cloud SDK and therefore supports specifying credentials via envvars, credential files, etc.

type Backend Uses

type Backend struct {
    // contains filtered or unexported fields

Backend implements physical.Backend and describes the steps necessary to persist data using Google Cloud Spanner.

func (*Backend) Delete Uses

func (b *Backend) Delete(ctx context.Context, key string) error

Delete deletes an entry with the given key.

func (*Backend) Get Uses

func (b *Backend) Get(ctx context.Context, key string) (*physical.Entry, error)

Get fetches an entry. If there is no entry, this function returns nil.

func (*Backend) HAEnabled Uses

func (b *Backend) HAEnabled() bool

HAEnabled implements HABackend and indicates that this backend supports high availability.

func (*Backend) List Uses

func (b *Backend) List(ctx context.Context, prefix string) ([]string, error)

List enumerates all keys with the given prefix.

func (*Backend) LockWith Uses

func (b *Backend) LockWith(key, value string) (physical.Lock, error)

LockWith acquires a mutual exclusion based on the given key.

func (*Backend) Put Uses

func (b *Backend) Put(ctx context.Context, entry *physical.Entry) error

Put creates or updates an entry.

func (*Backend) Transaction Uses

func (b *Backend) Transaction(ctx context.Context, txns []*physical.TxnEntry) error

Transaction runs multiple entries via a single transaction.

type Lock Uses

type Lock struct {
    // contains filtered or unexported fields

Lock is the HA lock.

func (*Lock) Lock Uses

func (l *Lock) Lock(stopCh <-chan struct{}) (<-chan struct{}, error)

Lock acquires the given lock. The stopCh is optional. If closed, it interrupts the lock acquisition attempt. The returned channel should be closed when leadership is lost.

func (*Lock) Unlock Uses

func (l *Lock) Unlock() error

Unlock releases the lock.

func (*Lock) Value Uses

func (l *Lock) Value() (bool, string, error)

Value returns the value of the lock and if it is held.

type LockRecord Uses

type LockRecord struct {
    Key       string
    Value     string
    Identity  string
    Timestamp time.Time

LockRecord is the struct that corresponds to a lock.

Package spanner imports 20 packages (graph) and is imported by 6 packages. Updated 2020-09-03. Refresh now. Tools for package owners.