Updating PostgreSQL cluster settings

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the host class for the cluster:

1. View a description of the update cluster CLI command:

   yc managed-postgresql cluster update --help
   

2. Request a list of available host classes (the ZONE IDS column specifies the availability zones where you can select the appropriate class):

   yc managed-postgresql resource-preset list
   

   +-----------+--------------------------------+-------+----------+
   |    ID     |            ZONE IDS            | CORES |  MEMORY  |
   +-----------+--------------------------------+-------+----------+
   | s1.micro  | ru-central1-a, ru-central1-b,  |     2 | 8.0 GB   |
   |           | ru-central1-d                  |       |          |
   | ...                                                           |
   +-----------+--------------------------------+-------+----------+
   

3. Specify the class in the update cluster command:

   yc managed-postgresql cluster update <cluster_name_or_ID> \
       --resource-preset <host_class_ID>
   

   Managed Service for PostgreSQL will run the update host class command for the cluster.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about how to create this file, see Creating clusters.

   For a complete list of available Managed Service for PostgreSQL cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for PostgreSQL cluster description, change the resource_preset_id attribute value under config.resources:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       resources {
         resource_preset_id = "<host_class>"
         ...
       }
     }
   }
   

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoring from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To change the class of cluster hosts, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• Host class ID in the configSpec.resources.resourcePresetId parameter. To request a list of supported values, use the list method for the ResourcePreset resources.
• List of settings to update (in this case, configSpec.resources.resourcePresetId) in the updateMask parameter.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To update the PostgreSQL settings:

1. View the full list of settings specified for the cluster:

   yc managed-postgresql cluster get <cluster_name_or_ID> --full
   

2. View a description of the update cluster configuration CLI command:

   yc managed-postgresql cluster update-config --help
   

3. Set the required parameter values:

   All supported parameters are listed in the request format for the update method, in the postgresqlConfig_<PostgreSQL_version> field. To specify a parameter name in the CLI call, convert the name from lowerCamelCase to snake_case. For example, the maxPreparedTransactions parameter from an API call should be converted to max_prepared_transactions for the CLI command:

   yc managed-postgresql cluster update-config <cluster_name_or_ID> \
      --set <name_of_parameter_1>=<value_1>,<name_of_parameter_2>=<value_2>,...
   

   Managed Service for PostgreSQL runs the update cluster settings operation.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about how to create this file, see Creating clusters.

   For a complete list of available Managed Service for PostgreSQL cluster configuration fields, see the Terraform provider documentation.

2. In the Managed Service for PostgreSQL cluster description, change the values of the parameters under config.postgresql_config. If there is no such section, create one.

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       ...
       postgresql_config = {
         max_connections                   = <maximum_number_of_connections>
         enable_parallel_hash              = <true_or_false>
         vacuum_cleanup_index_scale_factor = <number_from_0_to_1>
         ...
       }
     }
   }
   

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoring from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To change PostgreSQL server settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• Required setting values in the configSpec.postgresqlConfig_<PostgreSQL_version> parameter.
• List of settings to update, in the updateMask parameter.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change additional cluster settings:

1. View a description of the update cluster CLI command:

   yc managed-postgresql cluster update --help
   

2. Run the following command with a list of settings to update:

   yc managed-postgresql cluster update <cluster_name_or_ID> \
       --backup-window-start <backup_start_time> \
       --datalens-access=<true_or_false> \
       --maintenance-window type=<maintenance_type>,`
                           `day=<day_of_week>,`
                           `hour=<hour> \
       --websql-access=<true_or_false> \
       --deletion-protection=<deletion_protection> \
       --connection-pooling-mode=<connection_pooler_mode> \
       --serverless-access=<true_or_false> \
       --yandexquery-access=<access_through_Query> \
       --performance-diagnostics enabled=<true_or_false>,`
                                `sessions-sampling-interval=<session_sampling_interval>,`
                                `statements-sampling-interval=<statement_sampling_interval>
   

You can change the following settings:

• --backup-window-start: The cluster backup start time, set in UTC format HH:MM:SS. If the time is not set, the backup will start at 22:00 UTC.

• --datalens-access: Enables DataLens access. The default value is false. For more information on setting up a connection, see Connecting to a cluster from DataLens.

• --maintenance-window: Maintenance window settings (including for disabled clusters), where type is the maintenance type:

  • anytime (default): Any time.
  • weekly: On a schedule. If setting this value, specify the day of week and the hour:
    • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour (UTC) in HH format: 1 to 24.

• --websql-access: Enables you to run SQL queries to cluster databases from the Yandex Cloud management console using Yandex WebSQL. The default value is false.

• --serverless-access: Enables cluster access from Yandex Cloud Functions. The default value is false. For more information about setting up access, see the Cloud Functions documentation.

• --yandexquery-access: Enables cluster access from Yandex Query. This feature is at the Preview stage and available upon request.

• --autofailover manages automatic master change setup. To learn more, see Replication. The default value is true.

• --connection-pooling-mode: Specifies the connection pooler mode (SESSION, TRANSACTION, or STATEMENT).

• --deletion-protection: Protection of the cluster, its databases, and users against accidental deletion, true or false.

  By default, the parameter inherits its value from the cluster when creating users and databases. You can also set the value manually; for more information, see the User management and Database management sections.

  If the parameter is changed on a running cluster, only users and databases with the Same as cluster protection will inherit the new value.

  Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

• --performance-diagnostics: Statistics collection settings:

  • enabled: true value enables statistics collection. The default value is false.
  • sessions-sampling-interval: Session sampling interval, seconds. Acceptable values are between 1 and 86400.
  • statements-sampling-interval: Statement sampling interval, seconds. Acceptable values are between 60 and 86400.

You can retrieve the cluster name with a list of clusters in the folder.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about how to create this file, see Creating clusters.

   For a complete list of available Managed Service for PostgreSQL cluster configuration fields, see the Terraform provider documentation.

2. To change the backup start time, add a block named config.backup_window_start to the Managed Service for PostgreSQL cluster description.

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       backup_window_start {
         hours   = <hour_of_backup_start_time>
         minutes = <minute_of_backup_start_time>
       }
       ...
     }
   }
   

3. To enable access from Yandex DataLens and allow execution of SQL queries from the management console using Yandex WebSQL, change the values of the appropriate fields in the config.access section:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       access {
         data_lens = <access_from_DataLens>
         web_sql   = <execution_of_SQL_queries_from_management_console>
         ...
     }
     ...
   }
   

   Where:

   • data_lens: Access from DataLens, true or false.
   • web_sql: Execution of SQL queries from the management console using Yandex WebSQL: true or false.

4. To change the connection pooler mode, add the config.pooler_config section to the Managed Service for PostgreSQL cluster description:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       pooler_config {
         pool_discard = <Odyssey_parameter>
         pooling_mode = "<pooling_mode>"
       }
       ...
     }
   }
   

   Where:

   • pool_discard: Odyssey pool_discard parameter, true or false.
   • pooling_mode: Pooling mode: SESSION, TRANSACTION, or STATEMENT.

5. To set up the maintenance window (for disabled clusters as well), add the maintenance_window section to the cluster description:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     maintenance_window {
       type = <maintenance_type>
       day  = <day_of_week>
       hour = <hour>
     }
     ...
   }
   

   Where:

   • type: Maintenance type. The possible values include:
     • anytime: Anytime.
     • weekly: By schedule.
   • day: Day of the week for the weekly type in DDD format, e.g., MON.
   • hour: Hour of the day for the weekly type in the HH format, e.g., 21.

6. To set up statistics collection, to the config section, add the performance_diagnostics section:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       ...
       performance_diagnostics {
         enabled = <enables statistics collection: true or false>
         sessions_sampling_interval  = <sessions sampling interval>
         statements_sampling_interval = <statements sampling interval>
       }
       ...
     }
     ...
   }
   

   Where:

   • enabled: Enable statistics collection, true or false.
   • sessions_sampling_interval: Session sampling interval, from 1 to 86400 seconds.
   • statements_sampling_interval: Statement sampling interval, from 60 to 86400 seconds.

7. To enable protection of the cluster, its databases, and users against accidental deletion, add the deletion_protection field set to true to your cluster description:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     deletion_protection = <deletion_protection>
   }
   

   Where deletion_protection is the protection of the cluster, its databases, and users against deletion. It may take either the true or false value.

   By default, the parameter inherits its value from the cluster when creating users and databases. You can also set the value manually; for more information, see the User management and Database management sections.

   If the parameter is changed on a running cluster, only users and databases with the Same as cluster protection will inherit the new value.

   Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

8. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

9. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoring from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To change additional cluster settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.

• Settings for access from other services in the configSpec.access parameter.

• Backup window settings in the configSpec.backupWindowStart parameter.

• Connection pooler mode in the configSpec.poolerConfig.poolingMode parameter.

• Maintenance window settings (including for disabled clusters) in the maintenanceWindow parameter.

• Settings for protection of the cluster, its databases, and users against deletion in the deletionProtection parameter: true or false.

  By default, the parameter inherits its value from the cluster when creating users and databases. You can also set the value manually; for more information, see the User management and Database management sections.

  If the parameter is changed on a running cluster, only users and databases with the Same as cluster protection will inherit the new value.

  Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

• List of cluster configuration fields to update in the UpdateMask parameter.

To allow cluster access from Yandex Cloud Functions, set true for the configSpec.access.serverless parameter. For more information about setting up access, see the Cloud Functions documentation.

To allow cluster access from Yandex Query, set true for the configSpec.access.yandexQuery parameter. This feature is at the Preview stage and available upon request.

To enable statistics collection:

1. Pass the true value in the config.performanceDiagnostics.enabled parameter.
2. Pass the sessions sampling interval in the config.performanceDiagnostics.sessionsSamplingInterval parameter.
3. Pass the statements sampling interval in the config.performanceDiagnostics.statementsSamplingInterval parameter.

Acceptable parameter values:

• config.performanceDiagnostics.sessionsSamplingInterval: From 1 to 86400 seconds.
• config.performanceDiagnostics.statementsSamplingInterval: From 60 to 86400 seconds.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

Run this command:

yc managed-postgresql cluster start-failover <cluster_name_or_ID> \
    --host <replica_host_name>

You can request the replica host name with a list of cluster hosts and the cluster name with a list of clusters in the folder.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about how to create this file, see Creating clusters.

   For a complete list of available Managed Service for PostgreSQL cluster configuration fields, see the Terraform provider documentation.

2. In the host_master_name parameter, specify the name of the replica host to switch to.

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     host_master_name = "<replica_host_name>"
   }
   

   Where host_master_name is the name of the replica host, i.e., the name attribute of the appropriate host block.

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoring from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To switch the master host, use the startFailover REST API method for the Cluster resource or the ClusterService/StartFailover gRPC API call and provide the following in the request:

• ID of the cluster where you want to switch the master, in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• (Optional) In the hostName parameter, the name of the replica host to switch to. To find out the name, get a list of hosts in the cluster.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To move a cluster:

1. View a description of the CLI move cluster command:

   yc managed-postgresql cluster move --help
   

2. Specify the destination folder in the move cluster command:

   yc managed-postgresql cluster move <cluster_ID> \
      --destination-folder-name=<destination_folder_name>
   

   You can get the cluster ID with a list of clusters in the folder.

To move a cluster, use the move REST API method for the Cluster resource or the ClusterService/Move gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• ID of the destination folder in the destinationFolderId parameter.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To edit the list of security groups for your cluster:

1. View a description of the update cluster CLI command:

   yc managed-postgresql cluster update --help
   

2. Specify the security groups in the update cluster command:

   yc managed-postgresql cluster update <cluster_name_or_ID> \
       --security-group-ids <list_of_security_group_IDs>
   

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about how to create this file, see Creating clusters.

   For a complete list of available Managed Service for PostgreSQL cluster configuration fields, see the Terraform provider documentation.

2. Change the value of the security_group_ids parameter in the cluster description:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     security_group_ids = [ <list_of_security_group_IDs> ]
   }
   

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Time limits

   A Terraform provider sets the timeout for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoring from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

To edit the list of cluster security groups, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• List of security group IDs in the securityGroupIds parameter.
• List of settings to update (in this case, securityGroupIds) in the updateMask parameter.