Skip to main content

Update

Updates the specified PostgreSQL database.

import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Database = cloudApi.mdb.clickhouse_database.Database;
const UpdateDatabaseRequest =
cloudApi.mdb.postgresql_database_service.UpdateDatabaseRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.DatabaseServiceClient);

const operation = await client.update(
UpdateDatabaseRequest.fromPartial({
clusterId: "clusterId",
databaseName: "databaseName",
// newDatabaseName: "newDatabaseName",
// updateMask: {
// paths: ["paths"]
// },
// extensions: [{
// name: "name",
// version: "version"
// }],
// deletionProtection: {
// value: true
// }
})
);
const finishedOp = await waitForOperation(operation, session);

if (finishedOp.response) {
const result = decodeMessage<typeof Database>(finishedOp.response);
console.log(result);
}
})();

UpdateDatabaseRequest​

clusterId : string​

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

databaseName : string​

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

newDatabaseName : string​

Optional. New name of the database.

updateMask : 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.

deletionProtection : google.protobuf.BoolValue​

Deletion Protection inhibits deletion of the database

Default value: unspecified (inherits cluster's deletion_protection)

Extension​

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​

An Operation resource. For more information, see Operation.

id : string​

ID of the operation.

description : string​

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp​

Creation timestamp.

createdBy : string​

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

modifiedAt : 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 : google.protobuf.Any​

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.

One of result​

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.

  • error : google.rpc.Status​

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

  • response : google.protobuf.Any​
    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.