Package firestore is an auto-generated package for the Cloud Firestore API.
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit godoc.org/cloud.google.com/go.
Deprecated: Please use "cloud.google.com/go/firestore/apiv1". This beta client will be removed in a future release.
Functions
func DefaultAuthScopes (deprecated)
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions (deprecated)
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.
Client (deprecated)
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// contains filtered or unexported fields
}
Client is a client for interacting with Cloud Firestore API.
Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewClient (deprecated)
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
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
firestore
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use client.
_
=
c
}
func (*Client) BatchGetDocuments (deprecated)
func
(
c
*
Client
)
BatchGetDocuments
(
ctx
context
.
Context
,
req
*
firestorepb
.
BatchGetDocumentsRequest
,
opts
...
gax
.
CallOption
)
(
firestorepb
.
Firestore_BatchGetDocumentsClient
,
error
)
BatchGetDocuments gets multiple documents.
Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
func (*Client) BeginTransaction (deprecated)
func
(
c
*
Client
)
BeginTransaction
(
ctx
context
.
Context
,
req
*
firestorepb
.
BeginTransactionRequest
,
opts
...
gax
.
CallOption
)
(
*
firestorepb
.
BeginTransactionResponse
,
error
)
BeginTransaction starts a new transaction.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
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
}
func (*Client) Close (deprecated)
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Commit (deprecated)
func
(
c
*
Client
)
Commit
(
ctx
context
.
Context
,
req
*
firestorepb
.
CommitRequest
,
opts
...
gax
.
CallOption
)
(
*
firestorepb
.
CommitResponse
,
error
)
Commit commits a transaction, while optionally updating documents.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
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
}
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) CreateDocument (deprecated)
func
(
c
*
Client
)
CreateDocument
(
ctx
context
.
Context
,
req
*
firestorepb
.
CreateDocumentRequest
,
opts
...
gax
.
CallOption
)
(
*
firestorepb
.
Document
,
error
)
CreateDocument creates a new document.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
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
}
func (*Client) DeleteDocument (deprecated)
func
(
c
*
Client
)
DeleteDocument
(
ctx
context
.
Context
,
req
*
firestorepb
.
DeleteDocumentRequest
,
opts
...
gax
.
CallOption
)
error
DeleteDocument deletes a document.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
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.
}
}
func (*Client) GetDocument (deprecated)
func
(
c
*
Client
)
GetDocument
(
ctx
context
.
Context
,
req
*
firestorepb
.
GetDocumentRequest
,
opts
...
gax
.
CallOption
)
(
*
firestorepb
.
Document
,
error
)
GetDocument gets a single document.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
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
}
func (*Client) ListCollectionIds (deprecated)
func
(
c
*
Client
)
ListCollectionIds
(
ctx
context
.
Context
,
req
*
firestorepb
.
ListCollectionIdsRequest
,
opts
...
gax
.
CallOption
)
*
StringIterator
ListCollectionIds lists all the collection IDs underneath a document.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
"google.golang.org/api/iterator"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
// import "google.golang.org/api/iterator"
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
}
}
func (*Client) ListDocuments (deprecated)
func
(
c
*
Client
)
ListDocuments
(
ctx
context
.
Context
,
req
*
firestorepb
.
ListDocumentsRequest
,
opts
...
gax
.
CallOption
)
*
DocumentIterator
ListDocuments lists documents.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
"google.golang.org/api/iterator"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
// import "google.golang.org/api/iterator"
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
}
}
func (*Client) Listen (deprecated)
func
(
c
*
Client
)
Listen
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
firestorepb
.
Firestore_ListenClient
,
error
)
Listen listens to changes.
Example
package
main
import
(
"context"
"io"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
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
}
}
func (*Client) Rollback (deprecated)
func
(
c
*
Client
)
Rollback
(
ctx
context
.
Context
,
req
*
firestorepb
.
RollbackRequest
,
opts
...
gax
.
CallOption
)
error
Rollback rolls back a transaction.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
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.
}
}
func (*Client) RunQuery (deprecated)
func
(
c
*
Client
)
RunQuery
(
ctx
context
.
Context
,
req
*
firestorepb
.
RunQueryRequest
,
opts
...
gax
.
CallOption
)
(
firestorepb
.
Firestore_RunQueryClient
,
error
)
RunQuery runs a query.
func (*Client) SetGoogleClientInfo (deprecated)
SetGoogleClientInfo sets the name and version of the application in
the x-goog-api-client
header passed on each request. Also passes any
provided key-value pairs. Intended for use by Google-written clients.
Internal use only.
func (*Client) UpdateDocument (deprecated)
func
(
c
*
Client
)
UpdateDocument
(
ctx
context
.
Context
,
req
*
firestorepb
.
UpdateDocumentRequest
,
opts
...
gax
.
CallOption
)
(
*
firestorepb
.
Document
,
error
)
UpdateDocument updates or inserts a document.
Example
package
main
import
(
"context"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
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
}
func (*Client) Write (deprecated)
func
(
c
*
Client
)
Write
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
firestorepb
.
Firestore_WriteClient
,
error
)
Write streams batches of document updates and deletes, in order.
Example
package
main
import
(
"context"
"io"
firestore
"cloud.google.com/go/firestore/apiv1beta1"
firestorepb
"google.golang.org/genproto/googleapis/firestore/v1beta1"
)
func
main
()
{
// import firestorepb "google.golang.org/genproto/googleapis/firestore/v1beta1"
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
}
}
DocumentIterator (deprecated)
type
DocumentIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// 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 (deprecated)
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 (deprecated)
func
(
it
*
DocumentIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
StringIterator (deprecated)
type
StringIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// 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 (deprecated)
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 (deprecated)
func
(
it
*
StringIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
