firestore

package

v1.186.1 Latest Latest Go to latest Published: Mar 30, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var Done = iterator.Done

View Source

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

This section is empty.

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

func Open(googleCloudProject string) (*Database, error)

func (db *Database) Entity(gold Model) *EntityKV

func (db *Database) ProtoKV(collection, key string) *ProtoKV

func (db *Database) StringKV(collection, key string) *StringKV

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

func (kv *EntityKV) Delete(ctx context.Context, model Model) error

func (kv *EntityKV) Get(ctx context.Context, model Model) error

func (kv *EntityKV) Put(ctx context.Context, model Model) error

func (kv *EntityKV) Query() Query

type Model interface {
	Collection() string
	Key() string
}

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

func (kv *ProtoKV) Delete(ctx context.Context) error

func (kv *ProtoKV) Get(ctx context.Context, model proto.Message) error

func (kv *ProtoKV) GetBytes(ctx context.Context) ([]byte, error)

func (kv *ProtoKV) Put(ctx context.Context, model proto.Message) error

type Query = firestore.Query

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

func (kv *StringKV) Get(ctx context.Context, content *string) error

func (kv *StringKV) Put(ctx context.Context, content string) error