datastore

Documentation

Overview

Package datastore contains an implementation of the `gokv.Store` interface for Google Cloud Datastore.

Index

• Variables
• type Client
  • func NewClient(options Options) (Client, error)
  • func (c Client) Close() error
  • func (c Client) Delete(k string) error
  • func (c Client) Get(k string, v any) (found bool, err error)
  • func (c Client) Set(k string, v any) error
• type Options

Variables

var DefaultOptions = Options{
	Timeout: &defaultTimeout,
	Codec:   encoding.JSON,
}

DefaultOptions is an Options object with default values. CredentialsFile: "", Timeout: 2 * time.Second, Codec: encoding.JSON

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a gokv.Store implementation for Cloud Datastore.

func NewClient

func NewClient(options Options) (Client, error)

NewClient creates a new Cloud Datastore client.

You must call the Close() method on the store when you're done working with it.

func (Client) Close

func (c Client) Close() error

Close closes the client.

func (Client) Delete

func (c Client) Delete(k string) error

Delete deletes the stored value for the given key. Deleting a non-existing key-value pair does NOT lead to an error. The key must not be "".

func (Client) Get

func (c Client) Get(k string, v any) (found bool, err error)

Get retrieves the stored value for the given key. You need to pass a pointer to the value, so in case of a struct the automatic unmarshalling can populate the fields of the object that v points to with the values of the retrieved object's values. If no value is found it returns (false, nil). The key must not be "" and the pointer must not be nil.

func (Client) Set

func (c Client) Set(k string, v any) error

Set stores the given value for the given key. Values are automatically marshalled to JSON or gob (depending on the configuration). The key must not be "" and the value must not be nil.

type Options

type Options struct {
	// ID of the Google Cloud project.
	ProjectID string
	// Path to the credentials file. For example:
	// "/home/user/Downloads/[FILE_NAME].json".
	// If you don't set a credentials file explicitly,
	// the GCP SDK will look for the file path in the
	// GOOGLE_APPLICATION_CREDENTIALS environment variable.
	// Optional ("" by default, leading to a lookup via environment variable).
	CredentialsFile string
	// The timeout for operations.
	// Optional (2 * time.Second by default).
	Timeout *time.Duration
	// Encoding format.
	// Optional (encoding.JSON by default).
	Codec encoding.Codec
}

Options are the options for the Cloud Datastore client.