firestore

package
Version: v0.26.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 7, 2018 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package firestore is an auto-generated package for the Google Cloud Firestore API.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

Use the client at cloud.google.com/go/firestore in preference to this.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func AnyPathPath deprecated

This function has been deprecated.
func AnyPathPath(project, database, document, anyPath string) string

AnyPathPath returns the path for the any path resource.

Deprecated: Use

fmt.Sprintf("projects/%s/databases/%s/documents/%s/%s", project, database, document, anyPath)

instead.

func DatabaseRootPath deprecated

This function has been deprecated.
func DatabaseRootPath(project, database string) string

DatabaseRootPath returns the path for the database root resource.

Deprecated: Use

fmt.Sprintf("projects/%s/databases/%s", project, database)

instead.

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

func DocumentPathPath deprecated

This function has been deprecated.
func DocumentPathPath(project, database, documentPath string) string

DocumentPathPath returns the path for the document path resource.

Deprecated: Use

fmt.Sprintf("projects/%s/databases/%s/documents/%s", project, database, documentPath)

instead.

func DocumentRootPath deprecated

This function has been deprecated.
func DocumentRootPath(project, database string) string

DocumentRootPath returns the path for the document root resource.

Deprecated: Use

fmt.Sprintf("projects/%s/databases/%s/documents", project, database)

instead.

Types

type CallOptions

type CallOptions struct {
	GetDocument       []gax.CallOption
	ListDocuments     []gax.CallOption
	CreateDocument    []gax.CallOption
	UpdateDocument    []gax.CallOption
	DeleteDocument    []gax.CallOption
	BatchGetDocuments []gax.CallOption
	BeginTransaction  []gax.CallOption
	Commit            []gax.CallOption
	Rollback          []gax.CallOption
	RunQuery          []gax.CallOption
	Write             []gax.CallOption
	Listen            []gax.CallOption
	ListCollectionIds []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type Client

type Client struct {

	// The call options for this service.
	CallOptions *CallOptions
	// contains filtered or unexported fields
}

Client is a client for interacting with Google Cloud Firestore API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new firestore client.

The Cloud Firestore service.

This service exposes several types of comparable timestamps:

create_time - The time at which a document was created. Changes only
when a document is deleted, then re-created. Increases in a strict
monotonic fashion.

update_time - The time at which a document was last updated. Changes
every time a document is modified. Does not change when a write results
in no modifications. Increases in a strict monotonic fashion.

read_time - The time at which a particular state was observed. Used
to denote a consistent snapshot of the database or the time at which a
Document was observed to not exist.

commit_time - The time at which the writes in a transaction were
committed. Any read with an equal or greater read_time is guaranteed
to see the effects of the transaction.
Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
Output:

func (*Client) BatchGetDocuments

BatchGetDocuments gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.BatchGetDocumentsRequest{
	// TODO: Fill request struct fields.
}
stream, err := c.BatchGetDocuments(ctx, req)
if err != nil {
	// TODO: Handle error.
}
for {
	resp, err := stream.Recv()
	if err == io.EOF {
		break
	}
	if err != nil {
		// TODO: handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*Client) BeginTransaction

BeginTransaction starts a new transaction.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.BeginTransactionRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.BeginTransaction(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*Client) Close

func (c *Client) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*Client) Commit

Commit commits a transaction, while optionally updating documents.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.CommitRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.Commit(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*Client) Connection

func (c *Client) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*Client) CreateDocument

func (c *Client) CreateDocument(ctx context.Context, req *firestorepb.CreateDocumentRequest, opts ...gax.CallOption) (*firestorepb.Document, error)

CreateDocument creates a new document.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.CreateDocumentRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.CreateDocument(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*Client) DeleteDocument

func (c *Client) DeleteDocument(ctx context.Context, req *firestorepb.DeleteDocumentRequest, opts ...gax.CallOption) error

DeleteDocument deletes a document.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.DeleteDocumentRequest{
	// TODO: Fill request struct fields.
}
err = c.DeleteDocument(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*Client) GetDocument

GetDocument gets a single document.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.GetDocumentRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetDocument(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*Client) ListCollectionIds

func (c *Client) ListCollectionIds(ctx context.Context, req *firestorepb.ListCollectionIdsRequest, opts ...gax.CallOption) *StringIterator

ListCollectionIds lists all the collection IDs underneath a document.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.ListCollectionIdsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListCollectionIds(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*Client) ListDocuments

func (c *Client) ListDocuments(ctx context.Context, req *firestorepb.ListDocumentsRequest, opts ...gax.CallOption) *DocumentIterator

ListDocuments lists documents.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.ListDocumentsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListDocuments(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*Client) Listen

Listen listens to changes.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
stream, err := c.Listen(ctx)
if err != nil {
	// TODO: Handle error.
}
go func() {
	reqs := []*firestorepb.ListenRequest{
		// TODO: Create requests.
	}
	for _, req := range reqs {
		if err := stream.Send(req); err != nil {
			// TODO: Handle error.
		}
	}
	stream.CloseSend()
}()
for {
	resp, err := stream.Recv()
	if err == io.EOF {
		break
	}
	if err != nil {
		// TODO: handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*Client) Rollback

func (c *Client) Rollback(ctx context.Context, req *firestorepb.RollbackRequest, opts ...gax.CallOption) error

Rollback rolls back a transaction.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.RollbackRequest{
	// TODO: Fill request struct fields.
}
err = c.Rollback(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*Client) RunQuery

RunQuery runs a query.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.RunQueryRequest{
	// TODO: Fill request struct fields.
}
stream, err := c.RunQuery(ctx, req)
if err != nil {
	// TODO: Handle error.
}
for {
	resp, err := stream.Recv()
	if err == io.EOF {
		break
	}
	if err != nil {
		// TODO: handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*Client) SetGoogleClientInfo

func (c *Client) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*Client) UpdateDocument

func (c *Client) UpdateDocument(ctx context.Context, req *firestorepb.UpdateDocumentRequest, opts ...gax.CallOption) (*firestorepb.Document, error)

UpdateDocument updates or inserts a document.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &firestorepb.UpdateDocumentRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.UpdateDocument(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*Client) Write

Write streams batches of document updates and deletes, in order.

Example
ctx := context.Background()
c, err := firestore.NewClient(ctx)
if err != nil {
	// TODO: Handle error.
}
stream, err := c.Write(ctx)
if err != nil {
	// TODO: Handle error.
}
go func() {
	reqs := []*firestorepb.WriteRequest{
		// TODO: Create requests.
	}
	for _, req := range reqs {
		if err := stream.Send(req); err != nil {
			// TODO: Handle error.
		}
	}
	stream.CloseSend()
}()
for {
	resp, err := stream.Recv()
	if err == io.EOF {
		break
	}
	if err != nil {
		// TODO: handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type DocumentIterator

type DocumentIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*firestorepb.Document, nextPageToken string, err error)
	// contains filtered or unexported fields
}

DocumentIterator manages a stream of *firestorepb.Document.

func (*DocumentIterator) Next

func (it *DocumentIterator) Next() (*firestorepb.Document, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*DocumentIterator) PageInfo

func (it *DocumentIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type StringIterator

type StringIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []string, nextPageToken string, err error)
	// contains filtered or unexported fields
}

StringIterator manages a stream of string.

func (*StringIterator) Next

func (it *StringIterator) Next() (string, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*StringIterator) PageInfo

func (it *StringIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto