Managed Service for PostgreSQL API, gRPC: DatabaseService.Update
Updates the specified PostgreSQL database.
gRPC request
rpc Update (UpdateDatabaseRequest) returns (operation.Operation)
UpdateDatabaseRequest
{
"clusterId": "string",
"databaseName": "string",
"newDatabaseName": "string",
"updateMask": "google.protobuf.FieldMask",
"extensions": [
{
"name": "string",
"version": "string"
}
],
"deletionProtection": "google.protobuf.BoolValue"
}
Field |
Description |
clusterId |
string Required field. ID of the PostgreSQL cluster to update a database in. |
databaseName |
string Required field. Name of the database to update. |
newDatabaseName |
string Optional. New name of the database. |
updateMask |
Field mask that specifies which fields of the Database resource should be updated. |
extensions[] |
PostgreSQL extensions that should be enabled for the database. If the field is sent, the list of enabled extensions is rewritten entirely. |
deletionProtection |
Deletion Protection inhibits deletion of the database Default value: |
Extension
Field |
Description |
name |
string Name of the extension, e.g. |
version |
string Version of the extension. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "string",
"databaseName": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"name": "string",
"clusterId": "string",
"owner": "string",
"lcCollate": "string",
"lcCtype": "string",
"extensions": [
{
"name": "string",
"version": "string"
}
],
"templateDb": "string",
"deletionProtection": "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. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateDatabaseMetadata
Field |
Description |
clusterId |
string ID of the PostgreSQL cluster where a database is being updated. |
databaseName |
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. |
clusterId |
string ID of the PostgreSQL cluster that the database belongs to. |
owner |
string Name of the user assigned as the owner of the database. |
lcCollate |
string POSIX locale for string sorting order. |
lcCtype |
string POSIX locale for character classification. |
extensions[] |
PostgreSQL extensions enabled for the database. |
templateDb |
string Name of the database template. |
deletionProtection |
Deletion Protection inhibits deletion of the database Default value: |
Extension
Field |
Description |
name |
string Name of the extension, e.g. |
version |
string Version of the extension. |