Google Cloud Firestore database Documents class
class DocumentsUnbind or remove FirebaseApp.
void resetApp()Gets multiple documents.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". addDocument, mask, transaction, newTransaction and readTime functions.
addDocument used for adding the document path to read. mask used for setting the mask fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names.
The following function used for creating the union field consistency_selector and can be only one of the following field e.g. transaction, newTransaction and readTime functions.
Then the following functions can't be mixed used.
- transaction used for reading the document in a transaction. A base64-encoded string.
- newTransaction used for creating the transaction.
- readTime used for setting the documents as they were at the given time. This may not be older than 270 seconds. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth authentication.
For more detail, see https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/batchGet
String batchGet(AsyncClientClass &aClient, const Firestore::Parent &parent, BatchGetDocumentOptions batchOptions)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.batchOptions- The BatchGetDocumentOptions object which provided the member functions to construct the requst body.
Returns:
String- The response payload.
Gets multiple documents.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". addDocument, mask, transaction, newTransaction and readTime functions.
addDocument used for adding the document path to read. mask used for setting the mask fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names.
The following function used for creating the union field consistency_selector and can be only one of the following field e.g. transaction, newTransaction and readTime functions.
Then the following functions can't be mixed used.
- transaction used for reading the document in a transaction. A base64-encoded string.
- newTransaction used for creating the transaction.
- readTime used for setting the documents as they were at the given time. This may not be older than 270 seconds. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth authentication.
For more detail, see https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/batchGet
void batchGet(AsyncClientClass &aClient, const Firestore::Parent &parent, BatchGetDocumentOptions batchOptions, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.batchOptions- The BatchGetDocumentOptions object which provided the member functions to construct the requst body.aResult- The async result (AsyncResult).
Gets multiple documents.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". addDocument, mask, transaction, newTransaction and readTime functions.
addDocument used for adding the document path to read. mask used for setting the mask fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names.
The following function used for creating the union field consistency_selector and can be only one of the following field e.g. transaction, newTransaction and readTime functions.
Then the following functions can't be mixed used.
- transaction used for reading the document in a transaction. A base64-encoded string.
- newTransaction used for creating the transaction.
- readTime used for setting the documents as they were at the given time. This may not be older than 270 seconds. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth authentication.
For more detail, see https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/batchGet
void batchGet(AsyncClientClass &aClient, const Firestore::Parent &parent, BatchGetDocumentOptions batchOptions, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.batchOptions- The BatchGetDocumentOptions object which provided the member functions to construct the requst body.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Applies a batch of write operations.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For the write object, see https://firebase.google.com/docs/firestore/reference/rest/v1/Write
This function requires ServiceAuth authentication.
For more description, see https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/batchWrite
String batchWrite(AsyncClientClass &aClient, const Firestore::Parent &parent, Writes &writes)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.writes- The writes to apply. This Writes object accepts the Write object and Labels (MapValue) associated with this batch write, in its constructor.
Returns:
String- The response payload.
Applies a batch of write operations.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". For the write object, see https://firebase.google.com/docs/firestore/reference/rest/v1/Write
This function requires ServiceAuth authentication.
For more description, see https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/batchWrite
void batchWrite(AsyncClientClass &aClient, const Firestore::Parent &parent, Writes &writes, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.writes- The writes to apply. This Writes object accepts the Write object and Labels (MapValue) associated with this batch write, in its constructor.aResult- The async result (AsyncResult).
Applies a batch of write operations.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". For the write object, see https://firebase.google.com/docs/firestore/reference/rest/v1/Write
This function requires ServiceAuth authentication.
For more description, see https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents/batchWrite
void batchWrite(AsyncClientClass &aClient, const Firestore::Parent &parent, Writes &writes, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.writes- The writes to apply. This Writes object accepts the Write object and Labels (MapValue) associated with this batch write, in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Starts a new transaction.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
The TransactionOptions object can be initialized with two objects represent two modes readOnly and readWrite.
Use readOnly option used when transaction can only be used for read operations. Use readWrite option used when transaction can be used for both read and write operations.
The readOnly object (option) accepts the readTime (timestamp) in the constructor for reading the documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
The readWrite object (option) accepts the retryTransaction (base64 encoded string) in the constructor represents a transaction that can be used to read and write documents.
See https://cloud.google.com/firestore/docs/reference/rest/v1/TransactionOptions for transaction options.
This function requires ServiceAuth authentication.
String beginTransaction(AsyncClientClass &aClient, const Firestore::Parent &parent, const TransactionOptions &transOptions)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.transOptions- Options for creating a new transaction.
Returns:
String- The response payload.
Starts a new transaction.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
The TransactionOptions object can be initialized with two objects represent two modes readOnly and readWrite.
Use readOnly option used when transaction can only be used for read operations. Use readWrite option used when transaction can be used for both read and write operations.
The readOnly object (option) accepts the readTime (timestamp) in the constructor for reading the documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
The readWrite object (option) accepts the retryTransaction (base64 encoded string) in the constructor represents a transaction that can be used to read and write documents.
See https://cloud.google.com/firestore/docs/reference/rest/v1/TransactionOptions for transaction options.
This function requires ServiceAuth authentication.
void beginTransaction(AsyncClientClass &aClient, const Firestore::Parent &parent, const TransactionOptions &transOptions, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.transOptions- Options for creating a new transaction.aResult- The async result (AsyncResult).
Starts a new transaction.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
The TransactionOptions object can be initialized with two objects represent two modes readOnly and readWrite.
Use readOnly option used when transaction can only be used for read operations. Use readWrite option used when transaction can be used for both read and write operations.
The readOnly object (option) accepts the readTime (timestamp) in the constructor for reading the documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
The readWrite object (option) accepts the retryTransaction (base64 encoded string) in the constructor represents a transaction that can be used to read and write documents.
See https://cloud.google.com/firestore/docs/reference/rest/v1/TransactionOptions for transaction options.
This function requires ServiceAuth authentication.
void beginTransaction(AsyncClientClass &aClient, const Firestore::Parent &parent, const TransactionOptions &transOptions, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.transOptions- Options for creating a new transaction.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Commits a transaction, while optionally updating documents.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For the write object, see https://firebase.google.com/docs/firestore/reference/rest/v1/Write
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
String commit(AsyncClientClass &aClient, const Firestore::Parent &parent, Writes &writes)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.writes- The writes to apply.
Returns:
String- The response payload.
Commits a transaction, while optionally updating documents.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For the write object, see https://firebase.google.com/docs/firestore/reference/rest/v1/Write
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void commit(AsyncClientClass &aClient, const Firestore::Parent &parent, Writes &writes, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.writes- The writes to apply.aResult- The async result (AsyncResult).
Commits a transaction, while optionally updating documents.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For the write object, see https://firebase.google.com/docs/firestore/reference/rest/v1/Write
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void commit(AsyncClientClass &aClient, const Firestore::Parent &parent, Writes &writes, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.writes- The writes to apply. This Writes object accepts the Write object and transaction string (base64 encoded string) in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Create a document at the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". See https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
String createDocument(AsyncClientClass &aClient, Firestore::Parent parent, const String &documentPath, DocumentMask mask, Document<Values::Value> &document)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to create in the collection.mask- The fields to return. If not set, returns all fields. Use comma (,) to separate between the field names.document- A Firestore document. See Firestore document class and functions.
Returns:
String- The response payload.
Create a document at the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". See https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void createDocument(AsyncClientClass &aClient, Firestore::Parent parent, const String &documentPath, DocumentMask mask, Document<Values::Value> &document, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to create in the collection.mask- The fields to return. If not set, returns all fields. Use comma (,) to separate between the field names.document- A Firestore document. See Firestore document class and functions.aResult- The async result (AsyncResult)
Create a document at the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". See https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void createDocument(AsyncClientClass &aClient, Firestore::Parent parent, const String &documentPath, DocumentMask mask, Document<Values::Value> &document, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to create in the collection.mask- The fields to return. If not set, returns all fields. Use comma (,) to separate between the field names.document- A Firestore document. See Firestore document class and functions.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Create a document at the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". See https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
String createDocument(AsyncClientClass &aClient, Firestore::Parent parent, const String &collectionId, const String &documentId, DocumentMask mask, Document<Values::Value> &document)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The relative path of document collection id to create the document.documentId- The document id of document to be created.mask- The fields to return. If not set, returns all fields. Use comma (,) to separate between the field names.document- A Firestore document. See Firestore document class and functions.
Returns:
String- The response payload.
Create a document at the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". See https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void createDocument(AsyncClientClass &aClient, Firestore::Parent parent, const String &collectionId, const String &documentId, DocumentMask mask, Document<Values::Value> &document, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The relative path of document collection id to create the document.documentId- The document id of document to be created.mask- The fields to return. If not set, returns all fields. Use comma (,) to separate between the field names.document- A Firestore document. See Firestore document class and functions.aResult- The async result (AsyncResult)
Create a document at the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". See https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void createDocument(AsyncClientClass &aClient, Firestore::Parent parent, const String &collectionId, const String &documentId, DocumentMask mask, Document<Values::Value> &document, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The relative path of document collection id to create the document.documentId- The document id of document to be created.mask- The fields to return. If not set, returns all fields. Use comma (,) to separate between the field names.document- A Firestore document. See Firestore document class and functions.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Delete a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The request will fail if this is set and not met by the target document.
There are the member functions exists and updateTime for creating the union field exists and updateTime respectively.
The exists option, when set to true, the target document must exist. When set to false, the target document must not exist. The updateTime (timestamp) option, when set, the target document must exist and have been last updated at that time. A timestamp is in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
String deleteDoc(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, const Precondition ¤tDocument)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to delete.currentDocument- The Precondition object for an optional precondition on the document.
Returns:
String- The response payload.
Delete a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The request will fail if this is set and not met by the target document.
There are the member functions exists and updateTime for creating the union field exists and updateTime respectively.
The exists option, when set to true, the target document must exist. When set to false, the target document must not exist. The updateTime (timestamp) option, when set, the target document must exist and have been last updated at that time. A timestamp is in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void deleteDoc(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, const Precondition ¤tDocument, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to delete.currentDocument- The Precondition object for an optional precondition on the document.aResult- The async result (AsyncResult).
Delete a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The request will fail if this is set and not met by the target document.
There are the member functions exists and updateTime for creating the union field exists and updateTime respectively.
The exists option, when set to true, the target document must exist. When set to false, the target document must not exist. The updateTime (timestamp) option, when set, the target document must exist and have been last updated at that time. A timestamp is in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void deleteDoc(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, const Precondition ¤tDocument, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to delete.currentDocument- The Precondition object for an optional precondition on the document.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Get a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
- mask is the fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names.
- transaction is a base64-encoded string. If set, reads the document in a transaction.
- readTime is a timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. If set, reads the version of the document at the given time. This may not be older than 270 seconds. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
String get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, const GetDocumentOptions &options)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get.options- The GetDocumentOptions object included mask, transaction and readTime in its constructor.
Returns:
String- The response payload.
Get a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
- mask is the fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names.
- transaction is a base64-encoded string. If set, reads the document in a transaction.
- readTime is a timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. If set, reads the version of the document at the given time. This may not be older than 270 seconds. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, const GetDocumentOptions &options, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get.options- The GetDocumentOptions object included mask, transaction and readTime in its constructor.aResult- The async result (AsyncResult).
Get a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
- mask is the fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names.
- transaction is a base64-encoded string. If set, reads the document in a transaction.
- readTime is a timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. If set, reads the version of the document at the given time. This may not be older than 270 seconds. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, const GetDocumentOptions &options, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get.options- The GetDocumentOptions object included mask, transaction and readTime in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
List the documents in the defined documents collection.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". showMissing for creating the query string options pageSize, pageToken, orderBy, mask and showMissing respectively. The option pageSize is for setting the maximum number of documents to return. The option pageToken is the nextPageToken value returned from a previous List request, if any. The option orderBy is the order to sort results by. For example: priority desc, name. The option mask is for setting the fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. The option showMissing is for setting if the list should show missing documents. A missing document is a document that does not exist but has sub-documents.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
String list(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, ListDocumentsOptions listDocsOptions)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The relative path of document colection.listDocsOptions- The ListDocumentsOptions object that provides the member functions pageSize, pageToken, orderBy, mask and
Returns:
String- The response payload.
List the documents in the defined documents collection.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". showMissing for creating the query string options pageSize, pageToken, orderBy, mask and showMissing respectively. The option pageSize is for setting the maximum number of documents to return. The option pageToken is the nextPageToken value returned from a previous List request, if any. The option orderBy is the order to sort results by. For example: priority desc, name. The option mask is for setting the fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. The option showMissing is for setting if the list should show missing documents. A missing document is a document that does not exist but has sub-documents.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, ListDocumentsOptions listDocsOptions, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The relative path of document colection.listDocsOptions- The ListDocumentsOptions object that provides the member functions pageSize, pageToken, orderBy, mask andaResult- The async result (AsyncResult).
List the documents in the defined documents collection.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". showMissing for creating the query string options pageSize, pageToken, orderBy, mask and showMissing respectively. The option pageSize is for setting the maximum number of documents to return. The option pageToken is the nextPageToken value returned from a previous List request, if any. The option orderBy is the order to sort results by. For example: priority desc, name. The option mask is for setting the fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. The option showMissing is for setting if the list should show missing documents. A missing document is a document that does not exist but has sub-documents.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, ListDocumentsOptions listDocsOptions, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The relative path of document colection.listDocsOptions- The ListDocumentsOptions object that provides the member functions pageSize, pageToken, orderBy, mask andcb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
List the document collection ids in the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". for creating the query string options pageSize, pageToken and readTime respectively. The option pageSize is for setting the maximum number of results to return. The option pageToken is the page token. Must be a value from ListCollectionIdsResponse. The option readTime is the timestamp for reading the documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
This function requires ServiceAuth authentication.
String listCollectionIds(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, ListCollectionIdsOptions listCollectionIdsOptions)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get its collections' id.listCollectionIdsOptions- The ListCollectionIdsOptions object that provides the member functions pageSize, pageToken and readTime
Returns:
String- The response payload.
List the document collection ids in the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". for creating the query string options pageSize, pageToken and readTime respectively. The option pageSize is for setting the maximum number of results to return. The option pageToken is the page token. Must be a value from ListCollectionIdsResponse. The option readTime is the timestamp for reading the documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
This function requires ServiceAuth authentication.
void listCollectionIds(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, ListCollectionIdsOptions listCollectionIdsOptions, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get its collections' id.listCollectionIdsOptions- The ListCollectionIdsOptions object that provides the member functions pageSize, pageToken and readTimeaResult- The async result (AsyncResult).
List the document collection ids in the defined document path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". for creating the query string options pageSize, pageToken and readTime respectively. The option pageSize is for setting the maximum number of results to return. The option pageToken is the page token. Must be a value from ListCollectionIdsResponse. The option readTime is the timestamp for reading the documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
This function requires ServiceAuth authentication.
void listCollectionIds(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, ListCollectionIdsOptions listCollectionIdsOptions, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get its collections' id.listCollectionIdsOptions- The ListCollectionIdsOptions object that provides the member functions pageSize, pageToken and readTimecb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Patch or update a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
updateMask is he fields to update. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document (content), are deleted from the document on the server. Use comma (,) to separate between the field names. mask is fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names. And currentDocument is an optional precondition on the document. The request will fail if this is set and not met by the target document.
When currentDocument as defined with true or false as constructor argument, the exists condition will be set. When currentDocument as defined with string(Timestamp format) as constructor argument, the updateTime condition will be set.
When exists condition was set to true, the target document must exist. When set to false, the target document must not exist. When updateTime was set, the target document must exist and have been last updated at that time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". @param document A Firestore document.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
String patch(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, patchDocumentOptions patchOptions, Document<Values::Value> &document)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to patch with the input document.patchOptions- The patchDocumentOptions object that included the DocumentMask (updateMask), DocumentMask (mask), Precondition (currentDocument) in its constructor.
Returns:
String- The response payload.
Patch or update a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
updateMask is he fields to update. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document (content), are deleted from the document on the server. Use comma (,) to separate between the field names. mask is fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names. And currentDocument is an optional precondition on the document. The request will fail if this is set and not met by the target document.
When currentDocument as defined with true or false as constructor argument, the exists condition will be set. When currentDocument as defined with string(Timestamp format) as constructor argument, the updateTime condition will be set.
When exists condition was set to true, the target document must exist. When set to false, the target document must not exist. When updateTime was set, the target document must exist and have been last updated at that time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". @param document A Firestore document.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void patch(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, patchDocumentOptions patchOptions, Document<Values::Value> &document, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to patch with the input document.patchOptions- The patchDocumentOptions object that included the DocumentMask (updateMask), DocumentMask (mask), Precondition (currentDocument) in its constructor.aResult- The async result (AsyncResult).
Patch or update a document at the defined path.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
updateMask is he fields to update. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document (content), are deleted from the document on the server. Use comma (,) to separate between the field names. mask is fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. Use comma (,) to separate between the field names. And currentDocument is an optional precondition on the document. The request will fail if this is set and not met by the target document.
When currentDocument as defined with true or false as constructor argument, the exists condition will be set. When currentDocument as defined with string(Timestamp format) as constructor argument, the updateTime condition will be set.
When exists condition was set to true, the target document must exist. When set to false, the target document must not exist. When updateTime was set, the target document must exist and have been last updated at that time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z". @param document A Firestore document.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
void patch(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, patchDocumentOptions patchOptions, Document<Values::Value> &document, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to patch with the input document.patchOptions- The patchDocumentOptions object that included the DocumentMask (updateMask), DocumentMask (mask), Precondition (currentDocument) in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Rolls back a transaction.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
This function requires ServiceAuth authentication.
String rollback(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &transaction)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.transaction- Required. A base64-encoded string of the transaction to roll back.
Returns:
String- The response payload.
Rolls back a transaction.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
This function requires ServiceAuth authentication.
void rollback(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &transaction, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.transaction- Required. A base64-encoded string of the transaction to roll back.aResult- The async result (AsyncResult).
Rolls back a transaction.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
This function requires ServiceAuth authentication.
void rollback(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &transaction, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.transaction- Required. A base64-encoded string of the transaction to roll back.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Runs a query.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". structuredQuery, transaction, newTransaction and readTime functions.
The following function used for creating the union field consistency_selector and can be only one of the following field e.g. transaction, newTransaction and readTime functions.
Then the following functions can't be mixed used.
- transaction used for running the query within an already active transaction. A base64-encoded string.
- newTransaction used for starting a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
- readTime used for reading the documents as they were at the given time.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.documents/runQuery
String runQuery(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, QueryOptions queryOptions)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get.queryOptions- The QueryOptions object that provides the function to create the query (StructuredQuery) and consistency mode which included
Returns:
String- The response payload.
Runs a query.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". structuredQuery, transaction, newTransaction and readTime functions.
The following function used for creating the union field consistency_selector and can be only one of the following field e.g. transaction, newTransaction and readTime functions.
Then the following functions can't be mixed used.
- transaction used for running the query within an already active transaction. A base64-encoded string.
- newTransaction used for starting a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
- readTime used for reading the documents as they were at the given time.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.documents/runQuery
void runQuery(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, QueryOptions queryOptions, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get.queryOptions- The QueryOptions object that provides the function to create the query (StructuredQuery) and consistency mode which includedaResult- The async result (AsyncResult).
Runs a query.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". structuredQuery, transaction, newTransaction and readTime functions.
The following function used for creating the union field consistency_selector and can be only one of the following field e.g. transaction, newTransaction and readTime functions.
Then the following functions can't be mixed used.
- transaction used for running the query within an already active transaction. A base64-encoded string.
- newTransaction used for starting a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
- readTime used for reading the documents as they were at the given time.
This function requires ServiceAuth, CustomAuth, UserAuth, CustomToken or IDToken authentication.
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.documents/runQuery
void runQuery(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &documentPath, QueryOptions queryOptions, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.documentPath- The relative path of document to get.queryOptions- The QueryOptions object that provides the function to create the query (StructuredQuery) and consistency mode which includedcb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Google Cloud Firestore database Databases class
class DatabasesUnbind or remove FirebaseApp.
void resetApp()Export the documents in the database to the Firebase Storage data bucket.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The EximDocumentOptions constructor parameters.
- collectionIds is collection ids to export. Unspecified means all collections. Use comma (,) to separate between the collection ids.
- bucketID is the Firebase storage bucket ID in the project.
- storagePath is the path in the Firebase Storage data bucket to store the exported database.
This function requires ServiceAuth or AccessToken authentication.
String exportDocuments(AsyncClientClass &aClient, const Firestore::Parent &parent, EximDocumentOptions exportOptions)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.exportOptions- The EximDocumentOptions object included collectionIds, bucketID and storagePath in its constructor.
Returns:
String- The response payload.
Export the documents in the database to the Firebase Storage data bucket.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The EximDocumentOptions constructor parameters.
- collectionIds is collection ids to export. Unspecified means all collections. Use comma (,) to separate between the collection ids.
- bucketID is the Firebase storage bucket ID in the project.
- storagePath is the path in the Firebase Storage data bucket to store the exported database.
This function requires ServiceAuth or AccessToken authentication.
void exportDocuments(AsyncClientClass &aClient, const Firestore::Parent &parent, EximDocumentOptions exportOptions, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.exportOptions- The EximDocumentOptions object included collectionIds, bucketID and storagePath in its constructor.aResult- The async result (AsyncResult)
Export the documents in the database to the Firebase Storage data bucket.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The EximDocumentOptions constructor parameters.
- collectionIds is collection ids to export. Unspecified means all collections. Use comma (,) to separate between the collection ids.
- bucketID is the Firebase storage bucket ID in the project.
- storagePath is the path in the Firebase Storage data bucket to store the exported database.
This function requires ServiceAuth or AccessToken authentication.
void exportDocuments(AsyncClientClass &aClient, const Firestore::Parent &parent, EximDocumentOptions exportOptions, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.exportOptions- The EximDocumentOptions object included collectionIds, bucketID and storagePath in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Import the exported documents stored in the Firebase Storage data bucket.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The EximDocumentOptions constructor parameters.
- collectionIds is collection ids to import. Unspecified means all collections included in the import. Use comma (,) to separate between the collection ids.
- bucketID is the Firebase storage bucket ID in the project.
- storagePath is the path in the Firebase Storage data bucket that stores the exported database.
This function requires ServiceAuth or AccessToken authentication.
String importDocuments(AsyncClientClass &aClient, const Firestore::Parent &parent, EximDocumentOptions importOptions)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.importOptions- The EximDocumentOptions object included collectionIds, bucketID and storagePath in its constructor.
Returns:
String- The response payload.
Import the exported documents stored in the Firebase Storage data bucket.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The EximDocumentOptions constructor parameters.
- collectionIds is collection ids to import. Unspecified means all collections included in the import. Use comma (,) to separate between the collection ids.
- bucketID is the Firebase storage bucket ID in the project.
- storagePath is the path in the Firebase Storage data bucket that stores the exported database.
This function requires ServiceAuth or AccessToken authentication.
void importDocuments(AsyncClientClass &aClient, const Firestore::Parent &parent, EximDocumentOptions importOptions, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.importOptions- The EximDocumentOptions object included collectionIds, bucketID and storagePath in its constructor.aResult- The async result (AsyncResult)
Import the exported documents stored in the Firebase Storage data bucket.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "". The EximDocumentOptions constructor parameters.
- collectionIds is collection ids to import. Unspecified means all collections included in the import. Use comma (,) to separate between the collection ids.
- bucketID is the Firebase storage bucket ID in the project.
- storagePath is the path in the Firebase Storage data bucket that stores the exported database.
This function requires ServiceAuth or AccessToken authentication.
void importDocuments(AsyncClientClass &aClient, const Firestore::Parent &parent, EximDocumentOptions importOptions, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.importOptions- The EximDocumentOptions object included collectionIds, bucketID and storagePath in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Create a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to create.
The Database information should be set via the following functions befor creation. concurrencyMode, appEngineIntegrationMode, deleteProtectionState, pointInTimeRecoveryEnablement, databaseType, locationId and name.
This function requires ServiceAuth or AccessToken authentication.
String create(AsyncClientClass &aClient, const Firestore::Parent &parent, Database &database)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.database- The Firestore::Database object that hold the database information to create.
Returns:
String- The response payload.
Create a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to create.
The Database information should be set via the following functions befor creation. concurrencyMode, appEngineIntegrationMode, deleteProtectionState, pointInTimeRecoveryEnablement, databaseType, locationId and name.
This function requires ServiceAuth or AccessToken authentication.
void create(AsyncClientClass &aClient, const Firestore::Parent &parent, Database &database, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.database- The Firestore::Database object that hold the database information to create.aResult- The async result (AsyncResult).
Create a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to create.
The Database information should be set via the following functions befor creation. concurrencyMode, appEngineIntegrationMode, deleteProtectionState, pointInTimeRecoveryEnablement, databaseType, locationId and name.
This function requires ServiceAuth or AccessToken authentication.
void create(AsyncClientClass &aClient, const Firestore::Parent &parent, Database &database, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.database- The Firestore::Database object that hold the database information to create.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Deletes a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to delete. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
This function requires ServiceAuth or AccessToken authentication.
String deleteDatabase(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &etag)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.etag- The current etag of the Database.
Returns:
String- The response payload.
Deletes a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to delete. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
This function requires ServiceAuth or AccessToken authentication.
void deleteDatabase(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &etag, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.etag- The current etag of the Database.aResult- The async result (AsyncResult).
Deletes a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to delete. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
This function requires ServiceAuth or AccessToken authentication.
void deleteDatabase(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &etag, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.etag- The current etag of the Database.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Gets information about a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to get the infomation.
This function requires ServiceAuth or AccessToken authentication.
String get(AsyncClientClass &aClient, const Firestore::Parent &parent)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.
Returns:
String- The response payload.
Gets information about a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to get the infomation.
This function requires ServiceAuth or AccessToken authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.aResult- The async result (AsyncResult).
Gets information about a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to get the infomation.
This function requires ServiceAuth or AccessToken authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
List all the databases in the project.
The Firebase project Id should be only the name without the firebaseio.com. Leave the Firestore database Id to be empty for this case.
This function requires ServiceAuth or AccessToken authentication.
String list(AsyncClientClass &aClient, const Firestore::Parent &parent)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.
Returns:
String- The response payload.
List all the databases in the project.
The Firebase project Id should be only the name without the firebaseio.com. Leave the Firestore database Id to be empty for this case.
This function requires ServiceAuth or AccessToken authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.aResult- The async result (AsyncResult).
List all the databases in the project.
The Firebase project Id should be only the name without the firebaseio.com. Leave the Firestore database Id to be empty for this case.
This function requires ServiceAuth or AccessToken authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Updates a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to update. Example: "user.displayName,photo"
The Database information should be set via the following functions befor creation. concurrencyMode, appEngineIntegrationMode, deleteProtectionState, pointInTimeRecoveryEnablement, databaseType, locationId and name.
This function requires ServiceAuth or AccessToken authentication.
String patch(AsyncClientClass &aClient, const Firestore::Parent &parent, Database &database, const String &updateMask)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.database- The Firestore::Database object that hold the database information to update.updateMask- The list of fields to be updated. This is a comma-separated list of fully qualified names of fields.
Returns:
String- The response payload.
Updates a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to update. Example: "user.displayName,photo"
The Database information should be set via the following functions befor creation. concurrencyMode, appEngineIntegrationMode, deleteProtectionState, pointInTimeRecoveryEnablement, databaseType, locationId and name.
This function requires ServiceAuth or AccessToken authentication.
void patch(AsyncClientClass &aClient, const Firestore::Parent &parent, Database &database, const String &updateMask, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.database- The Firestore::Database object that hold the database information to update.updateMask- The list of fields to be updated. This is a comma-separated list of fully qualified names of fields.aResult- The async result (AsyncResult).
Updates a database.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database Id is the Id of database to update. Example: "user.displayName,photo"
The Database information should be set via the following functions befor creation. concurrencyMode, appEngineIntegrationMode, deleteProtectionState, pointInTimeRecoveryEnablement, databaseType, locationId and name.
This function requires ServiceAuth or AccessToken authentication.
void patch(AsyncClientClass &aClient, const Firestore::Parent &parent, Database &database, const String &updateMask, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.database- The Firestore::Database object that hold the database information to update.updateMask- The list of fields to be updated. This is a comma-separated list of fully qualified names of fields.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Creates the specified index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/create
This function requires ServiceAuth authentication.
String create(AsyncClientClass &aClient, const Firestore::Parent &parent, DatabaseIndex::Index index)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.index- The Index object that provides an index definition.
Returns:
String- The response payload.
Creates the specified index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/create
This function requires ServiceAuth authentication.
void create(AsyncClientClass &aClient, const Firestore::Parent &parent, DatabaseIndex::Index index, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.index- The Index object that provides an index definition.aResult- The async result (AsyncResult).
Creates the specified index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/create
This function requires ServiceAuth authentication.
void create(AsyncClientClass &aClient, const Firestore::Parent &parent, DatabaseIndex::Index index, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.index- The Index object that provides an index definition.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Deletes an index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/delete
This function requires ServiceAuth authentication.
String deleteIndex(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &indexId)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to delete.
Returns:
String- The response payload.
Deletes an index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/delete
This function requires ServiceAuth authentication.
void deleteIndex(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &indexId, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to delete.aResult- The async result (AsyncResult).
Deletes an index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/delete
This function requires ServiceAuth authentication.
void deleteIndex(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &indexId, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to delete.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Gets an index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/get
This function requires ServiceAuth authentication.
String get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &indexId)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to get.
Returns:
String- The response payload.
Gets an index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/get
This function requires ServiceAuth authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &indexId, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to get.aResult- The async result (AsyncResult).
Gets an index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/get
This function requires ServiceAuth authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &indexId, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to get.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Lists the indexes.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/list
This function requires ServiceAuth authentication.
String list(AsyncClientClass &aClient, const Firestore::Parent &parent)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.
Returns:
String- The response payload.
Lists the indexes.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/list
This function requires ServiceAuth authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to get.aResult- The async result (AsyncResult).
Lists the indexes.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1beta1/projects.databases.indexes/list
This function requires ServiceAuth authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Google Cloud Firestore database CollectionGroups class
class CollectionGroupsUnbind or remove FirebaseApp.
void resetApp()Creates a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/create
This function requires ServiceAuth authentication.
String create(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, CollectionGroupsIndex::Index index)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.index- The Cloud Firestore indexes enable simple and complex queries against documents in a database.
Returns:
String- The response payload.
Creates a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/create
This function requires ServiceAuth authentication.
void create(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, CollectionGroupsIndex::Index index, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.index- The Cloud Firestore indexes enable simple and complex queries against documents in a database.aResult- The async result (AsyncResult).
Creates a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/create
This function requires ServiceAuth authentication.
void create(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, CollectionGroupsIndex::Index index, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.index- The Cloud Firestore indexes enable simple and complex queries against documents in a database.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Deletes a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/delete
This function requires ServiceAuth authentication.
String deleteIndex(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, const String &indexId)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.indexId- The index to delete.
Returns:
String- The response payload.
Deletes a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/delete
This function requires ServiceAuth authentication.
void deleteIndex(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, const String &indexId, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.indexId- The index to delete.aResult- The async result (AsyncResult).
Deletes a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/delete
This function requires ServiceAuth authentication.
void deleteIndex(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, const String &indexId, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.indexId- The index to delete.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Gets a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/get
This function requires ServiceAuth authentication.
String get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, const String &indexId)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.indexId- The index to get.
Returns:
String- The response payload.
Gets a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/get
This function requires ServiceAuth authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, const String &indexId, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.indexId- The index to get.aResult- The async result (AsyncResult).
Gets a composite index.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/get
This function requires ServiceAuth authentication.
void get(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, const String &indexId, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.collectionId- The collection Id.indexId- The index to get.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).
Lists composite indexes.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/list
This function requires ServiceAuth authentication.
String list(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.
Returns:
String- The response payload.
Lists composite indexes.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/list
This function requires ServiceAuth authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, AsyncResult &aResult)Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.indexId- The index to get.aResult- The async result (AsyncResult).
Lists composite indexes.
The Firebase project Id should be only the name without the firebaseio.com. The Firestore database id should be (default) or empty "".
For more description, see https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.collectionGroups.indexes/list
This function requires ServiceAuth authentication.
void list(AsyncClientClass &aClient, const Firestore::Parent &parent, const String &collectionId, AsyncResultCallback cb, const String &uid = "")Params:
aClient- The async client.parent- The Firestore::Parent object included project Id and database Id in its constructor.cb- The async result callback (AsyncResultCallback).uid- The user specified UID of async result (optional).