Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Managed Service for PostgreSQL API, gRPC: DatabaseService.Update

Written by
Updated at November 26, 2024

Updates the specified PostgreSQL database.

gRPC request

rpc Update (UpdateDatabaseRequest) returns (operation.Operation)

UpdateDatabaseRequest

{
  "cluster_id": "string",
  "database_name": "string",
  "new_database_name": "string",
  "update_mask": "google.protobuf.FieldMask",
  "extensions": [
    {
      "name": "string",
      "version": "string"
    }
  ],
  "deletion_protection": "google.protobuf.BoolValue"
}

Field

Description

cluster_id

string

Required field. ID of the PostgreSQL cluster to update a database in.
To get the cluster ID use a ClusterService.List request.

database_name

string

Required field. Name of the database to update.
To get the name of the database use a DatabaseService.List request.

new_database_name

string

Optional. New name of the database.

update_mask

google.protobuf.FieldMask

Field mask that specifies which fields of the Database resource should be updated.

extensions[]

Extension

PostgreSQL extensions that should be enabled for the database.

If the field is sent, the list of enabled extensions is rewritten entirely.
Therefore, to disable an active extension you should simply send the list omitting this extension.

deletion_protection

google.protobuf.BoolValue

Deletion Protection inhibits deletion of the database

Default value: unspecified (inherits cluster's deletion_protection)

Extension

Field

Description

name

string

Name of the extension, e.g. pg_trgm or pg_btree.
Extensions supported by Managed Service for PostgreSQL are listed in the Developer's Guide.

version

string

Version of the extension.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string",
    "database_name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "name": "string",
    "cluster_id": "string",
    "owner": "string",
    "lc_collate": "string",
    "lc_ctype": "string",
    "extensions": [
      {
        "name": "string",
        "version": "string"
      }
    ],
    "template_db": "string",
    "deletion_protection": "google.protobuf.BoolValue"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateDatabaseMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Database

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateDatabaseMetadata

Field

Description

cluster_id

string

ID of the PostgreSQL cluster where a database is being updated.

database_name

string

Name of the PostgreSQL database that is being updated.

Database

A PostgreSQL Database resource. For more information, see
the Developer's Guide.

Field

Description

name

string

Name of the database.

cluster_id

string

ID of the PostgreSQL cluster that the database belongs to.

owner

string

Name of the user assigned as the owner of the database.

lc_collate

string

POSIX locale for string sorting order.
Can only be set at creation time.

lc_ctype

string

POSIX locale for character classification.
Can only be set at creation time.

extensions[]

Extension

PostgreSQL extensions enabled for the database.

template_db

string

Name of the database template.

deletion_protection

google.protobuf.BoolValue

Deletion Protection inhibits deletion of the database

Default value: unspecified (inherits cluster's deletion_protection)

Extension

Field

Description

name

string

Name of the extension, e.g. pg_trgm or pg_btree.
Extensions supported by Managed Service for PostgreSQL are listed in the Developer's Guide.

version

string

Version of the extension.
Previous
Create
Next
Delete