Reference documentation and code samples for the Cloud Firestore V1 Client class BulkDeleteDocumentsRequest.
The request for
FirestoreAdmin.BulkDeleteDocuments.
When both collection_ids and namespace_ids are set, only documents satisfying
both conditions will be deleted.
Requests with namespace_ids and collection_ids both empty will be rejected.
Please use
FirestoreAdmin.DeleteDatabase
instead.
Generated from protobuf message google.firestore.admin.v1.BulkDeleteDocumentsRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. Database to operate. Should be of the form: projects/{project_id}/databases/{database_id}.
↳ collection_ids
array
Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique.
↳ namespace_ids
array
Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique.
getName
Required. Database to operate. Should be of the form:
projects/{project_id}/databases/{database_id}.
Returns
Type
Description
string
setName
Required. Database to operate. Should be of the form:
projects/{project_id}/databases/{database_id}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getCollectionIds
Optional. IDs of the collection groups to delete. Unspecified means all
collection groups.
Each collection group in this list must be unique.
Optional. IDs of the collection groups to delete. Unspecified means all
collection groups.
Each collection group in this list must be unique.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getNamespaceIds
Optional. Namespaces to delete.
An empty list means all namespaces. This is the recommended
usage for databases that don't use namespaces.
An empty string element represents the default namespace. This should be
used if the database has data in non-default namespaces, but doesn't want
to delete from them.
Each namespace in this list must be unique.
An empty list means all namespaces. This is the recommended
usage for databases that don't use namespaces.
An empty string element represents the default namespace. This should be
used if the database has data in non-default namespaces, but doesn't want
to delete from them.
Each namespace in this list must be unique.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. Database to operate. Should be of the form:
projects/{project_id}/databases/{database_id}. Please see
FirestoreAdminClient::databaseName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class BulkDeleteDocumentsRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.BulkDeleteDocumentsRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.BulkDeleteDocumentsRequest) \nReference documentation and code samples for the Cloud Firestore V1 Client class BulkDeleteDocumentsRequest.\n\nThe request for\nFirestoreAdmin.BulkDeleteDocuments.\n\nWhen both collection_ids and namespace_ids are set, only documents satisfying\nboth conditions will be deleted.\nRequests with namespace_ids and collection_ids both empty will be rejected.\nPlease use\nFirestoreAdmin.DeleteDatabase\ninstead.\n\nGenerated from protobuf message `google.firestore.admin.v1.BulkDeleteDocumentsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Database to operate. Should be of the form:\n`projects/{project_id}/databases/{database_id}`.\n\n### setName\n\nRequired. Database to operate. Should be of the form:\n`projects/{project_id}/databases/{database_id}`.\n\n### getCollectionIds\n\nOptional. IDs of the collection groups to delete. Unspecified means all\ncollection groups.\n\nEach collection group in this list must be unique.\n\n### setCollectionIds\n\nOptional. IDs of the collection groups to delete. Unspecified means all\ncollection groups.\n\nEach collection group in this list must be unique.\n\n### getNamespaceIds\n\nOptional. Namespaces to delete.\n\nAn empty list means all namespaces. This is the recommended\nusage for databases that don't use namespaces.\nAn empty string element represents the default namespace. This should be\nused if the database has data in non-default namespaces, but doesn't want\nto delete from them.\nEach namespace in this list must be unique.\n\n### setNamespaceIds\n\nOptional. Namespaces to delete.\n\nAn empty list means all namespaces. This is the recommended\nusage for databases that don't use namespaces.\nAn empty string element represents the default namespace. This should be\nused if the database has data in non-default namespaces, but doesn't want\nto delete from them.\nEach namespace in this list must be unique.\n\n### static::build"]]
