store

Documentation

Index

• type Client
  • func (i Client) Doc(collectionName string, path string) *firestore.DocumentRef
  • func (i Client) Find(collectionName string, field string, value interface{}) firestore.Query
  • func (i Client) RunTransaction(ctx context.Context, f func(context.Context, *firestore.Transaction) error, ...) (err error)
• type MockClient
  • func (i MockClient) Doc(_ string, path string) *firestore.DocumentRef
  • func (i MockClient) Find(collectionName string, field string, value interface{}) firestore.Query
  • func (i MockClient) RunTransaction(ctx context.Context, f func(context.Context, *firestore.Transaction) error, ...) (err error)
• type Storer

Types

type Client

type Client struct{}

Client to interact with storage API

func (Client) Doc

func (i Client) Doc(collectionName string, path string) *firestore.DocumentRef

Doc returns a DocumentRef that refers to the document in the collection with the given identifier.

func (Client) Find

func (i Client) Find(collectionName string, field string, value interface{}) firestore.Query

Find Creates query searching for record with given field value.

func (Client) RunTransaction

func (i Client) RunTransaction(ctx context.Context, f func(context.Context, *firestore.Transaction) error, opts ...firestore.TransactionOption) (err error)

RunTransaction runs f in a transaction.

type MockClient

type MockClient struct{}

MockClient mocks storage client functionaly for unit tests

func (MockClient) Doc

func (i MockClient) Doc(_ string, path string) *firestore.DocumentRef

Doc returns a DocumentRef that refers to the document in the collection with the given identifier.

func (MockClient) Find

func (i MockClient) Find(collectionName string, field string, value interface{}) firestore.Query

Find Creates query searching for record with given field value. NOOP.

func (MockClient) RunTransaction

func (i MockClient) RunTransaction(ctx context.Context, f func(context.Context, *firestore.Transaction) error, opts ...firestore.TransactionOption) (err error)

RunTransaction runs f in a transaction.

type Storer

type Storer interface {
	Doc(string, string) *firestore.DocumentRef
	RunTransaction(context.Context, func(context.Context, *firestore.Transaction) error, ...firestore.TransactionOption) error
	Find(collectionName string, field string, value interface{}) firestore.Query
}

Storer is a storage abstraction layer interface