README
¶
persist/datastore
Google Cloud Datastore persistence with native TTL support.
Features
- Scales automatically, native TTL support
- JSON encoding with base64 for binary safety
- Streaming loads for warmup
- Works across Cloud Run instances
Usage
import (
"github.com/codeGROOVE-dev/sfcache"
"github.com/codeGROOVE-dev/sfcache/persist/datastore"
)
// cacheID becomes the Datastore database name
p, _ := datastore.New[string, User](ctx, "myapp")
// Optional: clean up stale entries on startup
p.Cleanup(ctx, 24*time.Hour)
cache, _ := sfcache.New[string, User](ctx,
sfcache.WithPersistence(p))
TTL Setup (Recommended)
gcloud firestore fields ttls update expiry \
--collection-group=CacheEntry \
--enable-ttl \
--database=myapp
One-time setup per database. Datastore deletes expired entries within 24 hours.
Fallback Pattern
p, err := datastore.New[string, User](ctx, "myapp")
if err != nil {
p, _ = localfs.New[string, User]("myapp", "")
}
Key Constraints
- Maximum key length: 1500 characters (Datastore limit)
Documentation
¶
Overview ¶
Package datastore provides Google Cloud Datastore persistence for sfcache.
Index ¶
- type Store
- func (s *Store[K, V]) Cleanup(ctx context.Context, maxAge time.Duration) (int, error)
- func (s *Store[K, V]) Close() error
- func (s *Store[K, V]) Delete(ctx context.Context, key K) error
- func (s *Store[K, V]) Flush(ctx context.Context) (int, error)
- func (s *Store[K, V]) Get(ctx context.Context, key K) (value V, expiry time.Time, found bool, err error)
- func (s *Store[K, V]) Len(ctx context.Context) (int, error)
- func (s *Store[K, V]) Location(key K) string
- func (s *Store[K, V]) Set(ctx context.Context, key K, value V, expiry time.Time) error
- func (*Store[K, V]) ValidateKey(key K) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Store ¶ added in v1.3.0
type Store[K comparable, V any] struct { // contains filtered or unexported fields }
Store implements persistence using Google Cloud Datastore.
func New ¶
New creates a new Datastore-based persistence layer. The cacheID is used as the Datastore database name. An empty projectID will be auto-detected from the environment.
func (*Store[K, V]) Cleanup ¶ added in v1.3.0
Cleanup removes expired entries from Datastore. maxAge specifies how old entries must be (based on expiry field) before deletion. If native Datastore TTL is properly configured, this will find no entries.
func (*Store[K, V]) Flush ¶ added in v1.3.0
Flush removes all entries from Datastore. Returns the number of entries removed and any error.
func (*Store[K, V]) Get ¶ added in v1.3.0
func (s *Store[K, V]) Get(ctx context.Context, key K) (value V, expiry time.Time, found bool, err error)
Get retrieves a value from Datastore.
func (*Store[K, V]) Location ¶ added in v1.3.0
Location returns the Datastore key path for a given cache key. Implements the Store interface Location() method. Format: "kind/key" (e.g., "CacheEntry/mykey").
func (*Store[K, V]) ValidateKey ¶ added in v1.3.0
ValidateKey checks if a key is valid for Datastore persistence. Datastore has stricter key length limits than files.
Source Files