Reference documentation and code samples for the Cloud Firestore V1 Client class DeleteDatabaseRequest.
The request for
FirestoreAdmin.DeleteDatabase.
Generated from protobuf message google.firestore.admin.v1.DeleteDatabaseRequest
Namespace
Google \ Cloud \ Firestore \ Admin \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. A name of the form projects/{project_id}/databases/{database_id}
↳ etag
string
The current etag of the Database. 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.
getName
Required. A name of the form
projects/{project_id}/databases/{database_id}
Returns
Type
Description
string
setName
Required. A name of the form
projects/{project_id}/databases/{database_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEtag
The current etag of the Database.
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.
Returns
Type
Description
string
setEtag
The current etag of the Database.
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. A name 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 DeleteDatabaseRequest (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.DeleteDatabaseRequest)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.DeleteDatabaseRequest)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.DeleteDatabaseRequest)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.DeleteDatabaseRequest)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.DeleteDatabaseRequest)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.DeleteDatabaseRequest)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.DeleteDatabaseRequest)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.DeleteDatabaseRequest)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.DeleteDatabaseRequest)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.DeleteDatabaseRequest)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.DeleteDatabaseRequest)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.DeleteDatabaseRequest)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.DeleteDatabaseRequest)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.DeleteDatabaseRequest)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.DeleteDatabaseRequest)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.DeleteDatabaseRequest)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.DeleteDatabaseRequest)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.DeleteDatabaseRequest)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.DeleteDatabaseRequest)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.DeleteDatabaseRequest)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.DeleteDatabaseRequest)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.DeleteDatabaseRequest)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.DeleteDatabaseRequest) \nReference documentation and code samples for the Cloud Firestore V1 Client class DeleteDatabaseRequest.\n\nThe request for\nFirestoreAdmin.DeleteDatabase.\n\nGenerated from protobuf message `google.firestore.admin.v1.DeleteDatabaseRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. A name of the form\n`projects/{project_id}/databases/{database_id}`\n\n### setName\n\nRequired. A name of the form\n`projects/{project_id}/databases/{database_id}`\n\n### getEtag\n\nThe current etag of the Database.\n\nIf an etag is provided and does not match the current etag of the database,\ndeletion will be blocked and a FAILED_PRECONDITION error will be returned.\n\n### setEtag\n\nThe current etag of the Database.\n\nIf an etag is provided and does not match the current etag of the database,\ndeletion will be blocked and a FAILED_PRECONDITION error will be returned.\n\n### static::build"]]
