ProjectsDatabases
class ProjectsDatabases extends Resource (View source)
The "databases" collection of methods.
Typical usage is:
$firestoreService = new Google\Service\Firestore(...);
$databases = $firestoreService->projects_databases;Methods
Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete (databases.bulkDeleteDocuments)
Create a database. (databases.create)
Deletes a database. (databases.delete)
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 (databases.exportDocuments)
Gets information about a database. (databases.get)
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.
List all the databases in the project. (databases.listProjectsDatabases)
Updates a database. (databases.patch)
Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long- running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed. (databases.restore)
Details
GoogleLongrunningOperation
bulkDeleteDocuments(string $name, GoogleFirestoreAdminV1BulkDeleteDocumentsRequest $postBody, array $optParams = [])
Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete (databases.bulkDeleteDocuments)
GoogleLongrunningOperation
create(string $parent, GoogleFirestoreAdminV1Database $postBody, array $optParams = [])
Create a database. (databases.create)
GoogleLongrunningOperation
delete(string $name, array $optParams = [])
Deletes a database. (databases.delete)
GoogleLongrunningOperation
exportDocuments(string $name, GoogleFirestoreAdminV1ExportDocumentsRequest $postBody, array $optParams = [])
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 (databases.exportDocuments)
GoogleFirestoreAdminV1Database
get(string $name, array $optParams = [])
Gets information about a database. (databases.get)
GoogleLongrunningOperation
importDocuments(string $name, GoogleFirestoreAdminV1ImportDocumentsRequest $postBody, array $optParams = [])
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.
(databases.importDocuments)
GoogleFirestoreAdminV1ListDatabasesResponse
listProjectsDatabases(string $parent, array $optParams = [])
List all the databases in the project. (databases.listProjectsDatabases)
GoogleLongrunningOperation
patch(string $name, GoogleFirestoreAdminV1Database $postBody, array $optParams = [])
Updates a database. (databases.patch)
GoogleLongrunningOperation
restore(string $parent, GoogleFirestoreAdminV1RestoreDatabaseRequest $postBody, array $optParams = [])
Creates a new database by restoring from an existing backup. The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup. The long- running operation can be used to track the progress of the restore, with the Operation's metadata field type being the RestoreDatabaseMetadata. The response type is the Database if the restore was successful. The new database is not readable or writeable until the LRO has completed. (databases.restore)