lib

Documentation

Index

• type Client
  • func NewClient(ctx context.Context, config *ClientConfig) (*Client, error)
  • func (c *Client) Add(ctx context.Context, collection string, document map[string]interface{}) (*Doc, error)
  • func (c *Client) Delete(ctx context.Context, collection string, docID string) error
  • func (c *Client) Get(ctx context.Context, collection string, docID string) (*Doc, error)
  • func (c *Client) Query(ctx context.Context, collection string, conditions []*Condition, limit int) ([]*Doc, error)
• type ClientConfig
• type Condition
• type Doc
  • func (d *Doc) String() string

Types

type Client

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

Client is used to access to Firestore documents

func NewClient

func NewClient(ctx context.Context, config *ClientConfig) (*Client, error)

NewClient returns a Client to operate data on Firestore

func (*Client) Add

func (c *Client) Add(ctx context.Context, collection string, document map[string]interface{}) (*Doc, error)

Add a document into a collection

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, collection string, docID string) error

Delete a document from a collection

func (*Client) Get

func (c *Client) Get(ctx context.Context, collection string, docID string) (*Doc, error)

Get returns a document by docID

func (*Client) Query

func (c *Client) Query(ctx context.Context, collection string, conditions []*Condition, limit int) ([]*Doc, error)

Query returns documents matched with conditions and limit the results

type ClientConfig

type ClientConfig struct {
	Credentials string
	ProjectID   string
}

ClientConfig is a configuration to use Firestore Client

type Condition

type Condition struct {
	Path  string
	Op    string
	Value interface{}
}

Condition is used for Firesstore query

type Doc

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

Doc represents documentation of Firestore

func (*Doc) String

func (d *Doc) String() string

String returns JSON string of documentation