Updating Greenplum® cluster settings

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the name and description of a Greenplum® cluster:

1. View the current name and description of the cluster:

   yc managed-greenplum cluster get <cluster_name_or_ID>
   

2. See the description of the CLI command for updating the cluster configuration:

   yc managed-greenplum cluster update --help
   

3. Enter a new name and description for the cluster:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --new-name <new_cluster_name> \
      --description <new_cluster_description>
   

To update the cluster description:

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see Creating clusters.

   For a complete list of configurable Greenplum® cluster fields, refer to the Terraform provider guides.

2. In the Greenplum® cluster description, change the description attribute value:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     name        = "<cluster_name>"
     description = "<new_cluster_description>"
     ...
   }
   

3. Check if the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "name,description",
                 "name": "<new_cluster_name>",
                 "description": "<new_cluster_description>"
               }'
   

   Where updateMask is a comma-separated list of settings you want to update.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ "name", "description" ]
             },
             "name": "<new_cluster_name>",
             "description": "<new_cluster_description>" 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where update_mask is the list of parameters to update as an array of strings (paths[]).

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

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the public access setting Greenplum®:

1. See the description of the CLI command for updating the cluster configuration:

   yc managed-greenplum cluster update --help
   

2. Configure public access in the --assign-public-ip parameter:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --assign-public-ip=<enable_public_access_to_cluster>
   

   Where assign-public-ip is public access to the cluster, true or false.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "config.assignPublicIp",
                 "config": {
                   "assignPublicIp": <enable_public_access_to_cluster_hosts>
                 }
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

     Here, we provide only one setting.

   • assignPublicIp: Public access to cluster hosts, true or false.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ "config.assign_public_ip" ]
             },
             "config": {
               "assign_public_ip": <enable_public_access_to_cluster_hosts> 
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • assign_public_ip: Public access to cluster hosts, true or false.

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

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change additional cluster settings:

1. See the description of the CLI command for updating a cluster:

   yc managed-greenplum cluster update --help
   

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

   yc managed-greenplum cluster update <cluster_name_or_ID> \
       --backup-window-start <backup_start_time> \
       --datalens-access=<allow_access_from_DataLens> \
       --yandexquery-access=<allow_access_from_Yandex_Query> \
       --maintenance-window type=<maintenance_type>,`
                           `day=<day_of_week>,`
                           `hour=<hour> \
       --websql-access=<allow_access_from_WebSQL> \
       --deletion-protection
   

You can update 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: Access to the cluster from Yandex DataLens, true or false.

• --yandexquery-access: Access to the cluster from Yandex Query, true or false.

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

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

  • anytime: At any time (default).
  • weekly: On a schedule. For this value, also specify the following:
    • day: Day of week, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour of day (UTC), from 1 to 24.

• --deletion-protection: Cluster protection from accidental deletion, true or false.

  Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

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

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see Creating clusters.

   For a complete list of configurable Greenplum® cluster fields, refer to the Terraform provider guides.

2. In the Greenplum® cluster description, edit the required additional settings:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     backup_window_start {
       hours = <backup_period_start>
     }
   
     maintenance_window {
       type = <maintenance_type>
       day  = <day_of_week>
       hour = <hour>
     }
   
     access {
       data_lens    = <allow_access_from_DataLens>
       yandex_query = <allow_access_from_Yandex_Query>
     }
   
     deletion_protection = <protect_cluster_from_deletion>
   
     cloud_storage {
       enable = <use_hybrid_storage>
     }
   
     pooler_config {
       pooling_mode             = <operation_mode>
       pool_size                = <size>
       pool_client_idle_timeout = <client_timeout>
     }
   }
   

   You can update the following settings:

   • backup_window_start.hours: Start of the period for initiating cluster backup. It is set in UTC in HH format: from 0 to 23.

   • maintenance_window: Maintenance window settings (including for disabled clusters):

     • type: Maintenance type. The possible values include:
       • ANYTIME: Any time.
       • WEEKLY: On schedule.
     • day: Day of week in DDD format for the WEEKLY type, e.g., MON.
     • hour: Time of day (UTC) in HH format for the WEEKLY type, such as 21.

   • access.data_lens: Access to the cluster from Yandex DataLens, true or false.

   • access.yandex_query: Access to the cluster from Yandex Query, true or false.

   • deletion_protection: Cluster protection against accidental deletion, true or false.

     Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

   • cloud_storage.enable: Use of hybrid storage.

     Set to true to enable hybrid storage. You cannot disable hybrid storage after you save your cluster settings.

     When hybrid storage is enabled, you can use the Yezzey extension to move part of your AO and AOCO tables from the cluster storage to a cold storage, and vice versa.

     Cold storage is a convenient option if you need to store your table data for a long time without using it much. This will make data storage less costly.

     Note

     This feature is at the Preview stage and is free of charge.

   • pooler_config: Connection pooler settings:

     • pooling_mode: Operation mode, SESSION or TRANSACTION.
     • pool_size: Maximum number of client connections.
     • pool_client_idle_timeout: Idle timeout for a client connection (in seconds).

3. Check if the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Create a file named body.json and paste the following code into it:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   {
     "updateMask": "config.backupWindowStart,config.access.dataLens,config.access.yandexQuery,maintenanceWindow,deletionProtection,configSpec.pool.mode,configSpec.pool.size,configSpec.pool.clientIdleTimeout,cloudStorage",
     "config": {
       "backupWindowStart": {
         "hours": "<hours>",
         "minutes": "<minutes>",
         "seconds": "<seconds>",
         "nanos": "<nanoseconds>"
       },
       "access": {
         "dataLens": <allow_access_from_DataLens>,
         "yandexQuery": <allow_access_from_Yandex_Query>
       }
     },
     "maintenanceWindow": {
       "weeklyMaintenanceWindow": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },
     "deletionProtection": <protect_cluster_from_deletion>,
     "configSpec": {
       "pool": {
         "mode": "<operation_mode>",
         "size": "<number_of_client_connections>",
         "clientIdleTimeout": "<client_timeout>"
       }
     },
     "cloudStorage": {
       "enable": <use_hybrid_storage>
     }
   }
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • config: Cluster settings:

     • backupWindowStart: Backup window settings.

       Here, specify the backup start time:

       • hours: Between 0 and 23 hours.
       • minutes: Between 0 and 59 minutes.
       • seconds: Between 0 and 59 seconds.
       • nanos: Between 0 and 999999999 nanoseconds.

     • access: Cluster settings for access to the following Yandex Cloud services:

       • dataLens: Yandex DataLens, true or false.
       • yandexQuery: Yandex Query, true or false.

   • maintenanceWindow: Maintenance window settings, including those for disabled clusters. Provide one of the two parameters:

     • anytime: Maintenance takes place at any time.

     • weeklyMaintenanceWindow: Maintenance takes place once a week at the specified time:

       • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Time of day (UTC), from 1 to 24.

   • deletionProtection: Cluster protection against accidental deletion, true or false.

     Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

   • configSpec.pool: Connection pooler settings:

     • mode: Operation mode, SESSION or TRANSACTION.
     • size: Maximum number of client connections.
     • clientIdleTimeout: Idle timeout for a client connection (in seconds).

   • cloudStorage.enable: Use of hybrid storage in clusters with Greenplum® 6.25 or higher. Set it to true to enable the Yandex Cloud Yezzey extension in your cluster. This extension is used to export AO and AOCO tables from disks within the Greenplum® cluster to a cold storage in Yandex Object Storage. This way, the data will be stored in a service bucket compressed and encrypted. This is a more cost-efficient storage method.

     You cannot disable hybrid storage after you save your cluster settings.

     Note

     This feature is at the Preview stage and is free of charge.

3. Call the Cluster.Update method, e.g., via the following cURL request:

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data "@body.json"
   

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

4. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Create a file named body.json and paste the following code into it:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   {
     "cluster_id": "<cluster_ID>"
     "update_mask": {
       "paths": [
         "config.backup_window_start",
         "config.access.data_lens",
         "config.access.yandex_query",
         "maintenance_window",
         "deletion_protection",
         "config_spec.pool.mode",
         "config_spec.pool.size",
         "config_spec.pool.client_idle_timeout",
         "cloud_storage"
       ]
     },
     "config": {
       "backup_window_start": {
         "hours": "<hours>",
         "minutes": "<minutes>",
         "seconds": "<seconds>",
         "nanos": "<nanoseconds>"
       },
       "access": {
         "data_lens": <allow_access_from_DataLens>,
         "yandex_query": <allow_access_from_Yandex_Query>
       }
     },
     "maintenance_window": {
       "weekly_maintenance_window": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },
     "deletion_protection": <protect_cluster_from_deletion>,
     "config_spec": {
       "pool": {
         "mode": "<operation_mode>",
         "size": "<number_of_client_connections>",
         "client_idle_timeout": "<client_timeout>"
       }
     },
     "cloud_storage": {
       "enable": <use_hybrid_storage>
     }
   }
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

   • config: Cluster settings:

     • backup_window_start: Backup window settings.

       Here, specify the backup start time:

       • hours: Between 0 and 23 hours.
       • minutes: Between 0 and 59 minutes.
       • seconds: Between 0 and 59 seconds.
       • nanos: Between 0 and 999999999 nanoseconds.

     • access: Cluster settings for access to the following Yandex Cloud services:

       • data_lens: Yandex DataLens, true or false.
       • yandex_query: Yandex Query, true or false.

   • maintenance_window: Maintenance window settings, including those for disabled clusters. Provide one of the two parameters:

     • anytime: Maintenance takes place at any time.

     • weekly_maintenance_window: Maintenance takes place once a week at the specified time:

       • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Time of day (UTC), from 1 to 24.

   • deletion_protection: Cluster protection against accidental deletion, true or false.

     Even with deletion protection enabled, one can still connect to the cluster manually and delete the data.

   • config_spec.pool: Connection pooler settings:

     • mode: Operation mode, SESSION or TRANSACTION.
     • size: Maximum number of client connections.
     • client_idle_timeout: Idle timeout for a client connection (in seconds).

   • cloud_storage.enable: Use of hybrid storage in clusters with Greenplum® 6.25 or higher. Set it to true to enable the Yandex Cloud Yezzey extension in your cluster. This extension is used to export AO and AOCO tables from disks within the Greenplum® cluster to a cold storage in Yandex Object Storage. This way, the data will be stored in a service bucket compressed and encrypted. This is a more cost-efficient storage method.

     You cannot disable hybrid storage after you save your cluster settings.

     Note

     This feature is at the Preview stage and is free of charge.

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

4. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d @ \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update \
       < body.json
   

5. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.backgroundActivities.analyzeAndVacuum.start,configSpec.backgroundActivities.analyzeAndVacuum.analyzeTimeout,configSpec.backgroundActivities.analyzeAndVacuum.vacuumTimeout",
                 "configSpec": {
                   "backgroundActivities": {
                     "analyzeAndVacuum": {
                       "start": {
                         "hours": "<operation_start_hour>",
                         "minutes": "<operation_start_minute>"
                       },
                       "analyzeTimeout": "<ANALYZE_operation_duration>",
                       "vacuumTimeout": "<VACUUM_operation_duration>"
                     }
                   }
                 }
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • configSpec.backgroundActivities.analyzeAndVacuum: Background process management settings:

     • start.hours: Start hour of the VACUUM operation in UTC. The values range from 0 to 23, the default one is 19.
     • start.minutes: Start minute of the VACUUM operation in UTC. The values range from 0 to 59, the default one is 0.
     • analyzeTimeout: Maximum duration of the ANALYZE operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the ANALYZE operation will be forced to terminate.
     • vacuumTimeout: Maximum duration of the VACUUM operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the VACUUM operation will be forced to terminate.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "config_spec.background_activities.analyze_and_vacuum.start",
                 "config_spec.background_activities.analyze_and_vacuum.analyze_timeout",
                 "config_spec.background_activities.analyze_and_vacuum.vacuumTimeout"
               ]
             },
             "config_spec": {
               "background_activities": {
                 "analyze_and_vacuum": {
                   "start": {
                     "hours": "<operation_start_hour>",
                     "minutes": "<operation_start_minute>"
                   },
                   "analyze_timeout": "<ANALYZE_operation_duration>",
                   "vacuum_timeout": "<VACUUM_operation_duration>"
                 }
               }
             } 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

   • config_spec.background_activities.analyze_and_vacuum: Background process management settings:

     • start.hours: Start hour of the VACUUM operation in UTC. The values range from 0 to 23, the default one is 19.
     • start.minutes: Start minute of the VACUUM operation in UTC. The values range from 0 to 59, the default one is 0.
     • analyze_timeout: Maximum duration of the ANALYZE operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the ANALYZE operation will be forced to terminate.
     • vacuum_timeout: Maximum duration of the VACUUM operation, in seconds. The values range from 7200 to 86399, the default one is 36000. As soon as this period expires, the VACUUM operation will be forced to terminate.

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

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the Greenplum® DBMS settings:

1. View the full list of cluster settings:

   yc managed-greenplum cluster get <cluster_name_or_ID>
   

2. See the description of the CLI command for updating the cluster configuration:

   yc managed-greenplum cluster update-config --help
   

3. Set the parameter values as needed:

   All supported parameters are listed in the request format for the update method, in the greenplumConfig_<Greenplum_version> field. To specify a parameter name in the CLI call, convert its name from lowerCamelCase to snake_case. For example, convert the maxConnections parameter from an API request to max_connections for the CLI command:

   yc managed-greenplum cluster update-config <cluster_name_or_ID> \
      --set <parameter1_name>=<value1>,<parameter2_name>=<value2>,...
   

   Yandex MPP Analytics for PostgreSQL will start updating the cluster settings.

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see Creating clusters.

   For a complete list of configurable Greenplum® cluster fields, refer to the Terraform provider guides.

2. In the cluster description, edit the Greenplum® settings under greenplum_config:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     greenplum_config = {
       max_connections         = <maximum_number_of_connections>
       gp_workfile_compression = <true_or_false>
       ...
     }
   }
   

3. Check if the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.greenplumConfig_<Greenplum®_version>.<setting_1>,...,configSpec.greenplumConfig_<Greenplum®_version>.<setting_N>",
                 "configSpec": {
                   "greenplumConfig_<Greenplum®_version>": {
                     "<setting_1>": "<value_1>",
                     "<setting_2>": "<value_2>",
                     ...
                     "<setting_N>": "<value_N>"
                   }
                 }
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

     List all Greenplum® settings you want to update.

   • configSpec.greenplumConfig_<Greenplum®_version>: Greenplum® settings. Enter each setting on a new line, separated by commas.

     See the method description for the list of Greenplum® versions available for this parameter. See Cluster-level DBMS settings for descriptions and possible values of the settings.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "config_spec.greenplum_config_<Greenplum®_version>.<setting_1>",
                 "config_spec.greenplum_config_<Greenplum®_version>.<setting_2>",
                 ...
                 "config_spec.greenplum_config_<Greenplum®_version>.<setting_N>"
               ]
             },
             "config_spec": {
               "greenplum_config_<Greenplum®_version>": {
                 "<setting_1>": "<value_1>",
                 "<setting_2>": "<value_2>",
                 ...
                 "<setting_N>": "<value_N>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     List all Greenplum® settings you want to update.

   • config_spec.greenplum_config_<Greenplum®_version>: Greenplum® settings. Enter each setting on a new line, separated by commas.

     See the method description for the list of Greenplum® versions available for this parameter. See Greenplum® settings for descriptions and possible values of the settings.

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

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the host class for a cluster:

1. View the description of the CLI command for updating a cluster:

   yc managed-greenplum cluster update --help
   

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

   • For master hosts:

     yc managed-greenplum resource-preset list master
     

   • For segment hosts:

     yc managed-greenplum resource-preset list segment
     

   +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+
   |     ID      |            ZONE IDS            |           DISK TYPES           | CORES |  MEMORY  | HOST COUNT DIVIDER | MAX SEGMENT IN HOST |
   +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+
   | i2.2xlarge  | ru-central1-a, ru-central1-b   | local-ssd,                     |    16 | 128.0 GB |                  1 |                   0 |
   |             |                                | network-ssd-nonreplicated      |       |          |                    |                     |
   | ...                                                                                                                                         |
   +-------------+--------------------------------+--------------------------------+-------+----------+--------------------+---------------------+
   

3. Specify the relevant classes in the cluster update command:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
       --master-config resource-id=<master_host_class_ID> \
       --segment-config resource-id=<segment_host_class_ID>
   

   Yandex MPP Analytics for PostgreSQL will run the update host class command for the cluster.

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see Creating clusters.

   For a complete list of configurable Greenplum® cluster fields, refer to the Terraform provider guides.

2. In the Greenplum® cluster description, edit the value of the resource_preset_id attribute under master_subcluster.resources or segment_subcluster.resources:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     master_subcluster {
       resources {
         resource_preset_id = "<host_class>"
         ...
       }
     }
     segment_subcluster {
       resources {
         resource_preset_id = "<host_class>"
         ...
       }
     }
   }
   

3. Check if the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "masterConfig.resources.resourcePresetId,segmentConfig.resources.resourcePresetId",
                 "masterConfig": {
                   "resources": {
                     "resourcePresetId": "<host_class>"
                   }
                 },
                 "segmentConfig": {
                   "resources": {
                     "resourcePresetId": "<host_class>"
                   }
                 }
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • masterConfig.resources.resourcePresetId and segmentConfig.resources.resourcePresetId: New host class for master and segment hosts.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "master_config.resources.resource_preset_id",
                 "segment_config.resources.resource_preset_id"
               ]
             },
             "master_config": {
               "resources": {
                 "resource_preset_id": "<host_class>"
               }
             },
             "segment_config": {
               "resources": {
                 "resource_preset_id": "<host_class>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings to update as an array of paths[] strings.

   • master_config.resources.resource_preset_id and segment_config.resources.resource_preset_id: New host class for master and segment hosts.

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

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To increase your cluster storage size:

1. View the description of the CLI command for updating a cluster:

   yc managed-greenplum cluster update --help
   

2. Specify the required storage size for master or segment hosts in the cluster update command (at least as large as disk_size in the cluster properties):

   yc managed-mysql cluster update <cluster_name_or_ID> \
      --master-config disk-size <storage_size_in_GB> \
      --segment-config disk-size <storage_size_in_GB>
   

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see Creating clusters.

   For a complete list of configurable Greenplum® cluster fields, refer to the Terraform provider guides.

2. In the Greenplum® cluster description, edit the values of the disk_type_id and disk_size attributes under master_subcluster.resources or segment_subcluster.resources:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     master_subcluster {
       resources {
         disk_type_id = "<disk_type>"
         disk_size    = <storage_size_in_GB>
         ...
       }
     }
     segment_subcluster {
       resources {
         disk_type_id = "<disk_type>"
         disk_size    = <storage_size_in_GB>
         ...
       }
     }
   }
   

3. Check if the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "masterConfig.resources.diskTypeId,masterConfig.resources.diskSize,segmentConfig.resources.diskTypeId,segmentConfig.resources.diskSize",
                 "masterConfig": {
                   "resources": {
                     "diskTypeId": "<disk_type>",
                     "diskSize": "<storage_size_in_bytes>"
                   }
                 },
                 "segmentConfig": {
                   "resources": {
                     "diskTypeId": "<disk_type>",
                     "diskSize": "<storage_size_in_bytes>"
                   }
                 }
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • masterConfig.resources, segmentConfig.resources: Storage properties for master hosts and segment hosts:

     • diskTypeId: Disk type.
     • diskSize: New storage size, in bytes.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "master_config.resources.disk_type_id",
                 "master_config.resources.disk_size",
                 "segment_config.resources.disk_type_id",
                 "segment_config.resources.disk_size"
               ]
             },
             "master_config": {
               "resources": {
                 "disk_type_id": "<disk_type>",
                 "disk_size": "<storage_size_in_bytes>"
               }
             },
             "segment_config": {
               "resources": {
                 "disk_type_id": "<disk_type>",
                 "disk_size": "<storage_size_in_bytes>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings to update as an array of paths[] strings.

   • master_config.resources, segment_config.resources: Storage properties for master hosts and segment hosts:

     • disk_type_id: Disk type.
     • disk_size: New storage size, in bytes.

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

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the ID of the cluster service account:

1. See the description of the CLI command for updating the cluster configuration:

   yc managed-greenplum cluster update --help
   

2. Specify the service account ID:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --service-account <service_account_ID>
   

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see Creating clusters.

   For a complete list of configurable Greenplum® cluster fields, refer to the Terraform provider guides.

2. In the Greenplum® cluster description, change the service_account_id attribute value:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     service_account_id = "<service_account_ID>"
     ...
   }
   

3. Check if the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "serviceAccountId",
                 "serviceAccountId": "<service_account_ID>"
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

     Here, we provide only one setting.

   • serviceAccountId: Service account ID.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ "service_account_id" ]
             },
             "service_account_id": "<service_account_ID>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • service_account_id: Service account ID.

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

4. Check the server response to make sure your request was successful.

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change logging settings:

1. See the description of the CLI command for updating the cluster configuration:

   yc managed-greenplum cluster update --help
   

2. Specify the logging settings to update in the update cluster command:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --log-enabled \
      --log-command-center-enabled \
      --log-greenplum-enabled \
      --log-pooler-enabled \
      --log-folder-id <folder_ID>
   

   Where:

   • --log-enabled: Enables log transfer. Required for other flags responsible for transferring specific logs, e.g., --log-greenplum-enabled.

   • --log-command-center-enabled: Transferring Command Center logs.

   • --log-greenplum-enabled: Transferring Greenplum® logs.

   • --log-pooler-enabled: Transferring connection pooler logs.

   • --log-folder-id: Specify the ID of the folder whose log group you want to use.

   • --log-group-id: ID of the log group to write logs to.

     Specify either --log-folder-id or --log-group-id.

1. Open the current Terraform configuration file describing your infrastructure.

   For more information about creating this file, see Creating clusters.

   For a complete list of configurable Greenplum® cluster fields, refer to the Terraform provider guides.

2. In the Greenplum® cluster description, update the attribute values in the logging section:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     logging {
       enabled                = <enable_transferring_logs>
       command_center_enabled = <transfer_Yandex_Command_Center_logs>
       greenplum_enabled      = <transfer_Greenplum®_logs>
       pooler_enabled         = <transfer_connection_pooler_logs>
       folder_id              = "<folder_ID>"
     }
   }
   

   Where:

   • enabled: Manages log transfer, true or false. To enable parameters responsible for transferring specific logs, provide the true value.

   • command_center_enabled: Transferring Command Center logs, true or false.

   • greenplum_enabled: Transferring Greenplum® logs, true or false.

   • pooler_enabled: Transferring connection pooler logs, true or false.

   • folder_id: Specify the ID of the folder whose log group you want to use.

   • log_group_id: ID of the log group to write logs to.

     Specify either folder_id or log_group_id.

3. Check if the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Warning

   The Terraform provider limits the amount of time for all Yandex MPP Analytics for PostgreSQL cluster operations to complete to 120 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_greenplum_cluster" "<cluster name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "logging.enabled,logging.commandCenterEnabled,logging.greenplumEnabled,logging.poolerEnabled,logging.folderId",
                 "logging": {
                   "enabled": "<enable_transferring_logs>",
                   "commandCenterEnabled": "<transfer_Yandex_Command_Center_logs>",
                   "greenplumEnabled": "<transfer_Greenplum®_logs>",
                   "poolerEnabled": "<transfer_connection_pooler_logs>",
                   "folderId": "<folder_ID>"
                 }
               }'
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • logging: Logging settings:

     • enabled: Manages log transfer, true or false. To enable parameters responsible for transferring specific logs, provide the true value.

     • commandCenterEnabled: Transferring Command Center logs, true or false.

     • greenplumEnabled: Transferring Greenplum® logs, true or false.

     • poolerEnabled: Transferring connection pooler logs, true or false.

     • folderId: Specify the ID of the folder whose log group you want to use.

     • logGroupId: ID of the log group to write logs to.

       Specify either folderId or logGroupId.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/greenplum/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [ 
                 "logging.enabled",
                 "logging.command_center_enabled",
                 "logging.greenplum_enabled",
                 "logging.pooler_enabled",
                 "logging.folder_id"
               ]
             },
             "logging": {
               "enabled": "<enable_transferring_logs>",
               "command_center_enabled": "<transfer_Yandex_Command_Center_logs>",
               "greenplum_enabled": "<transfer_Greenplum®_logs>",
               "pooler_enabled": "<transfer_connection_pooler_logs>",
               "folder_id": "<folder_ID>"
             } 
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

   • logging: Logging settings:

     • enabled: Manages log transfer, true or false. To enable parameters responsible for transferring specific logs, provide the true value.

     • command_center_enabled: Transferring Command Center logs, true or false.

     • greenplum_enabled: Transferring Greenplum® logs, true or false.

     • pooler_enabled: Transferring connection pooler logs, true or false.

     • folder_id: Specify the ID of the folder whose log group you want to use.

     • log_group_id: ID of the log group to write logs to.

       Specify either folder_id or log_group_id.

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

4. View the server response to make sure your request was successful.