README
¶
Google Cloud Datastore Go utility clients
⚠️ This package is still in the design phase, with no working code yet. I am still looking for interest, input, and help on this package
Approximately source-compatible implementations of the Google Cloud Datastore API Go package, with alternative and middleware implementations for unit testing, caching, ... Offers many features of the ndb package, and more.
Client implementations:
- Datastore: Passthrough to the
cloud.google.com/datastorepackage, for the actual connection to Google Cloud Datastore. - Memory: in-memory implementation, for use in unit tests
- Cache: Middleware client that caches entities locally (in the current
request context) and/or globally (e.g. in Redis or global
memory), similar to the local and global cache of the
ndbpackage.
This package also provides utility functions for working with the datastore:
- Functions to safely load and save incomplete structs from datastore. This avoids data loss when working with structs that do not perfectly map to the datastore (e.g. when working with legacy data or other clients)
Documentation
Related packages
-
https://pkg.go.dev/github.com/qedus/nds
- Cached datastore API implementation
- Follows the same API as the standard datastore package
- Only adds a cache layer (no abstraction, no memory implementation)
- Inspired by NDB
-
https://github.com/mercari/datastore
- Does much more than just wrapping: different API, different implementation, ...
Documentation
¶
Overview ¶
Package nds provides Google Cloud Datastore utility clients
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrFieldMismatch = errors.New("field mismatch")
var ErrInvalidID = errors.New("invalid id")
var ErrInvalidKey = errors.New("invalid key")
var ErrNotFound = errors.New("not found")
var IncompleteKey = datastore.IncompleteKey
var IteratorDone = iterator.Done
Functions ¶
This section is empty.
Types ¶
type DB ¶
type DB interface {
NewQuery(kind string) Query
Get(ctx context.Context, key *Key, dst interface{}) (err error)
Put(ctx context.Context, key *Key, src interface{}) (*Key, error)
Run(ctx context.Context, q Query) Iterator
}
Driver implementation. This implements the global functions of the `cloud.google.com/go/datastore` package.
type Iterator ¶
type Iterator interface {
Cursor() (c Cursor, err error)
Next(dst interface{}) (k *Key, err error)
}
Abstract interfaces for datastore types
Source Files
Directories