oven

README

oven

Cloud Firestore wrapper library

Documentation

Index

• Variables
• type Service
  • func New(ctx context.Context, projectID string, opts ...option.ClientOption) *Service
  • func (s *Service) DeleteByID(ctx context.Context, col, id string) error
  • func (s *Service) GetByID(ctx context.Context, col, id string, in interface{}) error
  • func (s *Service) GetClient(ctx context.Context) error
  • func (s *Service) GetCollection(ctx context.Context, name string) (col *firestore.CollectionRef, err error)
  • func (s *Service) Save(ctx context.Context, col, id string, in interface{}) error
  • func (s *Service) Update(ctx context.Context, col, id string, args map[string]interface{}) error

Variables

var (
	// ErrDataNotFound is thrown when query does not find the requested data
	ErrDataNotFound = errors.New("data not found")
)

Types

type Service

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

Service provides object representing the inbound HTTP request.

func New

func New(ctx context.Context, projectID string, opts ...option.ClientOption) *Service

func (*Service) DeleteByID

func (s *Service) DeleteByID(ctx context.Context, col, id string) error

DeleteByID deletes specific record by id.

func (*Service) GetByID

func (s *Service) GetByID(ctx context.Context, col, id string, in interface{}) error

GetByID sets the in parameter to specific store record by id.

func (*Service) GetClient

func (s *Service) GetClient(ctx context.Context) error

GetClient creates

func (*Service) GetCollection

func (s *Service) GetCollection(ctx context.Context, name string) (col *firestore.CollectionRef, err error)

GetCollection returns specific store collection by name.

func (*Service) Save

func (s *Service) Save(ctx context.Context, col, id string, in interface{}) error

Save saves the data to the store.

func (*Service) Update

func (s *Service) Update(ctx context.Context, col, id string, args map[string]interface{}) error