fstore

Documentation

Overview

Package fstore provides general support for Firestore. Its main feature is separate namespaces, to mimic separate databases for different purposes (prod, dev, test, etc.).

Index

• func Decode[T any](ds *firestore.DocumentSnapshot) (*T, error)
• func Get[T any](ctx context.Context, dr *firestore.DocumentRef) (_ *T, err error)
• func Set[T any](ctx context.Context, dr *firestore.DocumentRef, value *T) (err error)
• type Namespace
  • func OpenNamespace(ctx context.Context, projectID, name string) (_ *Namespace, err error)
  • func (ns *Namespace) Client() *firestore.Client
  • func (ns *Namespace) Close() error
  • func (ns *Namespace) Collection(name string) *firestore.CollectionRef
  • func (ns *Namespace) Name() string

Functions

func Decode

func Decode[T any](ds *firestore.DocumentSnapshot) (*T, error)

Decode decodes a DocumentSnapshot into a value of type T.

func Get

func Get[T any](ctx context.Context, dr *firestore.DocumentRef) (_ *T, err error)

Get gets the DocumentRef and decodes the result to a value of type T.

func Set

func Set[T any](ctx context.Context, dr *firestore.DocumentRef, value *T) (err error)

Set sets the DocumentRef to the value.

Types

type Namespace

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

A Namespace is a top-level collection for partitioning a Firestore database into separate segments.

func OpenNamespace

func OpenNamespace(ctx context.Context, projectID, name string) (_ *Namespace, err error)

OpenNamespace creates a new Firestore client whose collections will be located in the given namespace.

func (*Namespace) Client

func (ns *Namespace) Client() *firestore.Client

Client returns the underlying Firestore client.

func (*Namespace) Close

func (ns *Namespace) Close() error

Close closes the underlying client.

func (*Namespace) Collection

func (ns *Namespace) Collection(name string) *firestore.CollectionRef

Collection returns a reference to the named collection in the namespace.

func (*Namespace) Name

func (ns *Namespace) Name() string

Name returns the Namespace's name.