Editing PXF 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 PXF settings:

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

   yc managed-greenplum cluster update --help
   

2. Specify PXF settings:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --pxf-connection-timeout=<read_queries_timeout> \
      --pxf-upload-timeout=<write_queries_timeout> \
      --pxf-max-threads=<Maximum_number_of_the_Apache_Tomcat®_threads> \
      --pxf-pool-allow-core-thread-timeout=<whether_a_timeout_for_core_streaming_threads_is_allowed> \
      --pxf-poll-core-size=<number_of_streaming_threads> \
      --pxf-pool-queue-capacity=<pool_queue_capacity_for_streaming_threads> \
      --pxf-pool-max-size=<maximum_number_of_streaming_threads> \
      --pxf-xmx=<maximum_size_of_the_JVM_heap> \
      --pxf-xms=<initial_size_of_the_JVM_heap>
   

   Where:

   • pxf-connection-timeout: Timeout for connection to the Apache Tomcat® server when making read queries, in seconds. The value range is from 5 to 600.

   • pxf-upload-timeout: Timeout for connection to the Apache Tomcat® server when making write queries, in seconds. The value range is from 5 to 600.

   • pxf-max-threads: Maximum number of the Apache Tomcat® threads. The value range is from 1 to 1024.

     To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

   • pxf-pool-allow-core-thread-timeout: Whether or not a timeout for core streaming threads is allowed. The default value is false.

   • pxf-poll-core-size: Number of core streaming threads per pool. The value range is from 1 to 1024.

   • pxf-pool-queue-capacity: Maximum number of queries you can add to a pool queue after core streaming threads. The values may range from zero upward. If 0, no pool queue is generated.

   • pxf-pool-max-size: Maximum allowed number of core streaming threads. The value range is from 1 to 1024.

   • pxf-xmx: Maximum size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

   • pxf-xms: Initial size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

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

To change the PXF settings:

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

   For more information on how to create this file, see Creating a Greenplum® cluster.

   For a complete list of Yandex MPP Analytics for PostgreSQL cluster configuration fields you can update, see this Terraform provider article.

2. In the cluster description, under pxf_config, configure the PXF settings:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     pxf_config {
       connection_timeout             = <read_queries_timeout>
       upload_timeout                 = <write_queries_timeout>
       max_threads                    = <Maximum_number_of_the_Apache_Tomcat®_threads>
       pool_allow_core_thread_timeout = <whether_a_timeout_for_core_streaming_threads_is_allowed>
       pool_core_size                 = <number_of_streaming_threads>
       pool_queue_capacity            = <pool_queue_capacity_for_streaming_threads>
       pool_max_size                  = <maximum_number_of_streaming_threads>
       xmx                            = <maximum_size_of_the_JVM_heap>
       xms                            = <initial_size_of_the_JVM_heap>
     }
   }
   

   Where:

   • connection_timeout: Timeout for connection to the Apache Tomcat® server when making read queries, in seconds. The value range is from 5 to 600.

   • upload_timeout: Timeout for connection to the Apache Tomcat® server when making write queries, in seconds. The value range is from 5 to 600.

   • max_threads: Maximum number of the Apache Tomcat® threads. The value range is from 1 to 1024.

     To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

   • pool_allow_core_thread_timeout: Whether or not a timeout for core streaming threads is allowed. The default value is false.

   • pool_core_size: Number of core streaming threads per pool. The value range is from 1 to 1024.

   • pool_queue_capacity: Maximum number of queries you can add to a pool queue after core streaming threads. The values may range from zero upward. If 0, no pool queue is generated.

   • pool_max_size: Maximum allowed number of core streaming threads. The value range is from 1 to 1024.

   • xmx: Maximum size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

   • xms: Initial size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

3. Make sure 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.

1. Get an IAM token for API authentication and set 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.pxfConfig.connectionTimeout,configSpec.pxfConfig.uploadTimeout,configSpec.pxfConfig.maxThreads,configSpec.pxfConfig.poolAllowCoreThreadTimeout,configSpec.pxfConfig.poolCoreSize,configSpec.pxfConfig.poolQueueCapacity,configSpec.pxfConfig.poolMaxSize,configSpec.pxfConfig.xmx,configSpec.pxfConfig.xms",
                 "configSpec": {
                   "pxfConfig" : {
                     "connectionTimeout": "<read_queries_timeout>",
                     "uploadTimeout": "<write_queries_timeout>",
                     "maxThreads": "<Maximum_number_of_the_Apache_Tomcat®_threads>",
                     "poolAllowCoreThreadTimeout": <whether_a_timeout_for_core_streaming_threads_is_allowed>,
                     "poolCoreSize": "<number_of_streaming_threads>",
                     "poolQueueCapacity": "<pool_queue_capacity_for_streaming_threads>",
                     "poolMaxSize": "<maximum_number_of_streaming_threads>",
                     "xmx": "<maximum_size_of_the_JVM_heap>",
                     "xms": "<initial_size_of_the_JVM_heap>"
                   }
                 }
               }'
   

   Where:

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

   • connectionTimeout: Timeout for connection to the Apache Tomcat® server when making read queries, in seconds. The value range is from 5 to 600.

   • uploadTimeout: Timeout for connection to the Apache Tomcat® server when making write queries, in seconds. The value range is from 5 to 600.

   • maxThreads: Maximum number of the Apache Tomcat® threads. The value range is from 1 to 1024.

     To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

   • poolAllowCoreThreadTimeout: Whether or not a timeout for core streaming threads is allowed. The default value is false.

   • poolCoreSize: Number of core streaming threads per pool. The value range is from 1 to 1024.

   • poolQueueCapacity: Maximum number of queries you can add to a pool queue after core streaming threads. The values may range from zero upward. If 0, no pool queue is generated.

   • poolMaxSize: Maximum allowed number of core streaming threads. The value range is from 1 to 1024.

   • xmx: Maximum size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

   • xms: Initial size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

   You can get 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 set 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. Use the ClusterService.Update call and send the following request, e.g., via gRPCurl:

   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.pxf_config.connection_timeout",
                 "config_spec.pxf_config.upload_timeout",
                 "config_spec.pxf_config.max_threads",
                 "config_spec.pxf_config.pool_allow_core_thread_timeout",
                 "config_spec.pxf_config.pool_core_size",
                 "config_spec.pxf_config.pool_queue_capacity",
                 "config_spec.pxf_config.pool_max_size",
                 "config_spec.pxf_config.xmx",
                 "config_spec.pxf_config.xms"
               ]
             },
             "config_spec": {
               "pxf_config" : {
                 "connection_timeout": "<read_queries_timeout>",
                 "upload_timeout": "<write_queries_timeout>",
                 "max_threads": "<Maximum_number_of_the_Apache_Tomcat®_threads>",
                 "pool_allow_core_thread_timeout": <whether_a_timeout_for_core_streaming_threads_is_allowed>,
                 "pool_core_size": "<number_of_streaming_threads>",
                 "pool_queue_capacity": "<pool_queue_capacity_for_streaming_threads>",
                 "pool_max_size": "<maximum_number_of_streaming_threads>",
                 "xmx": "<maximum_size_of_the_JVM_heap>",
                 "xms": "<initial_size_of_the_JVM_heap>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.greenplum.v1.ClusterService.Update
   

   Where:

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

   • connection_timeout: Timeout for connection to the Apache Tomcat® server when making read queries, in seconds. The value range is from 5 to 600.

   • upload_timeout: Timeout for connection to the Apache Tomcat® server when making write queries, in seconds. The value range is from 5 to 600.

   • max_threads: Maximum number of the Apache Tomcat® threads. The value range is from 1 to 1024.

     To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

   • pool_allow_core_thread_timeout: Whether or not a timeout for core streaming threads is allowed. The default value is false.

   • pool_core_size: Number of core streaming threads per pool. The value range is from 1 to 1024.

   • pool_queue_capacity: Maximum number of queries you can add to a pool queue after core streaming threads. The values may range from zero upward. If 0, no pool queue is generated.

   • pool_max_size: Maximum allowed number of core streaming threads. The value range is from 1 to 1024.

   • xmx: Maximum size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

   • xms: Initial size of the JVM heap for the PXF daemon, in megabytes. The value range is from 64 to 16384.

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

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