Managed Service for Greenplum® API, gRPC: ClusterService.Create

Written by

Yandex Cloud

Improved by

Tania L.

Updated at January 23, 2026

gRPC request
CreateClusterRequest
GreenplumConfig
Access
MasterSubclusterConfigSpec
Resources
SegmentSubclusterConfigSpec
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
ConfigSpec
GreenplumConfig6
ConnectionPoolerConfig
BackgroundActivitiesConfig
TableSizes
BackgroundActivityStartAt
AnalyzeAndVacuum
QueryKillerScripts
QueryKiller
PXFConfig
CloudStorage
LoggingConfig
operation.Operation
CreateClusterMetadata
Cluster
GreenplumConfig
Access
Monitoring
MasterSubclusterConfig
Resources
SegmentSubclusterConfig
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
MaintenanceOperation
ClusterConfigSet
GreenplumConfigSet6
GreenplumConfig6
ConnectionPoolerConfigSet
ConnectionPoolerConfig
BackgroundActivitiesConfig
TableSizes
BackgroundActivityStartAt
AnalyzeAndVacuum
QueryKillerScripts
QueryKiller
PXFConfigSet
PXFConfig
CloudStorage
LoggingConfig

Creates a Greenplum® cluster in the specified folder.

gRPC request

rpc Create (CreateClusterRequest) returns (operation.Operation)

CreateClusterRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "environment": "Environment",
  "config": {
    "version": "string",
    "backup_window_start": "google.type.TimeOfDay",
    "backup_retain_period_days": "google.protobuf.Int64Value",
    "access": {
      "data_lens": "bool",
      "web_sql": "bool",
      "data_transfer": "bool",
      "yandex_query": "bool"
    },
    "zone_id": "string",
    "subnet_id": "string",
    "assign_public_ip": "bool",
    "full_version": "string"
  },
  "master_config": {
    "resources": {
      "resource_preset_id": "string",
      "disk_size": "int64",
      "disk_type_id": "string"
    }
  },
  "segment_config": {
    "resources": {
      "resource_preset_id": "string",
      "disk_size": "int64",
      "disk_type_id": "string"
    }
  },
  "master_host_count": "int64",
  "segment_in_host": "int64",
  "segment_host_count": "int64",
  "user_name": "string",
  "user_password": "string",
  "network_id": "string",
  "security_group_ids": [
    "string"
  ],
  "deletion_protection": "bool",
  "host_group_ids": [
    "string"
  ],
  "maintenance_window": {
    // Includes only one of the fields `anytime`, `weekly_maintenance_window`
    "anytime": "AnytimeMaintenanceWindow",
    "weekly_maintenance_window": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  },
  "config_spec": {
    // Includes only one of the fields `greenplum_config_6`
    "greenplum_config_6": {
      "max_connections": "google.protobuf.Int64Value",
      "max_slot_wal_keep_size": "google.protobuf.Int64Value",
      "gp_workfile_limit_per_segment": "google.protobuf.Int64Value",
      "gp_workfile_limit_per_query": "google.protobuf.Int64Value",
      "gp_workfile_limit_files_per_query": "google.protobuf.Int64Value",
      "max_prepared_transactions": "google.protobuf.Int64Value",
      "gp_workfile_compression": "google.protobuf.BoolValue",
      "max_statement_mem": "google.protobuf.Int64Value",
      "log_statement": "LogStatement",
      "gp_add_column_inherits_table_setting": "google.protobuf.BoolValue",
      "gp_enable_global_deadlock_detector": "google.protobuf.BoolValue",
      "gp_global_deadlock_detector_period": "google.protobuf.Int64Value",
      "gp_max_slices": "google.protobuf.Int64Value",
      "gp_cached_segworkers_threshold": "google.protobuf.Int64Value",
      "lock_timeout": "google.protobuf.Int64Value",
      "idle_in_transaction_session_timeout": "google.protobuf.Int64Value",
      "runaway_detector_activation_percent": "google.protobuf.Int64Value",
      "gp_vmem_protect_segworker_cache_limit": "google.protobuf.Int64Value",
      "gp_enable_zstd_memory_accounting": "google.protobuf.BoolValue",
      "gp_max_plan_size": "google.protobuf.Int64Value",
      "gp_autostats_mode": "GPAutostatsMode",
      "gp_autostats_on_change_threshold": "google.protobuf.Int64Value",
      "gp_resource_group_memory_limit": "google.protobuf.DoubleValue",
      "log_connections": "google.protobuf.BoolValue",
      "log_disconnections": "google.protobuf.BoolValue",
      "log_hostname": "google.protobuf.BoolValue",
      "log_statement_stats": "google.protobuf.BoolValue",
      "log_min_duration_statement": "google.protobuf.Int64Value",
      "master_shared_buffers": "google.protobuf.Int64Value",
      "max_locks_per_transaction": "google.protobuf.Int64Value",
      "segment_shared_buffers": "google.protobuf.Int64Value",
      "log_error_verbosity": "LogErrorVerbosity",
      "log_min_messages": "LogLevelMessage"
    },
    // end of the list of possible fields
    "pool": {
      "mode": "PoolMode",
      "size": "google.protobuf.Int64Value",
      "client_idle_timeout": "google.protobuf.Int64Value",
      "idle_in_transaction_timeout": "google.protobuf.Int64Value"
    },
    "background_activities": {
      "table_sizes": {
        "starts": [
          {
            "hours": "int64",
            "minutes": "int64"
          }
        ]
      },
      "analyze_and_vacuum": {
        "start": {
          "hours": "int64",
          "minutes": "int64"
        },
        "analyze_timeout": "google.protobuf.Int64Value",
        "vacuum_timeout": "google.protobuf.Int64Value"
      },
      "query_killer_scripts": {
        "idle": {
          "enable": "google.protobuf.BoolValue",
          "max_age": "google.protobuf.Int64Value",
          "ignore_users": [
            "string"
          ]
        },
        "idle_in_transaction": {
          "enable": "google.protobuf.BoolValue",
          "max_age": "google.protobuf.Int64Value",
          "ignore_users": [
            "string"
          ]
        },
        "long_running": {
          "enable": "google.protobuf.BoolValue",
          "max_age": "google.protobuf.Int64Value",
          "ignore_users": [
            "string"
          ]
        }
      }
    },
    "pxf_config": {
      "connection_timeout": "google.protobuf.Int64Value",
      "upload_timeout": "google.protobuf.Int64Value",
      "max_threads": "google.protobuf.Int64Value",
      "pool_allow_core_thread_timeout": "google.protobuf.BoolValue",
      "pool_core_size": "google.protobuf.Int64Value",
      "pool_queue_capacity": "google.protobuf.Int64Value",
      "pool_max_size": "google.protobuf.Int64Value",
      "xmx": "google.protobuf.Int64Value",
      "xms": "google.protobuf.Int64Value"
    }
  },
  "cloud_storage": {
    "enable": "bool"
  },
  "master_host_group_ids": [
    "string"
  ],
  "segment_host_group_ids": [
    "string"
  ],
  "service_account_id": "string",
  "logging": {
    "enabled": "bool",
    // Includes only one of the fields `folder_id`, `log_group_id`
    "folder_id": "string",
    "log_group_id": "string",
    // end of the list of possible fields
    "command_center_enabled": "bool",
    "greenplum_enabled": "bool",
    "pooler_enabled": "bool"
  }
}

Field	Description
folder_id	string Required field. ID of the folder to create the Greenplum® cluster in. The maximum string length in characters is 50.
name	string Required field. Name of the Greenplum® cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
description	string Description of the Greenplum® cluster. The maximum string length in characters is 256.
labels	object (map<string, string>) Custom labels for the Greenplum® cluster as `key:value` pairs. For example, `"project":"mvp"` or `"source":"dictionary"`. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression `[-_0-9a-z]`. The maximum string length in characters for each key is 63. Each key must match the regular expression `[a-z][-_0-9a-z]`.
environment	enum Environment Required field. Deployment environment of the Greenplum® cluster. `PRODUCTION`: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. `PRESTABLE`: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
config	GreenplumConfig Greenplum® cluster configuration.
master_config	MasterSubclusterConfigSpec Configuration of the Greenplum® master subcluster.
segment_config	SegmentSubclusterConfigSpec Configuration of the Greenplum® segment subcluster.
master_host_count	int64 Number of hosts in the master subcluster.
segment_in_host	int64 Number of segments per host.
segment_host_count	int64 Number of hosts in the segment subcluster.
user_name	string Required field. Owner user name.
user_password	string Required field. Owner user password. The string length in characters must be 8-128.
network_id	string Required field. ID of the network to create the cluster in. The maximum string length in characters is 50.
security_group_ids[]	string User security groups.
deletion_protection	bool Determines whether the cluster is protected from being deleted.
host_group_ids[]	string Host groups to place VMs of the cluster in.
maintenance_window	MaintenanceWindow A Greenplum® cluster maintenance window. Should be defined by either one of the two options.
config_spec	ConfigSpec Configuration of Greenplum® and Odyssey®.
cloud_storage	CloudStorage Cloud storage settings
master_host_group_ids[]	string Host groups hosting VMs of the master subcluster.
segment_host_group_ids[]	string Host groups hosting VMs of the segment subcluster.
service_account_id	string ID of the service account used for access Yandex Cloud resources.
logging	LoggingConfig Cloud logging configuration

GreenplumConfig

Field	Description
version	string Version of the Greenplum® server software.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
backup_retain_period_days	google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 1 to 60, inclusive.
access	Access Access policy for external services.
zone_id	string ID of the availability zone the cluster belongs to. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string ID of the subnet the cluster belongs to. This subnet should be a part of the cloud network the cluster belongs to (see Cluster.network_id). The maximum string length in characters is 50.
assign_public_ip	bool Determines whether the cluster has a public IP address. After the cluster has been created, this setting cannot be changed.
full_version	string Full version

Access

Field	Description
data_lens	bool Allows data export from the cluster to DataLens.
web_sql	bool Allows SQL queries to the cluster databases from the management console.
data_transfer	bool Allows access for DataTransfer.
yandex_query	bool Allow access for YandexQuery.

MasterSubclusterConfigSpec

Field

Description

resources

Resources

Resources allocated to Greenplum® master subcluster hosts.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources allocated to a host. Available presets are listed in the documentation.
disk_size	int64 Volume of the storage used by the host, in bytes.
disk_type_id	string Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`.

SegmentSubclusterConfigSpec

Field

Description

resources

Resources

Resources allocated to Greenplum® segment subcluster hosts.

MaintenanceWindow

Field

Description

anytime

AnytimeMaintenanceWindow

An any-time maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

An any-time maintenance window.

Field	Description
Empty

WeeklyMaintenanceWindow

A weekly maintenance window.

Field

Description

day

enum WeekDay

Day of the week.

MON: Monday
TUE: Tuesday
WED: Wednesday
THU: Thursday
FRI: Friday
SAT: Saturday
SUN: Sunday

hour

int64

Hour of the day in the UTC timezone.

Acceptable values are 1 to 24, inclusive.

ConfigSpec

Field	Description
greenplum_config_6	GreenplumConfig6 Includes only one of the fields `greenplum_config_6`.
pool	ConnectionPoolerConfig Odyssey® pool settings.
background_activities	BackgroundActivitiesConfig Managed Greenplum® background tasks configuration.
pxf_config	PXFConfig

GreenplumConfig6

Field	Description
max_connections	google.protobuf.Int64Value Maximum number of inbound connections on master segment Acceptable values are 50 to 1000, inclusive.
max_slot_wal_keep_size	google.protobuf.Int64Value Specify the maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. https://www.postgresql.org/docs/current/runtime-config-replication.html Acceptable values are 0 to 214748364800, inclusive.
gp_workfile_limit_per_segment	google.protobuf.Int64Value Sets the maximum total disk size that all running queries are allowed to use for creating temporary spill files at each segment. The default value is 0, which means a limit is not enforced. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_per_segment The minimum value is 0.
gp_workfile_limit_per_query	google.protobuf.Int64Value Sets the maximum disk size an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0, which means a limit is not enforced. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_per_query Acceptable values are 0 to 1099511627776, inclusive.
gp_workfile_limit_files_per_query	google.protobuf.Int64Value Sets the maximum number of temporary spill files (also known as workfiles) allowed per query per segment. Spill files are created when executing a query that requires more memory than it is allocated. The current query is terminated when the limit is exceeded. Set the value to 0 (zero) to allow an unlimited number of spill files. master session reload https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 Acceptable values are 0 to 100000, inclusive.
max_prepared_transactions	google.protobuf.Int64Value Sets the maximum number of transactions that can be in the "prepared" state simultaneously https://www.postgresql.org/docs/9.6/runtime-config-resource.html Acceptable values are 50 to 10000, inclusive.
gp_workfile_compression	google.protobuf.BoolValue Specifies whether the temporary files created, when a hash aggregation or hash join operation spills to disk, are compressed. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_compression
max_statement_mem	google.protobuf.Int64Value Sets the maximum memory limit for a query. Helps avoid out-of-memory errors on a segment host during query processing as a result of setting statement_mem too high. Taking into account the configuration of a single segment host, calculate max_statement_mem as follows: (seghost_physical_memory) / (average_number_concurrent_queries) When changing both max_statement_mem and statement_mem, max_statement_mem must be changed first, or listed first in the postgresql.conf file. https://greenplum.docs.pivotal.io/6-19/ref_guide/config_params/guc-list.html#max_statement_mem Default value is 2097152000 (2000MB) Acceptable values are 134217728 to 1099511627776, inclusive.
log_statement	enum LogStatement Controls which SQL statements are logged. DDL logs all data definition commands like CREATE, ALTER, and DROP commands. MOD logs all DDL statements, plus INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command is of an appropriate type. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#log_statement Default value is ddl `NONE`: None statements are logged. `DDL`: Logs all data definition commands like `CREATE`, `ALTER`, and `DROP`. Default value. `MOD`: Logs all `DDL` statements, plus `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY FROM`. `ALL`: Logs all statements.
gp_add_column_inherits_table_setting	google.protobuf.BoolValue https://docs.vmware.com/en/VMware-Tanzu-Greenplum/6/greenplum-database/GUID-ref_guide-config_params-guc-list.html#gp_add_column_inherits_table_setting
gp_enable_global_deadlock_detector	google.protobuf.BoolValue Controls whether the Greenplum Database Global Deadlock Detector is enabled to manage concurrent UPDATE and DELETE operations on heap tables to improve performance. See Inserting, Updating, and Deleting Datain the Greenplum Database Administrator Guide. The default is off, the Global Deadlock Detector is deactivated. If the Global Deadlock Detector is deactivated (the default), Greenplum Database runs concurrent update and delete operations on a heap table serially. If the Global Deadlock Detector is enabled, concurrent updates are permitted and the Global Deadlock Detector determines when a deadlock exists, and breaks the deadlock by cancelling one or more backend processes associated with the youngest transaction(s) involved. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_enable_global_deadlock_detector
gp_global_deadlock_detector_period	google.protobuf.Int64Value Specifies the executing interval (in seconds) of the global deadlock detector background worker process. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_global_deadlock_detector_period
gp_max_slices	google.protobuf.Int64Value Max amount of slice-processes for one query in one segment. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_max_slices Acceptable values are 10 to 100, inclusive.
gp_cached_segworkers_threshold	google.protobuf.Int64Value Define amount of working processes in segment, that keeping in warm cash after end of query for usage again in next queries. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_cached_segworkers_threshold Acceptable values are 0 to 10, inclusive.
lock_timeout	google.protobuf.Int64Value Max time (in ms) which query will wait lock free on object https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#lock_timeout Acceptable values are 0 to 2147483647, inclusive.
idle_in_transaction_session_timeout	google.protobuf.Int64Value Max time (in ms) which session can idle in open transaction https://postgrespro.ru/docs/postgrespro/current/runtime-config-client#GUC-IDLE-IN-TRANSACTION-SESSION-TIMEOUT Acceptable values are 0 to 2147483647, inclusive.
runaway_detector_activation_percent	google.protobuf.Int64Value Percent of utilized Greenplum Database vmem that triggers the termination of queries. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#runaway_detector_activation_percent Acceptable values are 0 to 100, inclusive.
gp_vmem_protect_segworker_cache_limit	google.protobuf.Int64Value Set memory limit (in MB) for working process. If a query executor process consumes more than this configured amount, then the process will not be cached for use in subsequent queries after the process completes. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_vmem_protect_segworker_cache_limit Acceptable values are 0 to 4096, inclusive.
gp_enable_zstd_memory_accounting	google.protobuf.BoolValue Forces ZSTD lib use Greenplum memory allocation system.
gp_max_plan_size	google.protobuf.Int64Value Specifies the total maximum uncompressed size of a query execution plan multiplied by the number of Motion operators (slices) in the plan. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_max_plan_size Acceptable values are 0 to 2147483647, inclusive.
gp_autostats_mode	enum GPAutostatsMode Specifies the mode for triggering automatic statistics collection after DML. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_autostats_mode `GP_AUTOSTATS_MODE_NONE`: Disable auto-ANALYZE completely. Stats will be updated only via manual ANALYZE calls. `GP_AUTOSTATS_MODE_ON_CHANGE`: Run ANALYZE when data changes exceed threshold (e.g., after INSERT/UPDATE/DELETE). `GP_AUTOSTATS_MODE_ON_NO_STATS`: Run ANALYZE only if no stats exist (e.g., new or cleared table).
gp_autostats_on_change_threshold	google.protobuf.Int64Value Specifies the threshold for automatic statistics collection when gp_autostats_mode is set to on_change. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_autostats_on_change_threshold Acceptable values are 0 to 2147483647, inclusive.
gp_resource_group_memory_limit	google.protobuf.DoubleValue Identifies the maximum percentage of system memory resources to allocate to resource groups on each Greenplum Database segment node. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_resource_group_memory_limit
log_connections	google.protobuf.BoolValue This outputs a line to the server log detailing each successful connection. Some client programs, like psql, attempt to connect twice while determining if a password is required, so duplicate "connection received" messages do not always indicate a problem. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_connections
log_disconnections	google.protobuf.BoolValue This outputs a line in the server log at termination of a client session, and includes the duration of the session. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_disconnections
log_hostname	google.protobuf.BoolValue By default, connection log messages only show the IP address of the connecting host. Turning on this option causes logging of the host name as well. Note that depending on your host name resolution setup this might impose a non-negligible performance penalty. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_hostname
log_statement_stats	google.protobuf.BoolValue For each query, write total performance statistics of the query parser, planner, and executor to the server log. This is a crude profiling instrument. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement_stats
log_min_duration_statement	google.protobuf.Int64Value Logs the statement and its duration on a single log line if its duration is greater than or equal to the specified number of milliseconds. Setting this to 0 will print all statements and their durations. -1 deactivates the feature. For example, if you set it to 250 then all SQL statements that run 250ms or longer will be logged. Enabling this option can be useful in tracking down unoptimized queries in your applications. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_min_duration_statement
master_shared_buffers	google.protobuf.Int64Value Sets the amount of memory a Greenplum Database master instance uses for shared memory buffers. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#shared_buffers Acceptable values are 1048576 to 2147483647, inclusive.
max_locks_per_transaction	google.protobuf.Int64Value The shared lock table is created with room to describe locks on max_locks_per_transaction * (max_connections + max_prepared_transactions) objects, so no more than this many distinct objects can be locked at any one time. This is not a hard limit on the number of locks taken by any one transaction, but rather a maximum average value. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#max_locks_per_transaction Acceptable values are 128 to 2048, inclusive.
segment_shared_buffers	google.protobuf.Int64Value Sets the amount of memory a Greenplum Database segment instance uses for shared memory buffers. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#shared_buffers Acceptable values are 1048576 to 2147483647, inclusive.
log_error_verbosity	enum LogErrorVerbosity Controls the amount of detail written in the server log for each message that is logged. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_error_verbosity `TERSE` `DEFAULT` `VERBOSE`
log_min_messages	enum LogLevelMessage Controls which message levels are written to the server log. Each level includes all the levels that follow it. The later the level, the fewer messages are sent to the log. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_min_messages `DEBUG5` `DEBUG4` `DEBUG3` `DEBUG2` `DEBUG1` `INFO` `NOTICE` `WARNING` `ERROR` `FATAL` `PANIC`

ConnectionPoolerConfig

Field	Description
mode	enum PoolMode Route server pool mode. `SESSION`: Assign server connection to a client until it disconnects. Default value. `TRANSACTION`: Assign server connection to a client for a transaction processing.
size	google.protobuf.Int64Value The number of servers in the server pool. Clients are placed in a wait queue when all servers are busy. Set to zero to disable the limit.
client_idle_timeout	google.protobuf.Int64Value Client pool idle timeout, in seconds. Drop stale client connection after this much seconds of idleness, which is not in transaction. Set to zero to disable.
idle_in_transaction_timeout	google.protobuf.Int64Value Client pool idle in transaction timeout, in seconds. Drop client connection in transaction after this much seconds of idleness. Set to zero to disable.

BackgroundActivitiesConfig

Configuration for long running queries killer.

Field	Description
table_sizes	TableSizes Enables scripts that collects tables sizes to `*_sizes` tables in `mdb_toolkit` schema.
analyze_and_vacuum	AnalyzeAndVacuum Configuration for `ANALYZE` and `VACUUM` operations.
query_killer_scripts	QueryKillerScripts Configuration for long running queries killer.

TableSizes

Enables scripts that collects tables sizes to *_sizes tables in mdb_toolkit schema.

Field

Description

starts[]

BackgroundActivityStartAt

Time when start "table_sizes" script

The maximum number of elements is 4.

BackgroundActivityStartAt

Start time for background activity

Field

Description

hours

int64

hours

Acceptable values are 0 to 23, inclusive.

minutes

int64

minutes

Acceptable values are 0 to 59, inclusive.

AnalyzeAndVacuum

Configuration for ANALYZE and VACUUM operations.

Field	Description
start	BackgroundActivityStartAt Time when analyze will start
analyze_timeout	google.protobuf.Int64Value Maximum duration of the `ANALYZE` operation, in seconds. The default value is `36000`. As soon as this period expires, the `ANALYZE` operation will be forced to terminate. Acceptable values are 7200 to 86399, inclusive.
vacuum_timeout	google.protobuf.Int64Value Maximum duration of the `VACUUM` operation, in seconds. The default value is `36000`. As soon as this period expires, the `VACUUM` operation will be forced to terminate. Acceptable values are 7200 to 86399, inclusive.

QueryKillerScripts

Field	Description
idle	QueryKiller Configuration of script that kills long running queries that are in `idle` state.
idle_in_transaction	QueryKiller Configuration of script that kills long running queries that are in `idle in transaction` state.
long_running	QueryKiller Configuration of script that kills long running queries (in any state).

QueryKiller

Field	Description
enable	google.protobuf.BoolValue Use query killer or not
max_age	google.protobuf.Int64Value Maximum duration for this type of queries (in seconds). Acceptable values are 1 to 86400, inclusive.
ignore_users[]	string Ignore these users when considering queries to terminate

PXFConfig

Field	Description
connection_timeout	google.protobuf.Int64Value Timeout for connection to the Apache Tomcat® server when making read requests. Specify values in seconds. Acceptable values are 5 to 600, inclusive.
upload_timeout	google.protobuf.Int64Value Timeout for connection to the Apache Tomcat® server when making write requests. Specify the values in seconds. Acceptable values are 5 to 600, inclusive.
max_threads	google.protobuf.Int64Value Maximum number of the Apache Tomcat® threads. 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. Acceptable values are 1 to 1024, inclusive.
pool_allow_core_thread_timeout	google.protobuf.BoolValue Determines whether the timeout for core streaming threads is permitted.
pool_core_size	google.protobuf.Int64Value Number of core streaming threads per pool. Acceptable values are 1 to 1024, inclusive.
pool_queue_capacity	google.protobuf.Int64Value Maximum number of requests you can add to a pool queue for core streaming threads. If `0`, no pool queue is generated. The minimum value is 0.
pool_max_size	google.protobuf.Int64Value Maximum allowed number of core streaming threads. Acceptable values are 1 to 1024, inclusive.
xmx	google.protobuf.Int64Value Initial size, in megabytes, of the JVM heap for the PXF daemon. The minimum value is 64.
xms	google.protobuf.Int64Value Maximum size, in megabytes, of the JVM heap for the PXF daemon. The minimum value is 64.

CloudStorage

Cloud Storage Settings

Field

Description

enable

bool

enable Cloud Storage for cluster

LoggingConfig

Field	Description
enabled	bool
folder_id	string Value must match the regular expression `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `folder_id`, `log_group_id`.
log_group_id	string Value must match the regular expression `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `folder_id`, `log_group_id`.
command_center_enabled	bool send Yandex Command Center logs
greenplum_enabled	bool send Greenplum logs
pooler_enabled	bool send Pooler logs

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "config": {
      "version": "string",
      "backup_window_start": "google.type.TimeOfDay",
      "backup_retain_period_days": "google.protobuf.Int64Value",
      "access": {
        "data_lens": "bool",
        "web_sql": "bool",
        "data_transfer": "bool",
        "yandex_query": "bool"
      },
      "zone_id": "string",
      "subnet_id": "string",
      "assign_public_ip": "bool",
      "full_version": "string"
    },
    "description": "string",
    "labels": "map<string, string>",
    "environment": "Environment",
    "monitoring": [
      {
        "name": "string",
        "description": "string",
        "link": "string"
      }
    ],
    "master_config": {
      "resources": {
        "resource_preset_id": "string",
        "disk_size": "int64",
        "disk_type_id": "string"
      }
    },
    "segment_config": {
      "resources": {
        "resource_preset_id": "string",
        "disk_size": "int64",
        "disk_type_id": "string"
      }
    },
    "master_host_count": "int64",
    "segment_host_count": "int64",
    "segment_in_host": "int64",
    "network_id": "string",
    "health": "Health",
    "status": "Status",
    "maintenance_window": {
      // Includes only one of the fields `anytime`, `weekly_maintenance_window`
      "anytime": "AnytimeMaintenanceWindow",
      "weekly_maintenance_window": {
        "day": "WeekDay",
        "hour": "int64"
      }
      // end of the list of possible fields
    },
    "planned_operation": {
      "info": "string",
      "delayed_until": "google.protobuf.Timestamp"
    },
    "security_group_ids": [
      "string"
    ],
    "user_name": "string",
    "deletion_protection": "bool",
    "host_group_ids": [
      "string"
    ],
    "cluster_config": {
      // Includes only one of the fields `greenplum_config_set_6`
      "greenplum_config_set_6": {
        "effective_config": {
          "max_connections": "google.protobuf.Int64Value",
          "max_slot_wal_keep_size": "google.protobuf.Int64Value",
          "gp_workfile_limit_per_segment": "google.protobuf.Int64Value",
          "gp_workfile_limit_per_query": "google.protobuf.Int64Value",
          "gp_workfile_limit_files_per_query": "google.protobuf.Int64Value",
          "max_prepared_transactions": "google.protobuf.Int64Value",
          "gp_workfile_compression": "google.protobuf.BoolValue",
          "max_statement_mem": "google.protobuf.Int64Value",
          "log_statement": "LogStatement",
          "gp_add_column_inherits_table_setting": "google.protobuf.BoolValue",
          "gp_enable_global_deadlock_detector": "google.protobuf.BoolValue",
          "gp_global_deadlock_detector_period": "google.protobuf.Int64Value",
          "gp_max_slices": "google.protobuf.Int64Value",
          "gp_cached_segworkers_threshold": "google.protobuf.Int64Value",
          "lock_timeout": "google.protobuf.Int64Value",
          "idle_in_transaction_session_timeout": "google.protobuf.Int64Value",
          "runaway_detector_activation_percent": "google.protobuf.Int64Value",
          "gp_vmem_protect_segworker_cache_limit": "google.protobuf.Int64Value",
          "gp_enable_zstd_memory_accounting": "google.protobuf.BoolValue",
          "gp_max_plan_size": "google.protobuf.Int64Value",
          "gp_autostats_mode": "GPAutostatsMode",
          "gp_autostats_on_change_threshold": "google.protobuf.Int64Value",
          "gp_resource_group_memory_limit": "google.protobuf.DoubleValue",
          "log_connections": "google.protobuf.BoolValue",
          "log_disconnections": "google.protobuf.BoolValue",
          "log_hostname": "google.protobuf.BoolValue",
          "log_statement_stats": "google.protobuf.BoolValue",
          "log_min_duration_statement": "google.protobuf.Int64Value",
          "master_shared_buffers": "google.protobuf.Int64Value",
          "max_locks_per_transaction": "google.protobuf.Int64Value",
          "segment_shared_buffers": "google.protobuf.Int64Value",
          "log_error_verbosity": "LogErrorVerbosity",
          "log_min_messages": "LogLevelMessage"
        },
        "user_config": {
          "max_connections": "google.protobuf.Int64Value",
          "max_slot_wal_keep_size": "google.protobuf.Int64Value",
          "gp_workfile_limit_per_segment": "google.protobuf.Int64Value",
          "gp_workfile_limit_per_query": "google.protobuf.Int64Value",
          "gp_workfile_limit_files_per_query": "google.protobuf.Int64Value",
          "max_prepared_transactions": "google.protobuf.Int64Value",
          "gp_workfile_compression": "google.protobuf.BoolValue",
          "max_statement_mem": "google.protobuf.Int64Value",
          "log_statement": "LogStatement",
          "gp_add_column_inherits_table_setting": "google.protobuf.BoolValue",
          "gp_enable_global_deadlock_detector": "google.protobuf.BoolValue",
          "gp_global_deadlock_detector_period": "google.protobuf.Int64Value",
          "gp_max_slices": "google.protobuf.Int64Value",
          "gp_cached_segworkers_threshold": "google.protobuf.Int64Value",
          "lock_timeout": "google.protobuf.Int64Value",
          "idle_in_transaction_session_timeout": "google.protobuf.Int64Value",
          "runaway_detector_activation_percent": "google.protobuf.Int64Value",
          "gp_vmem_protect_segworker_cache_limit": "google.protobuf.Int64Value",
          "gp_enable_zstd_memory_accounting": "google.protobuf.BoolValue",
          "gp_max_plan_size": "google.protobuf.Int64Value",
          "gp_autostats_mode": "GPAutostatsMode",
          "gp_autostats_on_change_threshold": "google.protobuf.Int64Value",
          "gp_resource_group_memory_limit": "google.protobuf.DoubleValue",
          "log_connections": "google.protobuf.BoolValue",
          "log_disconnections": "google.protobuf.BoolValue",
          "log_hostname": "google.protobuf.BoolValue",
          "log_statement_stats": "google.protobuf.BoolValue",
          "log_min_duration_statement": "google.protobuf.Int64Value",
          "master_shared_buffers": "google.protobuf.Int64Value",
          "max_locks_per_transaction": "google.protobuf.Int64Value",
          "segment_shared_buffers": "google.protobuf.Int64Value",
          "log_error_verbosity": "LogErrorVerbosity",
          "log_min_messages": "LogLevelMessage"
        },
        "default_config": {
          "max_connections": "google.protobuf.Int64Value",
          "max_slot_wal_keep_size": "google.protobuf.Int64Value",
          "gp_workfile_limit_per_segment": "google.protobuf.Int64Value",
          "gp_workfile_limit_per_query": "google.protobuf.Int64Value",
          "gp_workfile_limit_files_per_query": "google.protobuf.Int64Value",
          "max_prepared_transactions": "google.protobuf.Int64Value",
          "gp_workfile_compression": "google.protobuf.BoolValue",
          "max_statement_mem": "google.protobuf.Int64Value",
          "log_statement": "LogStatement",
          "gp_add_column_inherits_table_setting": "google.protobuf.BoolValue",
          "gp_enable_global_deadlock_detector": "google.protobuf.BoolValue",
          "gp_global_deadlock_detector_period": "google.protobuf.Int64Value",
          "gp_max_slices": "google.protobuf.Int64Value",
          "gp_cached_segworkers_threshold": "google.protobuf.Int64Value",
          "lock_timeout": "google.protobuf.Int64Value",
          "idle_in_transaction_session_timeout": "google.protobuf.Int64Value",
          "runaway_detector_activation_percent": "google.protobuf.Int64Value",
          "gp_vmem_protect_segworker_cache_limit": "google.protobuf.Int64Value",
          "gp_enable_zstd_memory_accounting": "google.protobuf.BoolValue",
          "gp_max_plan_size": "google.protobuf.Int64Value",
          "gp_autostats_mode": "GPAutostatsMode",
          "gp_autostats_on_change_threshold": "google.protobuf.Int64Value",
          "gp_resource_group_memory_limit": "google.protobuf.DoubleValue",
          "log_connections": "google.protobuf.BoolValue",
          "log_disconnections": "google.protobuf.BoolValue",
          "log_hostname": "google.protobuf.BoolValue",
          "log_statement_stats": "google.protobuf.BoolValue",
          "log_min_duration_statement": "google.protobuf.Int64Value",
          "master_shared_buffers": "google.protobuf.Int64Value",
          "max_locks_per_transaction": "google.protobuf.Int64Value",
          "segment_shared_buffers": "google.protobuf.Int64Value",
          "log_error_verbosity": "LogErrorVerbosity",
          "log_min_messages": "LogLevelMessage"
        }
      },
      // end of the list of possible fields
      "pool": {
        "effective_config": {
          "mode": "PoolMode",
          "size": "google.protobuf.Int64Value",
          "client_idle_timeout": "google.protobuf.Int64Value",
          "idle_in_transaction_timeout": "google.protobuf.Int64Value"
        },
        "user_config": {
          "mode": "PoolMode",
          "size": "google.protobuf.Int64Value",
          "client_idle_timeout": "google.protobuf.Int64Value",
          "idle_in_transaction_timeout": "google.protobuf.Int64Value"
        },
        "default_config": {
          "mode": "PoolMode",
          "size": "google.protobuf.Int64Value",
          "client_idle_timeout": "google.protobuf.Int64Value",
          "idle_in_transaction_timeout": "google.protobuf.Int64Value"
        }
      },
      "background_activities": {
        "table_sizes": {
          "starts": [
            {
              "hours": "int64",
              "minutes": "int64"
            }
          ]
        },
        "analyze_and_vacuum": {
          "start": {
            "hours": "int64",
            "minutes": "int64"
          },
          "analyze_timeout": "google.protobuf.Int64Value",
          "vacuum_timeout": "google.protobuf.Int64Value"
        },
        "query_killer_scripts": {
          "idle": {
            "enable": "google.protobuf.BoolValue",
            "max_age": "google.protobuf.Int64Value",
            "ignore_users": [
              "string"
            ]
          },
          "idle_in_transaction": {
            "enable": "google.protobuf.BoolValue",
            "max_age": "google.protobuf.Int64Value",
            "ignore_users": [
              "string"
            ]
          },
          "long_running": {
            "enable": "google.protobuf.BoolValue",
            "max_age": "google.protobuf.Int64Value",
            "ignore_users": [
              "string"
            ]
          }
        }
      },
      "pxf_config": {
        "effective_config": {
          "connection_timeout": "google.protobuf.Int64Value",
          "upload_timeout": "google.protobuf.Int64Value",
          "max_threads": "google.protobuf.Int64Value",
          "pool_allow_core_thread_timeout": "google.protobuf.BoolValue",
          "pool_core_size": "google.protobuf.Int64Value",
          "pool_queue_capacity": "google.protobuf.Int64Value",
          "pool_max_size": "google.protobuf.Int64Value",
          "xmx": "google.protobuf.Int64Value",
          "xms": "google.protobuf.Int64Value"
        },
        "user_config": {
          "connection_timeout": "google.protobuf.Int64Value",
          "upload_timeout": "google.protobuf.Int64Value",
          "max_threads": "google.protobuf.Int64Value",
          "pool_allow_core_thread_timeout": "google.protobuf.BoolValue",
          "pool_core_size": "google.protobuf.Int64Value",
          "pool_queue_capacity": "google.protobuf.Int64Value",
          "pool_max_size": "google.protobuf.Int64Value",
          "xmx": "google.protobuf.Int64Value",
          "xms": "google.protobuf.Int64Value"
        },
        "default_config": {
          "connection_timeout": "google.protobuf.Int64Value",
          "upload_timeout": "google.protobuf.Int64Value",
          "max_threads": "google.protobuf.Int64Value",
          "pool_allow_core_thread_timeout": "google.protobuf.BoolValue",
          "pool_core_size": "google.protobuf.Int64Value",
          "pool_queue_capacity": "google.protobuf.Int64Value",
          "pool_max_size": "google.protobuf.Int64Value",
          "xmx": "google.protobuf.Int64Value",
          "xms": "google.protobuf.Int64Value"
        }
      }
    },
    "cloud_storage": {
      "enable": "bool"
    },
    "master_host_group_ids": [
      "string"
    ],
    "segment_host_group_ids": [
      "string"
    ],
    "service_account_id": "string",
    "logging": {
      "enabled": "bool",
      // Includes only one of the fields `folder_id`, `log_group_id`
      "folder_id": "string",
      "log_group_id": "string",
      // end of the list of possible fields
      "command_center_enabled": "bool",
      "greenplum_enabled": "bool",
      "pooler_enabled": "bool"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CreateClusterMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Cluster The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CreateClusterMetadata

Field

Description

cluster_id

string

ID of the Greenplum® cluster that is being created.

Cluster

A Greenplum® cluster resource.

Field	Description
id	string ID of the Greenplum® cluster. This ID is assigned by the platform at the moment of cluster creation.
folder_id	string ID of the folder that the Greenplum® cluster belongs to.
created_at	google.protobuf.Timestamp Time when the cluster was created.
name	string Required field. Name of the Greenplum® cluster. The name is unique within the folder. The maximum string length in characters is 63.
config	GreenplumConfig Greenplum® cluster configuration.
description	string Description of the Greenplum® cluster. The maximum string length in characters is 256.
labels	object (map<string, string>) Custom labels for the Greenplum® cluster as `key:value` pairs. Maximum 64 labels per resource.
environment	enum Environment Deployment environment of the Greenplum® cluster. `PRODUCTION`: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. `PRESTABLE`: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	Monitoring Description of monitoring systems relevant to the Greenplum® cluster.
master_config	MasterSubclusterConfig Configuration of the Greenplum® master subcluster.
segment_config	SegmentSubclusterConfig Configuration of the Greenplum® segment subcluster.
master_host_count	int64 Number of hosts in the master subcluster.
segment_host_count	int64 Number of hosts in the segment subcluster.
segment_in_host	int64 Number of segments per host.
network_id	string ID of the cloud network that the cluster belongs to.
health	enum Health Aggregated cluster health. `HEALTH_UNKNOWN`: Health of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN). `ALIVE`: Cluster is working normally (Host.health for every host in the cluster is ALIVE). `DEAD`: Cluster is inoperable (Host.health for every host in the cluster is DEAD). `DEGRADED`: Cluster is working below capacity (Host.health for at least one host in the cluster is not ALIVE). `UNBALANCED`: Cluster is working below capacity (Host.health for at least one host in the cluster is UNBALANCED).
status	enum Status Current state of the cluster. `STATUS_UNKNOWN`: Cluster state is unknown. `CREATING`: Cluster is being created. `RUNNING`: Cluster is running normally. `ERROR`: Cluster has encountered a problem and cannot operate. `UPDATING`: Cluster is being updated. `STOPPING`: Cluster is stopping. `STOPPED`: Cluster has stopped. `STARTING`: Cluster is starting.
maintenance_window	MaintenanceWindow A Greenplum® cluster maintenance window. Should be defined by either one of the two options.
planned_operation	MaintenanceOperation Maintenance operation planned at nearest `maintenance_window`.
security_group_ids[]	string User security groups.
user_name	string Owner user name.
deletion_protection	bool Determines whether the cluster is protected from being deleted.
host_group_ids[]	string Host groups hosting VMs of the cluster.
cluster_config	ClusterConfigSet Greenplum® and Odyssey® configuration.
cloud_storage	CloudStorage Cloud storage settings
master_host_group_ids[]	string Host groups hosting VMs of the master subcluster.
segment_host_group_ids[]	string Host groups hosting VMs of the segment subcluster.
service_account_id	string Service account that will be used to access a Yandex Cloud resources
logging	LoggingConfig Cloud logging configuration

GreenplumConfig

Field	Description
version	string Version of the Greenplum® server software.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
backup_retain_period_days	google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 1 to 60, inclusive.
access	Access Access policy for external services.
zone_id	string ID of the availability zone the cluster belongs to. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string ID of the subnet the cluster belongs to. This subnet should be a part of the cloud network the cluster belongs to (see Cluster.network_id). The maximum string length in characters is 50.
assign_public_ip	bool Determines whether the cluster has a public IP address. After the cluster has been created, this setting cannot be changed.
full_version	string Full version

Access

Field	Description
data_lens	bool Allows data export from the cluster to DataLens.
web_sql	bool Allows SQL queries to the cluster databases from the management console.
data_transfer	bool Allows access for DataTransfer.
yandex_query	bool Allow access for YandexQuery.

Monitoring

Monitoring system metadata.

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system charts for the Greenplum® cluster.

MasterSubclusterConfig

Field

Description

resources

Resources

Computational resources allocated to Greenplum® master subcluster hosts.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources allocated to a host. Available presets are listed in the documentation.
disk_size	int64 Volume of the storage used by the host, in bytes.
disk_type_id	string Type of the storage used by the host: `network-hdd`, `network-ssd` or `local-ssd`.

SegmentSubclusterConfig

Field

Description

resources

Resources

Computational resources allocated to Greenplum® segment subcluster hosts.

MaintenanceWindow

Field

Description

anytime

AnytimeMaintenanceWindow

An any-time maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

weekly_maintenance_window

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weekly_maintenance_window.

AnytimeMaintenanceWindow

An any-time maintenance window.

Field	Description
Empty

WeeklyMaintenanceWindow

A weekly maintenance window.

Field

Description

day

enum WeekDay

Day of the week.

MON: Monday
TUE: Tuesday
WED: Wednesday
THU: Thursday
FRI: Friday
SAT: Saturday
SUN: Sunday

hour

int64

Hour of the day in the UTC timezone.

Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field

Description

info

string

The description of the operation.

The maximum string length in characters is 256.

delayed_until

google.protobuf.Timestamp

Delay time for the maintenance operation.

ClusterConfigSet

Field	Description
greenplum_config_set_6	GreenplumConfigSet6 Includes only one of the fields `greenplum_config_set_6`.
pool	ConnectionPoolerConfigSet Odyssey® pool settings.
background_activities	BackgroundActivitiesConfig Managed Greenplum® background tasks configuration.
pxf_config	PXFConfigSet

GreenplumConfigSet6

Field	Description
effective_config	GreenplumConfig6 Required field. Effective settings for a Greenplum (a combination of settings defined in `user_config` and `default_config`).
user_config	GreenplumConfig6 User-defined settings for a Greenplum.
default_config	GreenplumConfig6 Default configuration for a Greenplum.

GreenplumConfig6

Field	Description
max_connections	google.protobuf.Int64Value Maximum number of inbound connections on master segment Acceptable values are 50 to 1000, inclusive.
max_slot_wal_keep_size	google.protobuf.Int64Value Specify the maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. https://www.postgresql.org/docs/current/runtime-config-replication.html Acceptable values are 0 to 214748364800, inclusive.
gp_workfile_limit_per_segment	google.protobuf.Int64Value Sets the maximum total disk size that all running queries are allowed to use for creating temporary spill files at each segment. The default value is 0, which means a limit is not enforced. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_per_segment The minimum value is 0.
gp_workfile_limit_per_query	google.protobuf.Int64Value Sets the maximum disk size an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0, which means a limit is not enforced. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_per_query Acceptable values are 0 to 1099511627776, inclusive.
gp_workfile_limit_files_per_query	google.protobuf.Int64Value Sets the maximum number of temporary spill files (also known as workfiles) allowed per query per segment. Spill files are created when executing a query that requires more memory than it is allocated. The current query is terminated when the limit is exceeded. Set the value to 0 (zero) to allow an unlimited number of spill files. master session reload https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 Acceptable values are 0 to 100000, inclusive.
max_prepared_transactions	google.protobuf.Int64Value Sets the maximum number of transactions that can be in the "prepared" state simultaneously https://www.postgresql.org/docs/9.6/runtime-config-resource.html Acceptable values are 50 to 10000, inclusive.
gp_workfile_compression	google.protobuf.BoolValue Specifies whether the temporary files created, when a hash aggregation or hash join operation spills to disk, are compressed. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#gp_workfile_compression
max_statement_mem	google.protobuf.Int64Value Sets the maximum memory limit for a query. Helps avoid out-of-memory errors on a segment host during query processing as a result of setting statement_mem too high. Taking into account the configuration of a single segment host, calculate max_statement_mem as follows: (seghost_physical_memory) / (average_number_concurrent_queries) When changing both max_statement_mem and statement_mem, max_statement_mem must be changed first, or listed first in the postgresql.conf file. https://greenplum.docs.pivotal.io/6-19/ref_guide/config_params/guc-list.html#max_statement_mem Default value is 2097152000 (2000MB) Acceptable values are 134217728 to 1099511627776, inclusive.
log_statement	enum LogStatement Controls which SQL statements are logged. DDL logs all data definition commands like CREATE, ALTER, and DROP commands. MOD logs all DDL statements, plus INSERT, UPDATE, DELETE, TRUNCATE, and COPY FROM. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command is of an appropriate type. https://docs.greenplum.org/6-5/ref_guide/config_params/guc-list.html#log_statement Default value is ddl `NONE`: None statements are logged. `DDL`: Logs all data definition commands like `CREATE`, `ALTER`, and `DROP`. Default value. `MOD`: Logs all `DDL` statements, plus `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, and `COPY FROM`. `ALL`: Logs all statements.
gp_add_column_inherits_table_setting	google.protobuf.BoolValue https://docs.vmware.com/en/VMware-Tanzu-Greenplum/6/greenplum-database/GUID-ref_guide-config_params-guc-list.html#gp_add_column_inherits_table_setting
gp_enable_global_deadlock_detector	google.protobuf.BoolValue Controls whether the Greenplum Database Global Deadlock Detector is enabled to manage concurrent UPDATE and DELETE operations on heap tables to improve performance. See Inserting, Updating, and Deleting Datain the Greenplum Database Administrator Guide. The default is off, the Global Deadlock Detector is deactivated. If the Global Deadlock Detector is deactivated (the default), Greenplum Database runs concurrent update and delete operations on a heap table serially. If the Global Deadlock Detector is enabled, concurrent updates are permitted and the Global Deadlock Detector determines when a deadlock exists, and breaks the deadlock by cancelling one or more backend processes associated with the youngest transaction(s) involved. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_enable_global_deadlock_detector
gp_global_deadlock_detector_period	google.protobuf.Int64Value Specifies the executing interval (in seconds) of the global deadlock detector background worker process. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_global_deadlock_detector_period
gp_max_slices	google.protobuf.Int64Value Max amount of slice-processes for one query in one segment. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_max_slices Acceptable values are 10 to 100, inclusive.
gp_cached_segworkers_threshold	google.protobuf.Int64Value Define amount of working processes in segment, that keeping in warm cash after end of query for usage again in next queries. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_cached_segworkers_threshold Acceptable values are 0 to 10, inclusive.
lock_timeout	google.protobuf.Int64Value Max time (in ms) which query will wait lock free on object https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#lock_timeout Acceptable values are 0 to 2147483647, inclusive.
idle_in_transaction_session_timeout	google.protobuf.Int64Value Max time (in ms) which session can idle in open transaction https://postgrespro.ru/docs/postgrespro/current/runtime-config-client#GUC-IDLE-IN-TRANSACTION-SESSION-TIMEOUT Acceptable values are 0 to 2147483647, inclusive.
runaway_detector_activation_percent	google.protobuf.Int64Value Percent of utilized Greenplum Database vmem that triggers the termination of queries. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#runaway_detector_activation_percent Acceptable values are 0 to 100, inclusive.
gp_vmem_protect_segworker_cache_limit	google.protobuf.Int64Value Set memory limit (in MB) for working process. If a query executor process consumes more than this configured amount, then the process will not be cached for use in subsequent queries after the process completes. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_vmem_protect_segworker_cache_limit Acceptable values are 0 to 4096, inclusive.
gp_enable_zstd_memory_accounting	google.protobuf.BoolValue Forces ZSTD lib use Greenplum memory allocation system.
gp_max_plan_size	google.protobuf.Int64Value Specifies the total maximum uncompressed size of a query execution plan multiplied by the number of Motion operators (slices) in the plan. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_max_plan_size Acceptable values are 0 to 2147483647, inclusive.
gp_autostats_mode	enum GPAutostatsMode Specifies the mode for triggering automatic statistics collection after DML. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_autostats_mode `GP_AUTOSTATS_MODE_NONE`: Disable auto-ANALYZE completely. Stats will be updated only via manual ANALYZE calls. `GP_AUTOSTATS_MODE_ON_CHANGE`: Run ANALYZE when data changes exceed threshold (e.g., after INSERT/UPDATE/DELETE). `GP_AUTOSTATS_MODE_ON_NO_STATS`: Run ANALYZE only if no stats exist (e.g., new or cleared table).
gp_autostats_on_change_threshold	google.protobuf.Int64Value Specifies the threshold for automatic statistics collection when gp_autostats_mode is set to on_change. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_autostats_on_change_threshold Acceptable values are 0 to 2147483647, inclusive.
gp_resource_group_memory_limit	google.protobuf.DoubleValue Identifies the maximum percentage of system memory resources to allocate to resource groups on each Greenplum Database segment node. https://techdocs.broadcom.com/us/en/vmware-tanzu/data-solutions/tanzu-greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_resource_group_memory_limit
log_connections	google.protobuf.BoolValue This outputs a line to the server log detailing each successful connection. Some client programs, like psql, attempt to connect twice while determining if a password is required, so duplicate "connection received" messages do not always indicate a problem. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_connections
log_disconnections	google.protobuf.BoolValue This outputs a line in the server log at termination of a client session, and includes the duration of the session. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_disconnections
log_hostname	google.protobuf.BoolValue By default, connection log messages only show the IP address of the connecting host. Turning on this option causes logging of the host name as well. Note that depending on your host name resolution setup this might impose a non-negligible performance penalty. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_hostname
log_statement_stats	google.protobuf.BoolValue For each query, write total performance statistics of the query parser, planner, and executor to the server log. This is a crude profiling instrument. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement_stats
log_min_duration_statement	google.protobuf.Int64Value Logs the statement and its duration on a single log line if its duration is greater than or equal to the specified number of milliseconds. Setting this to 0 will print all statements and their durations. -1 deactivates the feature. For example, if you set it to 250 then all SQL statements that run 250ms or longer will be logged. Enabling this option can be useful in tracking down unoptimized queries in your applications. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_min_duration_statement
master_shared_buffers	google.protobuf.Int64Value Sets the amount of memory a Greenplum Database master instance uses for shared memory buffers. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#shared_buffers Acceptable values are 1048576 to 2147483647, inclusive.
max_locks_per_transaction	google.protobuf.Int64Value The shared lock table is created with room to describe locks on max_locks_per_transaction * (max_connections + max_prepared_transactions) objects, so no more than this many distinct objects can be locked at any one time. This is not a hard limit on the number of locks taken by any one transaction, but rather a maximum average value. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#max_locks_per_transaction Acceptable values are 128 to 2048, inclusive.
segment_shared_buffers	google.protobuf.Int64Value Sets the amount of memory a Greenplum Database segment instance uses for shared memory buffers. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#shared_buffers Acceptable values are 1048576 to 2147483647, inclusive.
log_error_verbosity	enum LogErrorVerbosity Controls the amount of detail written in the server log for each message that is logged. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_error_verbosity `TERSE` `DEFAULT` `VERBOSE`
log_min_messages	enum LogLevelMessage Controls which message levels are written to the server log. Each level includes all the levels that follow it. The later the level, the fewer messages are sent to the log. https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_min_messages `DEBUG5` `DEBUG4` `DEBUG3` `DEBUG2` `DEBUG1` `INFO` `NOTICE` `WARNING` `ERROR` `FATAL` `PANIC`

ConnectionPoolerConfigSet

Field	Description
effective_config	ConnectionPoolerConfig Required field. Effective settings for an Odyssey® pooler (a combination of settings defined in `ConnectionPoolerConfigSet.user_config` and `ConnectionPoolerConfigSet.default_config`).
user_config	ConnectionPoolerConfig User-defined settings for an Odyssey® pooler.
default_config	ConnectionPoolerConfig Default configuration for an Odyssey® pooler.

ConnectionPoolerConfig

Field	Description
mode	enum PoolMode Route server pool mode. `SESSION`: Assign server connection to a client until it disconnects. Default value. `TRANSACTION`: Assign server connection to a client for a transaction processing.
size	google.protobuf.Int64Value The number of servers in the server pool. Clients are placed in a wait queue when all servers are busy. Set to zero to disable the limit.
client_idle_timeout	google.protobuf.Int64Value Client pool idle timeout, in seconds. Drop stale client connection after this much seconds of idleness, which is not in transaction. Set to zero to disable.
idle_in_transaction_timeout	google.protobuf.Int64Value Client pool idle in transaction timeout, in seconds. Drop client connection in transaction after this much seconds of idleness. Set to zero to disable.

BackgroundActivitiesConfig

Configuration for long running queries killer.

Field	Description
table_sizes	TableSizes Enables scripts that collects tables sizes to `*_sizes` tables in `mdb_toolkit` schema.
analyze_and_vacuum	AnalyzeAndVacuum Configuration for `ANALYZE` and `VACUUM` operations.
query_killer_scripts	QueryKillerScripts Configuration for long running queries killer.

TableSizes

Enables scripts that collects tables sizes to *_sizes tables in mdb_toolkit schema.

Field

Description

starts[]

BackgroundActivityStartAt

Time when start "table_sizes" script

The maximum number of elements is 4.

BackgroundActivityStartAt

Start time for background activity

Field

Description

hours

int64

hours

Acceptable values are 0 to 23, inclusive.

minutes

int64

minutes

Acceptable values are 0 to 59, inclusive.

AnalyzeAndVacuum

Configuration for ANALYZE and VACUUM operations.

Field	Description
start	BackgroundActivityStartAt Time when analyze will start
analyze_timeout	google.protobuf.Int64Value Maximum duration of the `ANALYZE` operation, in seconds. The default value is `36000`. As soon as this period expires, the `ANALYZE` operation will be forced to terminate. Acceptable values are 7200 to 86399, inclusive.
vacuum_timeout	google.protobuf.Int64Value Maximum duration of the `VACUUM` operation, in seconds. The default value is `36000`. As soon as this period expires, the `VACUUM` operation will be forced to terminate. Acceptable values are 7200 to 86399, inclusive.

QueryKillerScripts

Field	Description
idle	QueryKiller Configuration of script that kills long running queries that are in `idle` state.
idle_in_transaction	QueryKiller Configuration of script that kills long running queries that are in `idle in transaction` state.
long_running	QueryKiller Configuration of script that kills long running queries (in any state).

QueryKiller

Field	Description
enable	google.protobuf.BoolValue Use query killer or not
max_age	google.protobuf.Int64Value Maximum duration for this type of queries (in seconds). Acceptable values are 1 to 86400, inclusive.
ignore_users[]	string Ignore these users when considering queries to terminate

PXFConfigSet

Field	Description
effective_config	PXFConfig Required field.
user_config	PXFConfig User-defined settings.
default_config	PXFConfig Default configuration.

PXFConfig

Field	Description
connection_timeout	google.protobuf.Int64Value Timeout for connection to the Apache Tomcat® server when making read requests. Specify values in seconds. Acceptable values are 5 to 600, inclusive.
upload_timeout	google.protobuf.Int64Value Timeout for connection to the Apache Tomcat® server when making write requests. Specify the values in seconds. Acceptable values are 5 to 600, inclusive.
max_threads	google.protobuf.Int64Value Maximum number of the Apache Tomcat® threads. 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. Acceptable values are 1 to 1024, inclusive.
pool_allow_core_thread_timeout	google.protobuf.BoolValue Determines whether the timeout for core streaming threads is permitted.
pool_core_size	google.protobuf.Int64Value Number of core streaming threads per pool. Acceptable values are 1 to 1024, inclusive.
pool_queue_capacity	google.protobuf.Int64Value Maximum number of requests you can add to a pool queue for core streaming threads. If `0`, no pool queue is generated. The minimum value is 0.
pool_max_size	google.protobuf.Int64Value Maximum allowed number of core streaming threads. Acceptable values are 1 to 1024, inclusive.
xmx	google.protobuf.Int64Value Initial size, in megabytes, of the JVM heap for the PXF daemon. The minimum value is 64.
xms	google.protobuf.Int64Value Maximum size, in megabytes, of the JVM heap for the PXF daemon. The minimum value is 64.

CloudStorage

Cloud Storage Settings

Field

Description

enable

bool

enable Cloud Storage for cluster

LoggingConfig

Field	Description
enabled	bool
folder_id	string Value must match the regular expression `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `folder_id`, `log_group_id`.
log_group_id	string Value must match the regular expression `([a-zA-Z][-a-zA-Z0-9_.]{0,63})?`. Includes only one of the fields `folder_id`, `log_group_id`.
command_center_enabled	bool send Yandex Command Center logs
greenplum_enabled	bool send Greenplum logs
pooler_enabled	bool send Pooler logs

Managed Service for Greenplum® API, gRPC: ClusterService.Create

gRPC requestgRPC request

CreateClusterRequestCreateClusterRequest

GreenplumConfigGreenplumConfig

AccessAccess

MasterSubclusterConfigSpecMasterSubclusterConfigSpec

ResourcesResources

SegmentSubclusterConfigSpecSegmentSubclusterConfigSpec

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

ConfigSpecConfigSpec

GreenplumConfig6GreenplumConfig6

ConnectionPoolerConfigConnectionPoolerConfig

BackgroundActivitiesConfigBackgroundActivitiesConfig

TableSizesTableSizes

BackgroundActivityStartAtBackgroundActivityStartAt

AnalyzeAndVacuumAnalyzeAndVacuum

QueryKillerScriptsQueryKillerScripts

QueryKillerQueryKiller

PXFConfigPXFConfig

CloudStorageCloudStorage

LoggingConfigLoggingConfig

operation.Operationoperation.Operation

CreateClusterMetadataCreateClusterMetadata

ClusterCluster

GreenplumConfigGreenplumConfig

AccessAccess

MonitoringMonitoring

MasterSubclusterConfigMasterSubclusterConfig

ResourcesResources

SegmentSubclusterConfigSegmentSubclusterConfig

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

MaintenanceOperationMaintenanceOperation

ClusterConfigSetClusterConfigSet

GreenplumConfigSet6GreenplumConfigSet6

GreenplumConfig6GreenplumConfig6

ConnectionPoolerConfigSetConnectionPoolerConfigSet

ConnectionPoolerConfigConnectionPoolerConfig

BackgroundActivitiesConfigBackgroundActivitiesConfig

TableSizesTableSizes

BackgroundActivityStartAtBackgroundActivityStartAt

AnalyzeAndVacuumAnalyzeAndVacuum

QueryKillerScriptsQueryKillerScripts

QueryKillerQueryKiller

PXFConfigSetPXFConfigSet

PXFConfigPXFConfig

CloudStorageCloudStorage

LoggingConfigLoggingConfig

Was the article helpful?

gRPC request

CreateClusterRequest

GreenplumConfig

Access

MasterSubclusterConfigSpec

Resources

SegmentSubclusterConfigSpec

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

ConfigSpec

GreenplumConfig6

ConnectionPoolerConfig

BackgroundActivitiesConfig

TableSizes

BackgroundActivityStartAt

AnalyzeAndVacuum

QueryKillerScripts

QueryKiller

PXFConfig

CloudStorage

LoggingConfig

operation.Operation

CreateClusterMetadata

Cluster

GreenplumConfig

Access

Monitoring

MasterSubclusterConfig

Resources

SegmentSubclusterConfig

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

MaintenanceOperation

ClusterConfigSet

GreenplumConfigSet6

GreenplumConfig6

ConnectionPoolerConfigSet

ConnectionPoolerConfig

BackgroundActivitiesConfig

TableSizes

BackgroundActivityStartAt

AnalyzeAndVacuum

QueryKillerScripts

QueryKiller

PXFConfigSet

PXFConfig

CloudStorage

LoggingConfig