Updates a database.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: firestore1 --scope <scope> projects databases-patch ...

Required Scalar Argument

• <name> (string)
  • The resource name of the Database. Format: projects/{project}/databases/{database}

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleFirestoreAdminV1Database:
  app-engine-integration-mode: string
  concurrency-mode: string
  create-time: string
  delete-protection-state: string
  earliest-version-time: string
  etag: string
  key-prefix: string
  location-id: string
  name: string
  point-in-time-recovery-enablement: string
  type: string
  uid: string
  update-time: string
  version-retention-period: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . app-engine-integration-mode=aliquyam
  • The App Engine integration mode to use for this database.
• concurrency-mode=eos
  • The concurrency control mode to use for this database.
• create-time=at
  • Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
• delete-protection-state=dolores
  • State of delete protection for the database.
• earliest-version-time=consetetur
  • Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
• etag=gubergren
  • This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
• key-prefix=dolor
  • Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
• location-id=aliquyam
  • The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
• name=no
  • The resource name of the Database. Format: projects/{project}/databases/{database}
• point-in-time-recovery-enablement=amet.
  • Whether to enable the PITR feature on this database.
• type=ipsum
  • The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
• uid=lorem
  • Output only. The system-generated UUID4 for this Database.
• update-time=accusam
  • Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
• version-retention-period=gubergren
  • Output only. The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

• -p update-mask=string
  • The list of fields to be updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").