datastore

package

Go to main page

Versions in this module

v0

v0.8.1

Jan 18, 2026

Changes in this version

+ type ClientOption func(*clientOptionsInternal)

+ func TestOptions(metadataURL, apiURL string) []ClientOption

+ func WithAuth(cfg *auth.Config) ClientOption

+ func WithEndpoint(url string) ClientOption

+ func WithLogger(logger *slog.Logger) ClientOption

v0.8.0

Dec 5, 2025

Changes in this version

type Key

+ Namespace string

v0.7.2

Dec 5, 2025

v0.7.1

Nov 20, 2025

v0.7.0

Nov 20, 2025

Changes in this version

+ var Done = errors.New("datastore: no more items in iterator")

+ var ErrConcurrentTransaction = errors.New("datastore: concurrent transaction")

+ var ErrInvalidEntityType = errors.New("datastore: invalid entity type")

+ var ErrInvalidKey = errors.New("datastore: invalid key")

+ type MultiError []error

+ func (m MultiError) Error() string

v0.6.0

Oct 29, 2025

Changes in this version

+ func TestConfig(ctx context.Context, metadataURL, apiURL string) context.Context

+ func WithConfig(ctx context.Context, cfg *Config) context.Context

+ type Config struct

+ APIURL string

+ AuthConfig *auth.Config

v0.5.0

Oct 29, 2025

Changes in this version

+ var ErrDone = errors.New("datastore: no more results")

+ var ErrNoSuchEntity = errors.New("datastore: no such entity")

+ func SetTestURLs(metadata, api string) (restore func())

+ type Client struct

+ func NewClient(ctx context.Context, projectID string) (*Client, error)

+ func NewClientWithDatabase(ctx context.Context, projID, dbID string) (*Client, error)

+ func NewMockClient(t *testing.T) (client *Client, cleanup func())

+ func (*Client) Close() error

+ func (c *Client) AllKeys(ctx context.Context, q *Query) ([]*Key, error)

+ func (c *Client) AllocateIDs(ctx context.Context, keys []*Key) ([]*Key, error)

+ func (c *Client) Count(ctx context.Context, q *Query) (int, error)

+ func (c *Client) Delete(ctx context.Context, key *Key) error

+ func (c *Client) DeleteAllByKind(ctx context.Context, kind string) error

+ func (c *Client) DeleteMulti(ctx context.Context, keys []*Key) error

+ func (c *Client) Get(ctx context.Context, key *Key, dst any) error

+ func (c *Client) GetAll(ctx context.Context, query *Query, dst any) ([]*Key, error)

+ func (c *Client) GetMulti(ctx context.Context, keys []*Key, dst any) error

+ func (c *Client) Mutate(ctx context.Context, muts ...*Mutation) ([]*Key, error)

+ func (c *Client) NewTransaction(ctx context.Context, opts ...TransactionOption) (*Transaction, error)

+ func (c *Client) Put(ctx context.Context, key *Key, src any) (*Key, error)

+ func (c *Client) PutMulti(ctx context.Context, keys []*Key, src any) ([]*Key, error)

+ func (c *Client) Run(ctx context.Context, q *Query) *Iterator

+ func (c *Client) RunInTransaction(ctx context.Context, f func(*Transaction) error, opts ...TransactionOption) (*Commit, error)

+ type Commit struct

+ type Cursor string

+ func DecodeCursor(s string) (Cursor, error)

+ func (c Cursor) String() string

+ type Iterator struct

+ func (it *Iterator) Cursor() (Cursor, error)

+ func (it *Iterator) Next(dst any) (*Key, error)

+ type Key struct

+ ID int64

+ Kind string

+ Name string

+ Parent *Key

+ func DecodeKey(encoded string) (*Key, error)

+ func IDKey(kind string, id int64, parent *Key) *Key

+ func IncompleteKey(kind string, parent *Key) *Key

+ func NameKey(kind, name string, parent *Key) *Key

+ func (k *Key) Encode() string

+ func (k *Key) Equal(other *Key) bool

+ func (k *Key) Incomplete() bool

+ func (k *Key) String() string

+ type Mutation struct

+ func NewDelete(k *Key) *Mutation

+ func NewInsert(k *Key, src any) *Mutation

+ func NewUpdate(k *Key, src any) *Mutation

+ func NewUpsert(k *Key, src any) *Mutation

+ type MutationOp string

+ const MutationDelete

+ const MutationInsert

+ const MutationUpdate

+ const MutationUpsert

+ type PendingKey struct

+ type Query struct

+ func NewQuery(kind string) *Query

+ func (q *Query) Ancestor(ancestor *Key) *Query

+ func (q *Query) Distinct() *Query

+ func (q *Query) DistinctOn(fieldNames ...string) *Query

+ func (q *Query) End(c Cursor) *Query

+ func (q *Query) Filter(filterStr string, value any) *Query

+ func (q *Query) FilterField(fieldName, operator string, value any) *Query

+ func (q *Query) KeysOnly() *Query

+ func (q *Query) Limit(limit int) *Query

+ func (q *Query) Namespace(ns string) *Query

+ func (q *Query) Offset(offset int) *Query

+ func (q *Query) Order(fieldName string) *Query

+ func (q *Query) Project(fieldNames ...string) *Query

+ func (q *Query) Start(c Cursor) *Query

+ type Transaction struct

+ func (tx *Transaction) Commit() (*Commit, error)

+ func (tx *Transaction) Delete(key *Key) error

+ func (tx *Transaction) DeleteMulti(keys []*Key) error

+ func (tx *Transaction) Get(key *Key, dst any) error

+ func (tx *Transaction) GetMulti(keys []*Key, dst any) error

+ func (tx *Transaction) Mutate(muts ...*Mutation) ([]*PendingKey, error)

+ func (tx *Transaction) Put(key *Key, src any) (*Key, error)

+ func (tx *Transaction) PutMulti(keys []*Key, src any) ([]*Key, error)

+ func (tx *Transaction) Rollback() error

+ type TransactionOption interface

+ func MaxAttempts(n int) TransactionOption

+ func WithReadTime(t time.Time) TransactionOption

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