firestore

Documentation

Index

• type FireStore
  • func NewFireStore(ctx context.Context, projectID, namespace, environment string, opts ...Option) (*FireStore, error)
  • func (s *FireStore) Close() error
  • func (s *FireStore) Create(ctx context.Context, kind, id string, entity interface{}) error
  • func (s *FireStore) Find(ctx context.Context, kind string, opts datastore.ListOptions) (datastore.Iterator, error)
  • func (s *FireStore) Get(ctx context.Context, kind, id string, v interface{}) error
  • func (s *FireStore) Put(ctx context.Context, kind, id string, entity interface{}) error
  • func (s *FireStore) Update(ctx context.Context, kind, id string, factory datastore.Factory, ...) error
• type Iterator
  • func (it *Iterator) Cursor() (string, error)
  • func (it *Iterator) Next(dst interface{}) error
• type Option
  • func WithCollectionNamePrefix(prefix string) Option
  • func WithCredentialsFile(path string) Option
  • func WithLogger(logger *zap.Logger) Option

Types

type FireStore

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

func NewFireStore

func NewFireStore(ctx context.Context, projectID, namespace, environment string, opts ...Option) (*FireStore, error)

func (*FireStore) Close

func (s *FireStore) Close() error

func (*FireStore) Create

func (s *FireStore) Create(ctx context.Context, kind, id string, entity interface{}) error

func (*FireStore) Find

func (s *FireStore) Find(ctx context.Context, kind string, opts datastore.ListOptions) (datastore.Iterator, error)

func (*FireStore) Get

func (s *FireStore) Get(ctx context.Context, kind, id string, v interface{}) error

func (*FireStore) Put

func (s *FireStore) Put(ctx context.Context, kind, id string, entity interface{}) error

func (*FireStore) Update

func (s *FireStore) Update(ctx context.Context, kind, id string, factory datastore.Factory, updater datastore.Updater) error

type Iterator

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

func (*Iterator) Cursor

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

Cursor builds a base 64 string (encode from string in map[string]interface{} format). The cursor contains only values attached with the fields used as ordering fields.

func (*Iterator) Next

func (it *Iterator) Next(dst interface{}) error

type Option

type Option func(*FireStore)

func WithCollectionNamePrefix

func WithCollectionNamePrefix(prefix string) Option

func WithCredentialsFile

func WithCredentialsFile(path string) Option

func WithLogger

func WithLogger(logger *zap.Logger) Option