schemacaching

package

v1.56.0 Latest Latest Go to latest Published: Jul 24, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/authzed/spicedb

Links

Documentation ¶

Index ¶

func DatastoreProxyTestCache(t testing.TB) cache.Cache[cache.StringKey, CacheEntry]
func NewCachingDatastoreProxy(delegate datastore.Datastore, c cache.Cache[cache.StringKey, CacheEntry], ...) datastore.Datastore
func NewDefinitionCachingProxy(delegate datastore.Datastore, c cache.Cache[cache.StringKey, *cacheEntry]) *definitionCachingProxy
func NewWatchingCacheProxy(delegate datastore.Datastore, fallbackCache *definitionCachingProxy, ...) *watchingCachingProxy
type CacheEntry
type CachingMode

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DatastoreProxyTestCache ¶

func DatastoreProxyTestCache(t testing.TB) cache.Cache[cache.StringKey, CacheEntry]

DatastoreProxyTestCache returns a cache used for testing.

func NewCachingDatastoreProxy ¶

func NewCachingDatastoreProxy(delegate datastore.Datastore, c cache.Cache[cache.StringKey, CacheEntry], gcWindow time.Duration, cachingMode CachingMode, watchHeartbeat time.Duration) datastore.Datastore

NewCachingDatastoreProxy creates a new datastore proxy which caches definitions that are loaded at specific datastore revisions. The caller MUST call Close on the returned proxy when it is no longer needed.

func NewDefinitionCachingProxy ¶ added in v1.54.0

func NewDefinitionCachingProxy(delegate datastore.Datastore, c cache.Cache[cache.StringKey, *cacheEntry]) *definitionCachingProxy

The caller MUST call Close on the returned proxy when it is no longer needed. If a nil cache is passed, one is created, so Close is needed to stop its cleanup goroutine.

func NewWatchingCacheProxy ¶ added in v1.54.0

func NewWatchingCacheProxy(delegate datastore.Datastore, fallbackCache *definitionCachingProxy, gcWindow time.Duration, watchHeartbeat time.Duration) *watchingCachingProxy

NewWatchingCacheProxy creates and returns a watching cache proxy.

Types ¶

type CacheEntry ¶ added in v1.35.1

type CacheEntry = *cacheEntry

type CachingMode ¶

type CachingMode int

CachingMode is the caching mode to use for schema.

const (
	// WatchIfSupported will use a schema watch-based cache, if caching is supported. Otherwise,
	// it will fallback to just-in-time caching.
	WatchIfSupported CachingMode = iota

	// JustInTimeCaching will always use a just-in-time cache for schema.
	JustInTimeCaching
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL