datastore

package
v1.56.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 11, 2026 License: Apache-2.0 Imports: 20 Imported by: 4

Documentation

Index

Constants

View Source 
const (
	MaxReplicaCount          = dsconfig.MaxReplicaCount
	DefaultFollowerReadDelay = dsconfig.DefaultFollowerReadDelay

	MemoryEngine    = dsconfig.MemoryEngine
	PostgresEngine  = dsconfig.PostgresEngine
	CockroachEngine = dsconfig.CockroachEngine
	SpannerEngine   = dsconfig.SpannerEngine
	MySQLEngine     = dsconfig.MySQLEngine
)

Variables

View Source 
var (
	RegisterEngine                           = dsconfig.RegisterEngine
	DefaultDatastoreConfig                   = dsconfig.DefaultDatastoreConfig
	DefaultReadConnPool                      = dsconfig.DefaultReadConnPool
	DefaultWriteConnPool                     = dsconfig.DefaultWriteConnPool
	ConfigWithOptions                        = dsconfig.ConfigWithOptions
	ConnPoolConfigWithOptions                = dsconfig.ConnPoolConfigWithOptions
	NewConfigWithOptions                     = dsconfig.NewConfigWithOptions
	NewConfigWithOptionsAndDefaults          = dsconfig.NewConfigWithOptionsAndDefaults
	NewConnPoolConfigWithOptions             = dsconfig.NewConnPoolConfigWithOptions
	NewConnPoolConfigWithOptionsAndDefaults  = dsconfig.NewConnPoolConfigWithOptionsAndDefaults
	NewRelIntegrityKeyWithOptions            = dsconfig.NewRelIntegrityKeyWithOptions
	NewRelIntegrityKeyWithOptionsAndDefaults = dsconfig.NewRelIntegrityKeyWithOptionsAndDefaults
	RelIntegrityKeyWithOptions               = dsconfig.RelIntegrityKeyWithOptions
	SetAllowedMigrations                     = dsconfig.SetAllowedMigrations
	SetBootstrapFileContents                 = dsconfig.SetBootstrapFileContents
	SetBootstrapFiles                        = dsconfig.SetBootstrapFiles
	SetReadReplicaURIs                       = dsconfig.SetReadReplicaURIs
	SetRelationshipIntegrityExpiredKeys      = dsconfig.SetRelationshipIntegrityExpiredKeys
	SetSpannerCredentialsJSON                = dsconfig.SetSpannerCredentialsJSON
	WithAllowedMigrations                    = dsconfig.WithAllowedMigrations
	WithBootstrapFileContents                = dsconfig.WithBootstrapFileContents
	WithBootstrapFiles                       = dsconfig.WithBootstrapFiles
	WithBootstrapOverwrite                   = dsconfig.WithBootstrapOverwrite
	WithBootstrapSchemaMode                  = dsconfig.WithBootstrapSchemaMode
	WithBootstrapTimeout                     = dsconfig.WithBootstrapTimeout
	WithCaveatTypeSet                        = dsconfig.WithCaveatTypeSet
	WithConnectRate                          = dsconfig.WithConnectRate
	WithCredentialsProviderName              = dsconfig.WithCredentialsProviderName
	WithDisableStats                         = dsconfig.WithDisableStats
	WithDisableWatchSupport                  = dsconfig.WithDisableWatchSupport
	WithEnableConnectionBalancing            = dsconfig.WithEnableConnectionBalancing
	WithEnableDatastoreMetrics               = dsconfig.WithEnableDatastoreMetrics
	WithEnableRevisionHeartbeat              = dsconfig.WithEnableRevisionHeartbeat
	WithEngine                               = dsconfig.WithEngine
	WithExperimentalColumnOptimization       = dsconfig.WithExperimentalColumnOptimization
	WithFilterMaximumIDCount                 = dsconfig.WithFilterMaximumIDCount
	WithFollowerReadDelay                    = dsconfig.WithFollowerReadDelay
	WithGCInterval                           = dsconfig.WithGCInterval
	WithGCMaxOperationTime                   = dsconfig.WithGCMaxOperationTime
	WithGCWindow                             = dsconfig.WithGCWindow
	WithHealthCheckInterval                  = dsconfig.WithHealthCheckInterval
	WithIncludeQueryParametersInTraces       = dsconfig.WithIncludeQueryParametersInTraces
	WithKeyFilename                          = dsconfig.WithKeyFilename
	WithKeyID                                = dsconfig.WithKeyID
	WithLegacyFuzzing                        = dsconfig.WithLegacyFuzzing
	WithMaxIdleTime                          = dsconfig.WithMaxIdleTime
	WithMaxLifetime                          = dsconfig.WithMaxLifetime
	WithMaxLifetimeJitter                    = dsconfig.WithMaxLifetimeJitter
	WithMaxOpenConns                         = dsconfig.WithMaxOpenConns
	WithMaxRetries                           = dsconfig.WithMaxRetries
	WithMaxRevisionStalenessPercent          = dsconfig.WithMaxRevisionStalenessPercent
	WithMigrationPhase                       = dsconfig.WithMigrationPhase
	WithMinOpenConns                         = dsconfig.WithMinOpenConns
	WithOldReadReplicaConnPool               = dsconfig.WithOldReadReplicaConnPool
	WithOverlapKey                           = dsconfig.WithOverlapKey
	WithOverlapStrategy                      = dsconfig.WithOverlapStrategy
	WithPingTimeout                          = dsconfig.WithPingTimeout
	WithReadConnPool                         = dsconfig.WithReadConnPool
	WithReadOnly                             = dsconfig.WithReadOnly
	WithReadReplicaConnPool                  = dsconfig.WithReadReplicaConnPool
	WithReadReplicaCredentialsProviderName   = dsconfig.WithReadReplicaCredentialsProviderName
	WithReadReplicaURIs                      = dsconfig.WithReadReplicaURIs
	WithRelationshipIntegrityCurrentKey      = dsconfig.WithRelationshipIntegrityCurrentKey
	WithRelationshipIntegrityEnabled         = dsconfig.WithRelationshipIntegrityEnabled
	WithRelationshipIntegrityExpiredKeys     = dsconfig.WithRelationshipIntegrityExpiredKeys
	WithRelaxedIsolationLevel                = dsconfig.WithRelaxedIsolationLevel
	WithRequestHedgingEnabled                = dsconfig.WithRequestHedgingEnabled
	WithRequestHedgingInitialSlowValue       = dsconfig.WithRequestHedgingInitialSlowValue
	WithRequestHedgingMaxRequests            = dsconfig.WithRequestHedgingMaxRequests
	WithRequestHedgingQuantile               = dsconfig.WithRequestHedgingQuantile
	WithRevisionQuantization                 = dsconfig.WithRevisionQuantization
	WithSpannerCredentialsFile               = dsconfig.WithSpannerCredentialsFile
	WithSpannerCredentialsJSON               = dsconfig.WithSpannerCredentialsJSON
	WithSpannerDatastoreMetricsOption        = dsconfig.WithSpannerDatastoreMetricsOption
	WithSpannerEmulatorHost                  = dsconfig.WithSpannerEmulatorHost
	WithSpannerMaxSessions                   = dsconfig.WithSpannerMaxSessions
	WithSpannerMinSessions                   = dsconfig.WithSpannerMinSessions
	WithTablePrefix                          = dsconfig.WithTablePrefix
	WithURI                                  = dsconfig.WithURI
	WithWatchBufferLength                    = dsconfig.WithWatchBufferLength
	WithWatchBufferWriteTimeout              = dsconfig.WithWatchBufferWriteTimeout
	WithWatchChangeBufferMaximumSize         = dsconfig.WithWatchChangeBufferMaximumSize
	WithWatchConnectTimeout                  = dsconfig.WithWatchConnectTimeout
	WithWriteAcquisitionTimeout              = dsconfig.WithWriteAcquisitionTimeout
	WithWriteConnPool                        = dsconfig.WithWriteConnPool
)
View Source 
var BuilderForEngine = dsconfig.BuilderForEngine

BuilderForEngine holds the builder for each datastore engine, keyed by engine name. See dsconfig.BuilderForEngine.

Functions

func NewDatastore 

func NewDatastore(ctx context.Context, options ...ConfigOption) (datastore.Datastore, error)

NewDatastore initializes a datastore given the options

func RegisterConnPoolFlagsWithPrefix added in v1.18.0 

func RegisterConnPoolFlagsWithPrefix(flagSet *pflag.FlagSet, prefix string, defaults, opts *ConnPoolConfig)

func RegisterDatastoreFlags 

func RegisterDatastoreFlags(flagset *pflag.FlagSet, opts *Config) error

RegisterDatastoreFlags adds datastore flags to a cobra command.

func RegisterDatastoreFlagsWithPrefix added in v1.16.1 

func RegisterDatastoreFlagsWithPrefix(flagSet *pflag.FlagSet, prefix string, opts *Config) error

RegisterDatastoreFlagsWithPrefix adds datastore flags to a cobra command, with each flag prefixed with the provided prefix argument. If left empty, the datastore flags are not prefixed.

Types

type Config 

type Config = dsconfig.Config

type ConfigOption 

type ConfigOption = dsconfig.ConfigOption

type ConnPoolConfig added in v1.18.0 

type ConnPoolConfig = dsconfig.ConnPoolConfig

type ConnPoolConfigOption added in v1.22.0 

type ConnPoolConfigOption = dsconfig.ConnPoolConfigOption

type EngineBuilderFunc added in v1.56.1 

type EngineBuilderFunc = dsconfig.EngineBuilderFunc

type RelIntegrityKey added in v1.36.0 

type RelIntegrityKey = dsconfig.RelIntegrityKey

type RelIntegrityKeyOption added in v1.36.0 

type RelIntegrityKeyOption = dsconfig.RelIntegrityKeyOption

Source Files

View all Source files

Directories

Path Synopsis
Package dsconfig holds the configuration type for constructing datastores by engine name, along with the registry of engine builders.
 Package dsconfig holds the configuration type for constructing datastores by engine name, along with the registry of engine builders.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.