firebase:: firestore
Cloud Firestore API.
Summary
Cloud Firestore is a flexible, scalable database for mobile, web, and server development from Firebase and Google Cloud Platform.
Enumerations |
|
---|---|
AggregateSource{
|
enum The sources from which AggregateQuery::Get can retrieve its results. |
Error{
|
enum Error codes used by Cloud Firestore. |
MetadataChanges{
|
enum Indicates whether metadata-only changes (that is, DocumentSnapshot::metadata() or QuerySnapshot::metadata() changed) should trigger snapshot events. |
Source{
|
enum Configures the behavior of DocumentReference::Get() and Query::Get(). |
Typedefs |
|
---|---|
MapFieldPathValue
|
usingstd::unordered_map< FieldPath, FieldValue >
A map of FieldValue s indexed by field paths. |
MapFieldValue
|
usingstd::unordered_map< std::string, FieldValue >
A map of FieldValue s indexed by stringified field paths. |
Functions |
|
---|---|
operator!=(const DocumentChange & lhs, const DocumentChange & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const GeoPoint & lhs, const GeoPoint & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const SnapshotMetadata & lhs, const SnapshotMetadata & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const AggregateQuery & lhs, const AggregateQuery & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const QuerySnapshot & lhs, const QuerySnapshot & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const Settings & lhs, const Settings & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const SetOptions & lhs, const SetOptions & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const FieldValue & lhs, const FieldValue & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const AggregateQuerySnapshot & lhs, const AggregateQuerySnapshot & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const DocumentReference & lhs, const DocumentReference & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const Filter & lhs, const Filter & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const LoadBundleTaskProgress & lhs, const LoadBundleTaskProgress & rhs)
|
bool
LoadBundleTaskProgress != comparison operator.
|
operator!=(const DocumentSnapshot & lhs, const DocumentSnapshot & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator!=(const TransactionOptions & lhs, const TransactionOptions & rhs)
|
bool
Compares two
TransactionOptions objects for inequality. |
operator!=(const Query & lhs, const Query & rhs)
|
bool
Checks
lhs and rhs for inequality. |
operator<(const GeoPoint & lhs, const GeoPoint & rhs)
|
bool
Checks whether
lhs and rhs are in ascending order. |
operator<=(const GeoPoint & lhs, const GeoPoint & rhs)
|
bool
Checks whether
lhs and rhs are in non-descending order. |
operator==(const DocumentChange & lhs, const DocumentChange & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const GeoPoint & lhs, const GeoPoint & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const SnapshotMetadata & lhs, const SnapshotMetadata & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const AggregateQuery & lhs, const AggregateQuery & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const QuerySnapshot & lhs, const QuerySnapshot & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const Settings & lhs, const Settings & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const SetOptions & lhs, const SetOptions & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const FieldValue & lhs, const FieldValue & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const AggregateQuerySnapshot & lhs, const AggregateQuerySnapshot & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const DocumentReference & lhs, const DocumentReference & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const Filter & lhs, const Filter & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const LoadBundleTaskProgress & lhs, const LoadBundleTaskProgress & rhs)
|
bool
LoadBundleTaskProgress == comparison operator.
|
operator==(const DocumentSnapshot & lhs, const DocumentSnapshot & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator==(const TransactionOptions &, const TransactionOptions &)
|
bool
Compares two
TransactionOptions objects for equality. |
operator==(const Query & lhs, const Query & rhs)
|
bool
Checks
lhs and rhs for equality. |
operator>(const GeoPoint & lhs, const GeoPoint & rhs)
|
bool
Checks whether
lhs and rhs are in descending order. |
operator>=(const GeoPoint & lhs, const GeoPoint & rhs)
|
bool
Checks whether
lhs and rhs are in non-ascending order. |
Classes |
|
---|---|
firebase:: |
A query that calculates aggregations over an underlying query. |
firebase:: |
The results of executing an AggregateQuery. |
firebase:: |
A CollectionReference can be used for adding documents, getting document references, and querying for documents (using the methods inherited from |
firebase:: |
A DocumentChange represents a change to the documents matching a query. |
firebase:: |
A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. |
firebase:: |
A DocumentSnapshot contains data read from a document in your Firestore database. |
firebase:: |
A FieldPath refers to a field in a document. |
firebase:: |
A field value represents variant datatypes as stored by Firestore. |
firebase:: |
A Filter represents a restriction on one or more field values and can be used to refine the results of a Query. |
firebase:: |
Entry point for the Firebase Firestore C++ SDK. |
firebase:: |
An immutable object representing a geographical point in Firestore. |
firebase:: |
Represents a listener that can be removed by calling Remove(). |
firebase:: |
Represents a progress update or the final state from loading bundles. |
firebase:: |
A Query which you can read or listen to. |
firebase:: |
A QuerySnapshot contains zero or more DocumentSnapshot objects. |
firebase:: |
An options object that configures the behavior of Set() calls. |
firebase:: |
|
firebase:: |
Metadata about a snapshot, describing the state of the snapshot. |
firebase:: |
Transaction provides methods to read and write data within a transaction. |
firebase:: |
Options to customize transaction behavior for |
firebase:: |
A write batch is used to perform multiple writes as a single atomic unit. |
Namespaces |
|
---|---|
firebase:: |
|
firebase:: |
|
firebase:: |
Enumerations
AggregateSource
AggregateSource
The sources from which AggregateQuery::Get can retrieve its results.
Properties | |
---|---|
kServer
|
Perform the aggregation on the server and download the result. The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every request using this source necessarily involves a round trip to the server. The AggregateQuery will fail if the server cannot be reached, such as if the client is offline. |
Error
Error
Error codes used by Cloud Firestore.
The codes are in sync across Firestore SDKs on various platforms.
MetadataChanges
MetadataChanges
Indicates whether metadata-only changes (that is, DocumentSnapshot::metadata() or QuerySnapshot::metadata() changed) should trigger snapshot events.
Properties | |
---|---|
kExclude
|
Snapshot events will not be triggered by metadata-only changes. |
kInclude
|
Snapshot events will be triggered by any changes, including metadata-only changes. |
Source
Source
Configures the behavior of DocumentReference::Get() and Query::Get().
By providing a Source value, these methods can be configured to fetch results only from the server, only from the local cache, or attempt to fetch results from the server and fall back to the cache (which is the default).
Properties | |
---|---|
kCache
|
Causes Firestore to immediately return a value from the cache, ignoring the server completely (implying that the returned value may be stale with respect to the value on the server). If there is no data in the cache to satisfy the DocumentReference::Get() call will return an error and Query::Get() will return an empty QuerySnapshot with no documents. |
kDefault
|
Causes Firestore to try to retrieve an up-to-date (server-retrieved) snapshot, but fall back to returning cached data if the server can't be reached. |
kServer
|
Causes Firestore to avoid the cache, generating an error if the server cannot be reached. Note that the cache will still be updated if the server request succeeds. Also note that latency-compensation still takes effect, so any pending write operations will be visible in the returned data (merged into the server-provided data). |
Typedefs
MapFieldPathValue
std::unordered_map< FieldPath, FieldValue > MapFieldPathValue
A map of FieldValue
s indexed by field paths.
MapFieldValue
std::unordered_map< std::string, FieldValue > MapFieldValue
A map of FieldValue
s indexed by stringified field paths.
Functions
operator!=
bool operator!=( const DocumentChange & lhs, const DocumentChange & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const GeoPoint & lhs, const GeoPoint & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const SnapshotMetadata & lhs, const SnapshotMetadata & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const AggregateQuery & lhs, const AggregateQuery & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const QuerySnapshot & lhs, const QuerySnapshot & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const Settings & lhs, const Settings & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const SetOptions & lhs, const SetOptions & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const FieldValue & lhs, const FieldValue & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const AggregateQuerySnapshot & lhs, const AggregateQuerySnapshot & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const DocumentReference & lhs, const DocumentReference & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const Filter & lhs, const Filter & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const LoadBundleTaskProgress & lhs, const LoadBundleTaskProgress & rhs )
LoadBundleTaskProgress != comparison operator.
operator!=
bool operator!=( const DocumentSnapshot & lhs, const DocumentSnapshot & rhs )
Checks lhs
and rhs
for inequality.
operator!=
bool operator!=( const TransactionOptions & lhs, const TransactionOptions & rhs )
Compares two TransactionOptions
objects for inequality.
operator!=
bool operator!=( const Query & lhs, const Query & rhs )
Checks lhs
and rhs
for inequality.
operator<
bool operator<( const GeoPoint & lhs, const GeoPoint & rhs )
Checks whether lhs
and rhs
are in ascending order.
operator<=
bool operator<=( const GeoPoint & lhs, const GeoPoint & rhs )
Checks whether lhs
and rhs
are in non-descending order.
operator==
bool operator==( const DocumentChange & lhs, const DocumentChange & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const GeoPoint & lhs, const GeoPoint & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const SnapshotMetadata & lhs, const SnapshotMetadata & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const AggregateQuery & lhs, const AggregateQuery & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const QuerySnapshot & lhs, const QuerySnapshot & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const Settings & lhs, const Settings & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const SetOptions & lhs, const SetOptions & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const FieldValue & lhs, const FieldValue & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const AggregateQuerySnapshot & lhs, const AggregateQuerySnapshot & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const DocumentReference & lhs, const DocumentReference & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const Filter & lhs, const Filter & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const LoadBundleTaskProgress & lhs, const LoadBundleTaskProgress & rhs )
LoadBundleTaskProgress == comparison operator.
operator==
bool operator==( const DocumentSnapshot & lhs, const DocumentSnapshot & rhs )
Checks lhs
and rhs
for equality.
operator==
bool operator==( const TransactionOptions &, const TransactionOptions & )
Compares two TransactionOptions
objects for equality.