spanner

Documentation

Index

• Constants
• func ContextualizedCaveatFrom(name spanner.NullString, context spanner.NullJSON) (*core.ContextualizedCaveat, error)
• func NewSpannerDatastore(database string, opts ...Option) (datastore.Datastore, error)
• type Option
  • func CredentialsFile(path string) Option
  • func DisableStats(disable bool) Option
  • func EmulatorHost(uri string) Option
  • func FollowerReadDelay(delay time.Duration) Option
  • func GCEnabled(isGCEnabled bool) Option
  • func GCInterval(interval time.Duration) Option
  • func GCWindow(window time.Duration) Option
  • func MaxRevisionStalenessPercent(stalenessPercent float64) Option
  • func MigrationPhase(phase string) Option
  • func RevisionQuantization(bucketSize time.Duration) Option
  • func WatchBufferLength(watchBufferLength uint16) Option

Constants

const (
	Engine = "spanner"
)

const (
	RelationTupleChangeStreamName = "relation_tuple_stream"
)

Functions

func ContextualizedCaveatFrom

func ContextualizedCaveatFrom(name spanner.NullString, context spanner.NullJSON) (*core.ContextualizedCaveat, error)

func NewSpannerDatastore

func NewSpannerDatastore(database string, opts ...Option) (datastore.Datastore, error)

NewSpannerDatastore returns a datastore backed by cloud spanner

Types

type Option

type Option func(*spannerOptions)

Option provides the facility to configure how clients within the Spanner datastore interact with the running Spanner database.

func CredentialsFile

func CredentialsFile(path string) Option

CredentialsFile is the path to a file containing credentials for a service account that can access the cloud spanner instance

func DisableStats

func DisableStats(disable bool) Option

DisableStats disables recording counts to the stats table

func EmulatorHost

func EmulatorHost(uri string) Option

EmulatorHost is the URI of a Spanner emulator to connect to for development and testing use

func FollowerReadDelay

func FollowerReadDelay(delay time.Duration) Option

FollowerReadDelay is the time delay to apply to enable historial reads.

This value defaults to 0 seconds.

func GCEnabled

func GCEnabled(isGCEnabled bool) Option

GCEnabled indicates whether garbage collection is enabled.

GC is enabled by default.

func GCInterval

func GCInterval(interval time.Duration) Option

GCInterval is the the interval at which garbage collection will occur.

This value defaults to 3 minutes.

func GCWindow

func GCWindow(window time.Duration) Option

GCWindow is the maximum age of a passed revision that will be considered valid.

This value defaults to 1 hour.

func MaxRevisionStalenessPercent

func MaxRevisionStalenessPercent(stalenessPercent float64) Option

MaxRevisionStalenessPercent is the amount of time, expressed as a percentage of the revision quantization window, that a previously computed rounded revision can still be advertised after the next rounded revision would otherwise be ready.

This value defaults to 0.1 (10%).

func MigrationPhase

func MigrationPhase(phase string) Option

MigrationPhase configures the postgres driver to the proper state of a multi-phase migration.

Steady-state configuration (e.g. fully migrated) by default

func RevisionQuantization

func RevisionQuantization(bucketSize time.Duration) Option

RevisionQuantization is the time bucket size to which advertised revisions will be rounded.

This value defaults to 5 seconds.

func WatchBufferLength

func WatchBufferLength(watchBufferLength uint16) Option

WatchBufferLength is the number of entries that can be stored in the watch buffer while awaiting read by the client.

This value defaults to 128.