Managed Service for Greenplum® API, REST: Cluster.Create

Field

Description

folderId

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.

masterConfig

MasterSubclusterConfigSpec

Configuration of the Greenplum® master subcluster.

segmentConfig

SegmentSubclusterConfigSpec

Configuration of the Greenplum® segment subcluster.

masterHostCount

string (int64)

Number of hosts in the master subcluster.

segmentInHost

string (int64)

Number of segments per host.

segmentHostCount

string (int64)

Number of hosts in the segment subcluster.

userName

string

Required field. Owner user name.

userPassword

string

Required field. Owner user password.

The string length in characters must be 8-128.

networkId

string

Required field. ID of the network to create the cluster in.

The maximum string length in characters is 50.

securityGroupIds[]

string

User security groups.

deletionProtection

boolean

Determines whether the cluster is protected from being deleted.

hostGroupIds[]

string

Host groups to place VMs of the cluster in.

maintenanceWindow

MaintenanceWindow

A Greenplum® cluster maintenance window. Should be defined by either one of the two options.

configSpec

ConfigSpec

Configuration of Greenplum® and Odyssey®.

cloudStorage

CloudStorage

Cloud storage settings

masterHostGroupIds[]

string

Host groups hosting VMs of the master subcluster.

segmentHostGroupIds[]

string

Host groups hosting VMs of the segment subcluster.

serviceAccountId

string

ID of the service account used for access Yandex Cloud resources.

logging

LoggingConfig

Cloud logging configuration

Field

Description

version

string

Version of the Greenplum® server software.

backupWindowStart

TimeOfDay

Time to start the daily backup, in the UTC timezone.

backupRetainPeriodDays

string (int64)

Retention policy of automated backups.

Acceptable values are 1 to 60, inclusive.

access

Access

Access policy for external services.

zoneId

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.

subnetId

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.networkId).

The maximum string length in characters is 50.

assignPublicIp

boolean

Determines whether the cluster has a public IP address.

After the cluster has been created, this setting cannot be changed.

fullVersion

string

Full version

Field

Description

hours

integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer (int32)

Minutes of hour of day. Must be from 0 to 59.

seconds

integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.

nanos

integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Field

Description

dataLens

boolean

Allows data export from the cluster to DataLens.

webSql

boolean

Allows SQL queries to the cluster databases from the management console.

dataTransfer

boolean

Allows access for DataTransfer.

yandexQuery

boolean

Allow access for YandexQuery.

Field

Description

resources

Resources

Resources allocated to Greenplum® master subcluster hosts.

Field

Description

resourcePresetId

string

ID of the preset for computational resources allocated to a host.

Available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage used by the host, in bytes.

diskTypeId

string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

Field

Description

resources

Resources

Resources allocated to Greenplum® segment subcluster hosts.

Field

Description

anytime

object

An any-time maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

Field

Description

day

enum (WeekDay)

Day of the week.

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

hour

string (int64)

Hour of the day in the UTC timezone.

Acceptable values are 1 to 24, inclusive.

Field

Description

greenplumConfig_6

GreenplumConfig6

Includes only one of the fields greenplumConfig_6.

pool

ConnectionPoolerConfig

Odyssey® pool settings.

backgroundActivities

BackgroundActivitiesConfig

Managed Greenplum® background tasks configuration.

pxfConfig

PXFConfig

Field

Description

maxConnections

string (int64)

Maximum number of inbound connections on master segment

Acceptable values are 50 to 1000, inclusive.

maxSlotWalKeepSize

string (int64)

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.

gpWorkfileLimitPerSegment

string (int64)

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.

gpWorkfileLimitPerQuery

string (int64)

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.

gpWorkfileLimitFilesPerQuery

string (int64)

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.

maxPreparedTransactions

string (int64)

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.

gpWorkfileCompression

boolean

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

maxStatementMem

string (int64)

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.

logStatement

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.

gpAddColumnInheritsTableSetting

boolean

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

gpEnableGlobalDeadlockDetector

boolean

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

gpGlobalDeadlockDetectorPeriod

string (int64)

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

gpMaxSlices

string (int64)

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.

gpCachedSegworkersThreshold

string (int64)

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.

lockTimeout

string (int64)

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.

idleInTransactionSessionTimeout

string (int64)

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.

runawayDetectorActivationPercent

string (int64)

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.

gpVmemProtectSegworkerCacheLimit

string (int64)

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.

gpEnableZstdMemoryAccounting

boolean

Forces ZSTD lib use Greenplum memory allocation system.

gpMaxPlanSize

string (int64)

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.

gpAutostatsMode

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).

gpAutostatsOnChangeThreshold

string (int64)

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.

gpResourceGroupMemoryLimit

number (double)

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

logConnections

boolean

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

logDisconnections

boolean

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

logHostname

boolean

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

logStatementStats

boolean

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

logMinDurationStatement

string (int64)

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

masterSharedBuffers

string (int64)

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.

maxLocksPerTransaction

string (int64)

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.

segmentSharedBuffers

string (int64)

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.

logErrorVerbosity

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

logMinMessages

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

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

string (int64)

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.

clientIdleTimeout

string (int64)

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.

idleInTransactionTimeout

string (int64)

Client pool idle in transaction timeout, in seconds.

Drop client connection in transaction after this much seconds of idleness.

Set to zero to disable.

Field

Description

tableSizes

TableSizes

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

analyzeAndVacuum

AnalyzeAndVacuum

Configuration for ANALYZE and VACUUM operations.

queryKillerScripts

QueryKillerScripts

Configuration for long running queries killer.

Field

Description

starts[]

BackgroundActivityStartAt

Time when start "table_sizes" script

The maximum number of elements is 4.

Field

Description

hours

string (int64)

hours

Acceptable values are 0 to 23, inclusive.

minutes

string (int64)

minutes

Acceptable values are 0 to 59, inclusive.

Field

Description

start

BackgroundActivityStartAt

Time when analyze will start

analyzeTimeout

string (int64)

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.

vacuumTimeout

string (int64)

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.

Field

Description

idle

QueryKiller

Configuration of script that kills long running queries that are in idle state.

idleInTransaction

QueryKiller

Configuration of script that kills long running queries that are in idle in transaction state.

longRunning

QueryKiller

Configuration of script that kills long running queries (in any state).

Field

Description

enable

boolean

Use query killer or not

maxAge

string (int64)

Maximum duration for this type of queries (in seconds).

Acceptable values are 1 to 86400, inclusive.

ignoreUsers[]

string

Ignore these users when considering queries to terminate

Field

Description

connectionTimeout

string (int64)

Timeout for connection to the Apache Tomcat® server when making read requests.

Specify values in seconds.

Acceptable values are 5 to 600, inclusive.

uploadTimeout

string (int64)

Timeout for connection to the Apache Tomcat® server when making write requests.

Specify the values in seconds.

Acceptable values are 5 to 600, inclusive.

maxThreads

string (int64)

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.

poolAllowCoreThreadTimeout

boolean

Determines whether the timeout for core streaming threads is permitted.

poolCoreSize

string (int64)

Number of core streaming threads per pool.

Acceptable values are 1 to 1024, inclusive.

poolQueueCapacity

string (int64)

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.

poolMaxSize

string (int64)

Maximum allowed number of core streaming threads.

Acceptable values are 1 to 1024, inclusive.

xmx

string (int64)

Initial size, in megabytes, of the JVM heap for the PXF daemon.

The minimum value is 64.

xms

string (int64)

Maximum size, in megabytes, of the JVM heap for the PXF daemon.

The minimum value is 64.

Field

Description

enable

boolean

enable Cloud Storage for cluster

Field

Description

enabled

boolean

folderId

string

Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.

Includes only one of the fields folderId, logGroupId.

logGroupId

string

Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.

Includes only one of the fields folderId, logGroupId.

commandCenterEnabled

boolean

send Yandex Command Center logs

greenplumEnabled

boolean

send Greenplum logs

poolerEnabled

boolean

send Pooler logs

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

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

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

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.

Field

Description

clusterId

string

ID of the Greenplum® cluster that is being created.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

ID of the Greenplum® cluster.
This ID is assigned by the platform at the moment of cluster creation.

folderId

string

ID of the folder that the Greenplum® cluster belongs to.

createdAt

string (date-time)

Time when the cluster was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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.

masterConfig

MasterSubclusterConfig

Configuration of the Greenplum® master subcluster.

segmentConfig

SegmentSubclusterConfig

Configuration of the Greenplum® segment subcluster.

masterHostCount

string (int64)

Number of hosts in the master subcluster.

segmentHostCount

string (int64)

Number of hosts in the segment subcluster.

segmentInHost

string (int64)

Number of segments per host.

networkId

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.

maintenanceWindow

MaintenanceWindow

A Greenplum® cluster maintenance window. Should be defined by either one of the two options.

plannedOperation

MaintenanceOperation

Maintenance operation planned at nearest maintenanceWindow.

securityGroupIds[]

string

User security groups.

userName

string

Owner user name.

deletionProtection

boolean

Determines whether the cluster is protected from being deleted.

hostGroupIds[]

string

Host groups hosting VMs of the cluster.

clusterConfig

ClusterConfigSet

Greenplum® and Odyssey® configuration.

cloudStorage

CloudStorage

Cloud storage settings

masterHostGroupIds[]

string

Host groups hosting VMs of the master subcluster.

segmentHostGroupIds[]

string

Host groups hosting VMs of the segment subcluster.

serviceAccountId

string

Service account that will be used to access a Yandex Cloud resources

logging

LoggingConfig

Cloud logging configuration

Field

Description

version

string

Version of the Greenplum® server software.

backupWindowStart

TimeOfDay

Time to start the daily backup, in the UTC timezone.

backupRetainPeriodDays

string (int64)

Retention policy of automated backups.

Acceptable values are 1 to 60, inclusive.

access

Access

Access policy for external services.

zoneId

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.

subnetId

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.networkId).

The maximum string length in characters is 50.

assignPublicIp

boolean

Determines whether the cluster has a public IP address.

After the cluster has been created, this setting cannot be changed.

fullVersion

string

Full version

Field

Description

hours

integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer (int32)

Minutes of hour of day. Must be from 0 to 59.

seconds

integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.

nanos

integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Field

Description

dataLens

boolean

Allows data export from the cluster to DataLens.

webSql

boolean

Allows SQL queries to the cluster databases from the management console.

dataTransfer

boolean

Allows access for DataTransfer.

yandexQuery

boolean

Allow access for YandexQuery.

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.

Field

Description

resources

Resources

Computational resources allocated to Greenplum® master subcluster hosts.

Field

Description

resourcePresetId

string

ID of the preset for computational resources allocated to a host.

Available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage used by the host, in bytes.

diskTypeId

string

Type of the storage used by the host: network-hdd, network-ssd or local-ssd.

Field

Description

resources

Resources

Computational resources allocated to Greenplum® segment subcluster hosts.

Field

Description

anytime

object

An any-time maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

A weekly maintenance window.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

Field

Description

day

enum (WeekDay)

Day of the week.

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

hour

string (int64)

Hour of the day in the UTC timezone.

Acceptable values are 1 to 24, inclusive.

Field

Description

info

string

The description of the operation.

The maximum string length in characters is 256.

delayedUntil

string (date-time)

Delay time for the maintenance operation.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Field

Description

greenplumConfigSet_6

GreenplumConfigSet6

Includes only one of the fields greenplumConfigSet_6.

pool

ConnectionPoolerConfigSet

Odyssey® pool settings.

backgroundActivities

BackgroundActivitiesConfig

Managed Greenplum® background tasks configuration.

pxfConfig

PXFConfigSet

Field

Description

effectiveConfig

GreenplumConfig6

Required field. Effective settings for a Greenplum (a combination of settings defined
in userConfig and defaultConfig).

userConfig

GreenplumConfig6

User-defined settings for a Greenplum.

defaultConfig

GreenplumConfig6

Default configuration for a Greenplum.

Field

Description

maxConnections

string (int64)

Maximum number of inbound connections on master segment

Acceptable values are 50 to 1000, inclusive.

maxSlotWalKeepSize

string (int64)

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.

gpWorkfileLimitPerSegment

string (int64)

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.

gpWorkfileLimitPerQuery

string (int64)

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.

gpWorkfileLimitFilesPerQuery

string (int64)

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.

maxPreparedTransactions

string (int64)

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.

gpWorkfileCompression

boolean

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

maxStatementMem

string (int64)

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.

logStatement

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.

gpAddColumnInheritsTableSetting

boolean

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

gpEnableGlobalDeadlockDetector

boolean

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

gpGlobalDeadlockDetectorPeriod

string (int64)

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

gpMaxSlices

string (int64)

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.

gpCachedSegworkersThreshold

string (int64)

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.

lockTimeout

string (int64)

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.

idleInTransactionSessionTimeout

string (int64)

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.

runawayDetectorActivationPercent

string (int64)

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.

gpVmemProtectSegworkerCacheLimit

string (int64)

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.

gpEnableZstdMemoryAccounting

boolean

Forces ZSTD lib use Greenplum memory allocation system.

gpMaxPlanSize

string (int64)

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.

gpAutostatsMode

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).

gpAutostatsOnChangeThreshold

string (int64)

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.

gpResourceGroupMemoryLimit

number (double)

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

logConnections

boolean

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

logDisconnections

boolean

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

logHostname

boolean

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

logStatementStats

boolean

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

logMinDurationStatement

string (int64)

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

masterSharedBuffers

string (int64)

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.

maxLocksPerTransaction

string (int64)

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.

segmentSharedBuffers

string (int64)

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.

logErrorVerbosity

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

logMinMessages

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

Field

Description

effectiveConfig

ConnectionPoolerConfig

Required field. Effective settings for an Odyssey® pooler (a combination of settings defined in ConnectionPoolerConfigSet.userConfig and ConnectionPoolerConfigSet.defaultConfig).

userConfig

ConnectionPoolerConfig

User-defined settings for an Odyssey® pooler.

defaultConfig

ConnectionPoolerConfig

Default configuration for an Odyssey® pooler.

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

string (int64)

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.

clientIdleTimeout

string (int64)

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.

idleInTransactionTimeout

string (int64)

Client pool idle in transaction timeout, in seconds.

Drop client connection in transaction after this much seconds of idleness.

Set to zero to disable.

Field

Description

tableSizes

TableSizes

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

analyzeAndVacuum

AnalyzeAndVacuum

Configuration for ANALYZE and VACUUM operations.

queryKillerScripts

QueryKillerScripts

Configuration for long running queries killer.

Field

Description

starts[]

BackgroundActivityStartAt

Time when start "table_sizes" script

The maximum number of elements is 4.

Field

Description

hours

string (int64)

hours

Acceptable values are 0 to 23, inclusive.

minutes

string (int64)

minutes

Acceptable values are 0 to 59, inclusive.

Field

Description

start

BackgroundActivityStartAt

Time when analyze will start

analyzeTimeout

string (int64)

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.

vacuumTimeout

string (int64)

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.

Field

Description

idle

QueryKiller

Configuration of script that kills long running queries that are in idle state.

idleInTransaction

QueryKiller

Configuration of script that kills long running queries that are in idle in transaction state.

longRunning

QueryKiller

Configuration of script that kills long running queries (in any state).

Field

Description

enable

boolean

Use query killer or not

maxAge

string (int64)

Maximum duration for this type of queries (in seconds).

Acceptable values are 1 to 86400, inclusive.

ignoreUsers[]

string

Ignore these users when considering queries to terminate

Field

Description

effectiveConfig

PXFConfig

Required field.

userConfig

PXFConfig

User-defined settings.

defaultConfig

PXFConfig

Default configuration.

Field

Description

connectionTimeout

string (int64)

Timeout for connection to the Apache Tomcat® server when making read requests.

Specify values in seconds.

Acceptable values are 5 to 600, inclusive.

uploadTimeout

string (int64)

Timeout for connection to the Apache Tomcat® server when making write requests.

Specify the values in seconds.

Acceptable values are 5 to 600, inclusive.

maxThreads

string (int64)

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.

poolAllowCoreThreadTimeout

boolean

Determines whether the timeout for core streaming threads is permitted.

poolCoreSize

string (int64)

Number of core streaming threads per pool.

Acceptable values are 1 to 1024, inclusive.

poolQueueCapacity

string (int64)

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.

poolMaxSize

string (int64)

Maximum allowed number of core streaming threads.

Acceptable values are 1 to 1024, inclusive.

xmx

string (int64)

Initial size, in megabytes, of the JVM heap for the PXF daemon.

The minimum value is 64.

xms

string (int64)

Maximum size, in megabytes, of the JVM heap for the PXF daemon.

The minimum value is 64.

Field

Description

enable

boolean

enable Cloud Storage for cluster

Field

Description

enabled

boolean

folderId

string

Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.

Includes only one of the fields folderId, logGroupId.

logGroupId

string

Value must match the regular expression ([a-zA-Z][-a-zA-Z0-9_.]{0,63})?.

Includes only one of the fields folderId, logGroupId.

commandCenterEnabled

boolean

send Yandex Command Center logs

greenplumEnabled

boolean

send Greenplum logs

poolerEnabled

boolean

send Pooler logs