googleapis.com – firestore

Tools (28)

Extracted live via the executor SDK.

• projects.firestoreProjectsDatabasesCollectionGroupsFieldsList

  Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false .

• projects.firestoreProjectsDatabasesCollectionGroupsIndexesCreate

  Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

• projects.firestoreProjectsDatabasesCollectionGroupsIndexesList

  Lists composite indexes.

• projects.firestoreProjectsDatabasesCreate

  Create a database.

• projects.firestoreProjectsDatabasesDocumentsBatchGet

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

• projects.firestoreProjectsDatabasesDocumentsBatchWrite

  Applies 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.

• projects.firestoreProjectsDatabasesDocumentsBeginTransaction

  Starts a new transaction.

• projects.firestoreProjectsDatabasesDocumentsCommit

  Commits a transaction, while optionally updating documents.

• projects.firestoreProjectsDatabasesDocumentsCreateDocument

  Creates a new document.

• projects.firestoreProjectsDatabasesDocumentsListCollectionIds

  Lists all the collection IDs underneath a document.

• projects.firestoreProjectsDatabasesDocumentsListDocuments

  Lists documents.

• projects.firestoreProjectsDatabasesDocumentsListen

  Listens to changes. This method is only available via gRPC or WebChannel (not REST).

• projects.firestoreProjectsDatabasesDocumentsPartitionQuery

  Partitions 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.

• projects.firestoreProjectsDatabasesDocumentsPatch

  Updates or inserts a document.

• projects.firestoreProjectsDatabasesDocumentsRollback

  Rolls back a transaction.

• projects.firestoreProjectsDatabasesDocumentsRunAggregationQuery

  Runs 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 );

• projects.firestoreProjectsDatabasesDocumentsRunQuery

  Runs a query.

• projects.firestoreProjectsDatabasesDocumentsWrite

  Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).

• projects.firestoreProjectsDatabasesExportDocuments

  Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import

• projects.firestoreProjectsDatabasesImportDocuments

  Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

• projects.firestoreProjectsDatabasesList

  List all the databases in the project.

• projects.firestoreProjectsDatabasesOperationsCancel

  Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

• projects.firestoreProjectsDatabasesOperationsDelete

  Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

• projects.firestoreProjectsDatabasesOperationsList

  Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

• projects.firestoreProjectsLocationsGet

  Gets information about a location.

• projects.firestoreProjectsLocationsList

  Lists information about the supported locations for this service.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools