Menu
Firestore actions
Pick an action to see its parameters, request body and response fields.
13 actions
projects · 13
POSTFirestore.projects.databases.documents.batch Get
/v1/{database}/documents:batchGetGets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.POSTFirestore.projects.databases.documents.batch Write/v1/{database}/documents:batchWriteApplies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.POSTFirestore.projects.databases.documents.begin Transaction/v1/{database}/documents:beginTransactionStarts a new transaction.POSTFirestore.projects.databases.documents.commit/v1/{database}/documents:commitCommits a transaction, while optionally updating documents.POSTFirestore.projects.databases.documents.create Document/v1/{parent}/{collectionId}Creates a new document.POSTFirestore.projects.databases.documents.list Collection Ids/v1/{parent}:listCollectionIdsLists all the collection IDs underneath a document.GETFirestore.projects.databases.documents.list Documents/v1/{parent}/{collectionId}Lists documents.POSTFirestore.projects.databases.documents.partition Query/v1/{parent}:partitionQueryPartitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.PATCHFirestore.projects.databases.documents.patch/v1/{name}Updates or inserts a document.POSTFirestore.projects.databases.documents.rollback/v1/{database}/documents:rollbackRolls back a transaction.POSTFirestore.projects.databases.documents.run Aggregation Query/v1/{parent}:runAggregationQueryRuns an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: ``` -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); ```POSTFirestore.projects.databases.documents.run Query/v1/{parent}:runQueryRuns a query.POSTFirestore.projects.databases.documents.write/v1/{database}/documents:writeStreams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).