spanner

README

Spanner Datastore

This datastore implementation allows you to use a Google Cloud Spanner database as the backing durable storage for SpiceDB.

Usage Benefits

The Spanner datastore, like the CockroachDB datastore, can be used in highly scalable and multi-region installations.

Documentation

Index

• Constants
• Variables
• func ContextualizedCaveatFrom(name spanner.NullString, context spanner.NullJSON) (*core.ContextualizedCaveat, error)
• func NewSpannerDatastore(ctx context.Context, database string, opts ...Option) (datastore.Datastore, error)
• type Option
  • func CredentialsFile(path string) Option
  • func CredentialsJSON(json []byte) Option
  • func DisableStats(disable bool) Option
  • func EmulatorHost(uri string) Option
  • func FilterMaximumIDCount(filterMaximumIDCount uint16) Option
  • func FollowerReadDelay(delay time.Duration) Option
  • func MaxRevisionStalenessPercent(stalenessPercent float64) Option
  • func MaxSessionCount(maxSessions uint64) Option
  • func MigrationPhase(phase string) Option
  • func MinSessionCount(minSessions uint64) Option
  • func ReadConnsMaxOpen(conns int) Option
  • func RevisionQuantization(bucketSize time.Duration) Option
  • func WatchBufferLength(watchBufferLength uint16) Option
  • func WatchBufferWriteTimeout(watchBufferWriteTimeout time.Duration) Option
  • func WriteConnsMaxOpen(conns int) Option

Constants

const (
	CombinedChangeStreamName = "combined_change_stream"
)

const (
	Engine = "spanner"
)

Variables

var (
	ParseRevisionString = revisions.RevisionParser(revisions.Timestamp)
)

Functions

func ContextualizedCaveatFrom

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

func NewSpannerDatastore

func NewSpannerDatastore(ctx context.Context, 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 CredentialsJSON

func CredentialsJSON(json []byte) Option

CredentialsJSON is the json 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 FilterMaximumIDCount

func FilterMaximumIDCount(filterMaximumIDCount uint16) Option

FilterMaximumIDCount is the maximum number of IDs that can be used to filter IDs in queries

func FollowerReadDelay

func FollowerReadDelay(delay time.Duration) Option

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

This value defaults to 0 seconds.

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 MaxSessionCount

func MaxSessionCount(maxSessions uint64) Option

MaxSessionCount maximum number of session the Spanner client can have at a given time.

Defaults to 400 sessions.

func MigrationPhase

func MigrationPhase(phase string) Option

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

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

func MinSessionCount

func MinSessionCount(minSessions uint64) Option

MinSessionCount minimum number of session the Spanner client can have at a given time.

Defaults to 100.

func ReadConnsMaxOpen

func ReadConnsMaxOpen(conns int) Option

ReadConnsMaxOpen is the maximum size of the connection pool used for reads.

This value defaults to having 20 connections.

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.

func WatchBufferWriteTimeout

func WatchBufferWriteTimeout(watchBufferWriteTimeout time.Duration) Option

WatchBufferWriteTimeout is the maximum timeout for writing to the watch buffer, after which the caller to the watch will be disconnected.

func WriteConnsMaxOpen

func WriteConnsMaxOpen(conns int) Option

WriteConnsMaxOpen is the maximum size of the connection pool used for writes.

This value defaults to having 10 connections.