Method: projects.databases.patch

Updates a database.

HTTP request

PATCH https://firestore.googleapis.com/v1/{database.name=projects/*/databases/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
database.name

string

The resource name of the Database. Format:projects/{project}/databases/{database}

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields to be updated.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofDatabase.

Response body

If successful, the response body contains an instance ofOperation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theOAuth 2.0 Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-06-20 UTC.