Managed Service for Greenplum® API, gRPC: ClusterService
- Calls ClusterService
- Get
- GetClusterRequest
- Cluster
- GreenplumConfig
- Access
- Monitoring
- MasterSubclusterConfig
- Resources
- SegmentSubclusterConfig
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfig6_17
- GreenplumConfigSet6_19
- GreenplumConfig6_19
- GreenplumConfigSet6_21
- GreenplumConfig6_21
- GreenplumConfigSet6_22
- GreenplumConfig6_22
- GreenplumConfigSet6
- GreenplumConfig6
- ConnectionPoolerConfigSet
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfigSet
- PXFConfig
- CloudStorage
- List
- ListClustersRequest
- ListClustersResponse
- Cluster
- GreenplumConfig
- Access
- Monitoring
- MasterSubclusterConfig
- Resources
- SegmentSubclusterConfig
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfig6_17
- GreenplumConfigSet6_19
- GreenplumConfig6_19
- GreenplumConfigSet6_21
- GreenplumConfig6_21
- GreenplumConfigSet6_22
- GreenplumConfig6_22
- GreenplumConfigSet6
- GreenplumConfig6
- ConnectionPoolerConfigSet
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfigSet
- PXFConfig
- CloudStorage
- Create
- CreateClusterRequest
- GreenplumConfig
- Access
- MasterSubclusterConfigSpec
- Resources
- SegmentSubclusterConfigSpec
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- ConfigSpec
- GreenplumConfig6_17
- GreenplumConfig6_19
- GreenplumConfig6_21
- GreenplumConfig6_22
- GreenplumConfig6
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfig
- CloudStorage
- Operation
- CreateClusterMetadata
- Cluster
- Monitoring
- MasterSubclusterConfig
- SegmentSubclusterConfig
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfigSet6_19
- GreenplumConfigSet6_21
- GreenplumConfigSet6_22
- GreenplumConfigSet6
- ConnectionPoolerConfigSet
- PXFConfigSet
- Update
- UpdateClusterRequest
- GreenplumConfig
- Access
- MasterSubclusterConfigSpec
- Resources
- SegmentSubclusterConfigSpec
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- ConfigSpec
- GreenplumConfig6_17
- GreenplumConfig6_19
- GreenplumConfig6_21
- GreenplumConfig6_22
- GreenplumConfig6
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfig
- CloudStorage
- Operation
- UpdateClusterMetadata
- Cluster
- Monitoring
- MasterSubclusterConfig
- SegmentSubclusterConfig
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfigSet6_19
- GreenplumConfigSet6_21
- GreenplumConfigSet6_22
- GreenplumConfigSet6
- ConnectionPoolerConfigSet
- PXFConfigSet
- Expand
- ExpandRequest
- Operation
- AddClusterHostsMetadata
- Cluster
- GreenplumConfig
- Access
- Monitoring
- MasterSubclusterConfig
- Resources
- SegmentSubclusterConfig
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfig6_17
- GreenplumConfigSet6_19
- GreenplumConfig6_19
- GreenplumConfigSet6_21
- GreenplumConfig6_21
- GreenplumConfigSet6_22
- GreenplumConfig6_22
- GreenplumConfigSet6
- GreenplumConfig6
- ConnectionPoolerConfigSet
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfigSet
- PXFConfig
- CloudStorage
- Delete
- Start
- StartClusterRequest
- Operation
- StartClusterMetadata
- Cluster
- GreenplumConfig
- Access
- Monitoring
- MasterSubclusterConfig
- Resources
- SegmentSubclusterConfig
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfig6_17
- GreenplumConfigSet6_19
- GreenplumConfig6_19
- GreenplumConfigSet6_21
- GreenplumConfig6_21
- GreenplumConfigSet6_22
- GreenplumConfig6_22
- GreenplumConfigSet6
- GreenplumConfig6
- ConnectionPoolerConfigSet
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfigSet
- PXFConfig
- CloudStorage
- Stop
- StopClusterRequest
- Operation
- StopClusterMetadata
- Cluster
- GreenplumConfig
- Access
- Monitoring
- MasterSubclusterConfig
- Resources
- SegmentSubclusterConfig
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfig6_17
- GreenplumConfigSet6_19
- GreenplumConfig6_19
- GreenplumConfigSet6_21
- GreenplumConfig6_21
- GreenplumConfigSet6_22
- GreenplumConfig6_22
- GreenplumConfigSet6
- GreenplumConfig6
- ConnectionPoolerConfigSet
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfigSet
- PXFConfig
- CloudStorage
- ListOperations
- ListMasterHosts
- ListSegmentHosts
- ListLogs
- StreamLogs
- ListBackups
- Backup
- BackupClusterRequest
- Operation
- BackupClusterMetadata
- Cluster
- GreenplumConfig
- Access
- Monitoring
- MasterSubclusterConfig
- Resources
- SegmentSubclusterConfig
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfig6_17
- GreenplumConfigSet6_19
- GreenplumConfig6_19
- GreenplumConfigSet6_21
- GreenplumConfig6_21
- GreenplumConfigSet6_22
- GreenplumConfig6_22
- GreenplumConfigSet6
- GreenplumConfig6
- ConnectionPoolerConfigSet
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfigSet
- PXFConfig
- CloudStorage
- Restore
- RestoreClusterRequest
- GreenplumRestoreConfig
- Access
- Resources
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- Operation
- RestoreClusterMetadata
- Cluster
- GreenplumConfig
- Monitoring
- MasterSubclusterConfig
- SegmentSubclusterConfig
- MaintenanceOperation
- ClusterConfigSet
- GreenplumConfigSet6_17
- GreenplumConfig6_17
- GreenplumConfigSet6_19
- GreenplumConfig6_19
- GreenplumConfigSet6_21
- GreenplumConfig6_21
- GreenplumConfigSet6_22
- GreenplumConfig6_22
- GreenplumConfigSet6
- GreenplumConfig6
- ConnectionPoolerConfigSet
- ConnectionPoolerConfig
- BackgroundActivitiesConfig
- TableSizes
- BackgroundActivityStartAt
- AnalyzeAndVacuum
- PXFConfigSet
- PXFConfig
- CloudStorage
A set of methods for managing Greenplum® clusters.
Call | Description |
---|---|
Get | Returns the specified Greenplum® cluster. |
List | Retrieves a list of Greenplum® clusters that belong to the specified folder. |
Create | Creates a Greenplum® cluster in the specified folder. |
Update | Updates the specified Greenplum® cluster. |
Expand | Expands the specified Greenplum® cluster. |
Delete | Deletes the specified Greenplum® cluster. |
Start | Starts the specified Greenplum® cluster. |
Stop | Stops the specified Greenplum® cluster. |
ListOperations | Retrieves the list of Operation resources for the specified cluster. |
ListMasterHosts | Retrieves a list of master hosts for the specified cluster. |
ListSegmentHosts | Retrieves a list of segment hosts for the specified cluster. |
ListLogs | Retrieves logs for the specified Greenplum® cluster. |
StreamLogs | Same as ListLogs but using server-side streaming. |
ListBackups | Retrieves a list of available backups for the specified Greenplum® cluster. |
Backup | Creates a backup for the specified Greenplum cluster. |
Restore | Creates a new Greenplum® cluster using the specified backup. |
Calls ClusterService
Get
Returns the specified Greenplum® cluster.
To get the list of all available Greenplum® clusters, make a List request.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster resource to return. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
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. |
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. |
Monitoring
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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 |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
List
Retrieves a list of Greenplum® clusters that belong to the specified folder.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list Greenplum® clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
|
ListClustersResponse
Field | Description |
---|---|
clusters[] | Cluster List of Greenplum® cluster resources. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
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. |
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. |
Monitoring
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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 |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
Create
Creates a Greenplum® cluster in the specified folder.
rpc Create (CreateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateClusterMetadata
Operation.response:Cluster
CreateClusterRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create the Greenplum® cluster in. The maximum string length in characters is 50. |
name | string Required. 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 | 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 | Cluster.Environment Required. Deployment environment of the Greenplum® cluster. |
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. Owner user name. |
user_password | string Required. Owner user password. The string length in characters must be 8-128. |
network_id | string Required. 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 |
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. |
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. |
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
ConfigSpec
Field | Description |
---|---|
greenplum_config | oneof: greenplum_config_6_17 , greenplum_config_6_19 , greenplum_config_6_21 , greenplum_config_6_22 or greenplum_config_6 |
greenplum_config_6_17 | GreenplumConfig6_17 |
greenplum_config_6_19 | GreenplumConfig6_19 |
greenplum_config_6_21 | GreenplumConfig6_21 |
greenplum_config_6_22 | GreenplumConfig6_22 |
greenplum_config_6 | GreenplumConfig6 |
pool | ConnectionPoolerConfig Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfig |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfig6
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfig
Field | Description |
---|---|
mode | enum PoolMode Route server pool mode.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum® cluster that is being created. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
Monitoring
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. |
SegmentSubclusterConfig
Field | Description |
---|---|
resources | Resources Computational resources allocated to Greenplum® segment subcluster hosts. |
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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. |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
Update
Updates the specified Greenplum® cluster.
rpc Update (UpdateClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateClusterMetadata
Operation.response:Cluster
UpdateClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster resource to update. To get the Greenplum® cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask Field mask that specifies which fields of the Greenplum® cluster resource should be updated. |
description | string New description of the Greenplum® cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the Greenplum® cluster as key:value pairs. For example, "project":"mvp" or "source":"dictionary" . The new set of labels completely replaces the old one. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. 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]* . |
name | string New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
config | GreenplumConfig The Greenplum® cluster configuration. |
master_config | MasterSubclusterConfigSpec Configuration of the Greenplum® master subcluster. |
segment_config | SegmentSubclusterConfigSpec Configuration of the Greenplum® segment subcluster. |
user_password | string Required. Owner user password. The string length in characters must be 8-128. |
maintenance_window | MaintenanceWindow The Greenplum® cluster maintenance window. Should be defined by either one of the two options. |
security_group_ids[] | string User security groups. |
deletion_protection | bool Determines whether the cluster is protected from being deleted. |
config_spec | ConfigSpec Settings of the Greenplum® cluster. |
cloud_storage | CloudStorage Cloud storage settings |
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. |
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. |
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
ConfigSpec
Field | Description |
---|---|
greenplum_config | oneof: greenplum_config_6_17 , greenplum_config_6_19 , greenplum_config_6_21 , greenplum_config_6_22 or greenplum_config_6 |
greenplum_config_6_17 | GreenplumConfig6_17 |
greenplum_config_6_19 | GreenplumConfig6_19 |
greenplum_config_6_21 | GreenplumConfig6_21 |
greenplum_config_6_22 | GreenplumConfig6_22 |
greenplum_config_6 | GreenplumConfig6 |
pool | ConnectionPoolerConfig Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfig |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfig6
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfig
Field | Description |
---|---|
mode | enum PoolMode Route server pool mode.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum® cluster resource that is being updated. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
Monitoring
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. |
SegmentSubclusterConfig
Field | Description |
---|---|
resources | Resources Computational resources allocated to Greenplum® segment subcluster hosts. |
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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. |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
Expand
Expands the specified Greenplum® cluster.
rpc Expand (ExpandRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:AddClusterHostsMetadata
Operation.response:Cluster
ExpandRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum Cluster resource to update. To get the Greenplum cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
segment_host_count | int64 Number of hosts for add to the segment subcluster |
add_segments_per_host_count | int64 Number of segments per host to add |
duration | int64 Redistribute duration, in seconds |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
AddClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum Cluster resource that is being updated. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
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. |
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. |
Monitoring
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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 |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
Delete
Deletes the specified Greenplum® cluster.
rpc Delete (DeleteClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteClusterMetadata
Operation.response:google.protobuf.Empty
DeleteClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster to delete. To get the Greenplum® cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum® cluster that is being deleted. |
Start
Starts the specified Greenplum® cluster.
rpc Start (StartClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StartClusterMetadata
Operation.response:Cluster
StartClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster to start. To get the Greenplum® cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StartClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum® cluster being started. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
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. |
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. |
Monitoring
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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 |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
Stop
Stops the specified Greenplum® cluster.
rpc Stop (StopClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopClusterMetadata
Operation.response:Cluster
StopClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster to stop. To get the Greenplum® cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
StopClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum® cluster being stopped. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
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. |
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. |
Monitoring
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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 |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
ListOperations
Retrieves the list of Operation resources for the specified cluster.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster resource to list operations for. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of Operation resources for the specified Greenplum® cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any 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 |
ListMasterHosts
Retrieves a list of master hosts for the specified cluster.
rpc ListMasterHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster. To get the Greenplum® cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterHostsResponse
Field | Description |
---|---|
hosts[] | Host Requested list of hosts for the cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Host
Field | Description |
---|---|
name | string Required. Name of the Greenplum® host. The host name is assigned by the platform at creation time and cannot be changed. The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host. The maximum string length in characters is 63. |
cluster_id | string ID of the Greenplum® cluster. The ID is assigned by the platform at creation time. |
zone_id | string ID of the availability zone the Greenplum® host belongs to. |
type | enum Type Type of the host.
|
resources | Resources Resources allocated to the Greenplum® host. |
health | enum Health Status code of the aggregated health of the host.
|
subnet_id | string ID of the subnet that the host belongs to. |
assign_public_ip | bool Determines whether a public IP is assigned to the host. |
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 . |
ListSegmentHosts
Retrieves a list of segment hosts for the specified cluster.
rpc ListSegmentHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster. To get the Greenplum® cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterHostsResponse
Field | Description |
---|---|
hosts[] | Host Requested list of hosts for the cluster. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Host
Field | Description |
---|---|
name | string Required. Name of the Greenplum® host. The host name is assigned by the platform at creation time and cannot be changed. The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host. The maximum string length in characters is 63. |
cluster_id | string ID of the Greenplum® cluster. The ID is assigned by the platform at creation time. |
zone_id | string ID of the availability zone the Greenplum® host belongs to. |
type | enum Type Type of the host.
|
resources | Resources Resources allocated to the Greenplum® host. |
health | enum Health Status code of the aggregated health of the host.
|
subnet_id | string ID of the subnet that the host belongs to. |
assign_public_ip | bool Determines whether a public IP is assigned to the host. |
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 . |
ListLogs
Retrieves logs for the specified Greenplum® cluster.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster to request logs for. To get the Greenplum® cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
column_filter[] | string Columns from log table to request. If no columns are specified, entire log records are returned. |
service_type | enum ServiceType Type of the service to request logs about.
|
from_time | google.protobuf.Timestamp Start timestamp for the logs request. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
always_next_page_token | bool The service always returns a ListClusterLogsResponse.next_page_token, even if the current page is empty. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
Examples of a filter:
|
ListClusterLogsResponse
Field | Description |
---|---|
logs[] | LogRecord Requested log records. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. This value is interchangeable with the StreamLogRecord.next_record_token from StreamLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Time when the log was recorded. |
message | map<string,string> Contents of the log record. |
StreamLogs
Same as ListLogs but using server-side streaming. Also allows for tail -f
semantics.
rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)
StreamClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster. The maximum string length in characters is 50. |
column_filter[] | string Columns from log table to get in the response. If no columns are specified, entire log records are returned. |
service_type | enum ServiceType Type of the service to request logs about.
|
from_time | google.protobuf.Timestamp Start timestamp for the logs request. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. If this field is not set, all existing logs are sent as well as the new ones as they appear. In essence it has tail -f semantics. |
record_token | string Record token. Set record_token to the StreamLogs.next_record_token returned by the previous StreamLogs request to start streaming from the next log record. The maximum string length in characters is 100. |
filter | string A filter expression that filters resources listed in the response. The expression must specify:
Examples of a filter:
|
StreamLogRecord
Field | Description |
---|---|
record | LogRecord One of the requested log records. |
next_record_token | string This token allows you to continue streaming logs starting from the exact same record. To do that, specify value of next_record_token as the value for StreamLogs.record_token parameter in the next StreamLogs request. This value is interchangeable with ListLogs.next_page_token from ListLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Time when the log was recorded. |
message | map<string,string> Contents of the log record. |
ListBackups
Retrieves a list of available backups for the specified Greenplum® cluster.
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum® cluster. To get the Greenplum® cluster ID use a ClusterService.List request. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by the previous list request. The maximum string length in characters is 100. |
ListClusterBackupsResponse
Field | Description |
---|---|
backups[] | Backup List of Greenplum® backups. |
next_page_token | string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token query parameter in the next list request. Each subsequent list request has its own next_page_token to continue paging through the results. |
Backup
Field | Description |
---|---|
id | string Required. ID of the backup. |
folder_id | string ID of the folder that the backup belongs to. |
created_at | google.protobuf.Timestamp Time when the backup operation was completed. |
source_cluster_id | string ID of the Greenplum® cluster that the backup was created for. |
started_at | google.protobuf.Timestamp Time when the backup operation was started. |
size | int64 Size of the backup in bytes. |
type | enum BackupCreationType How this backup was created (manual/automatic/etc...)
|
method | enum BackupMethod Method of backup creation
|
journal_size | int64 Size of the journal associated with backup, in bytes |
Backup
Creates a backup for the specified Greenplum cluster.
rpc Backup (BackupClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:BackupClusterMetadata
Operation.response:Cluster
BackupClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the Greenplum cluster to back up. To get the Greenplum cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
BackupClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the Greenplum cluster to back up. |
backup_id | string |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
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. |
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. |
Monitoring
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 |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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 |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |
Restore
Creates a new Greenplum® cluster using the specified backup.
rpc Restore (RestoreClusterRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RestoreClusterMetadata
Operation.response:Cluster
RestoreClusterRequest
Field | Description |
---|---|
backup_id | string Required. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request. |
time | google.protobuf.Timestamp Timestamp of the moment to which the Greenplum cluster should be restored. |
folder_id | string Required. ID of the folder to create the Greenplum® cluster in. The maximum string length in characters is 50. |
name | string Required. 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 | 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 | Cluster.Environment Required. Deployment environment of the Greenplum® cluster. |
config | GreenplumRestoreConfig Greenplum® cluster config. |
master_resources | Resources Resources of the Greenplum® master subcluster. |
segment_resources | Resources Resources of the Greenplum® segment subcluster. |
network_id | string Required. 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 cluster on. |
placement_group_id | string ID of the placement group. |
maintenance_window | MaintenanceWindow A Greenplum® cluster maintenance window. Should be defined by either one of the two options. |
segment_host_count | int64 Number of segment hosts |
segment_in_host | int64 Number of segments on each host |
restore_only[] | string List of databases and tables to restore The maximum number of elements is 50. The maximum string length in characters for each value is 256. Each value must match the regular expression [a-zA-Z0-9\\*_]*(\\/[a-zA-Z0-9\\*_]*){0,2} . |
GreenplumRestoreConfig
Field | Description |
---|---|
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
zone_id | string ID of the availability zone where the host resides. 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 that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id. The maximum string length in characters is 50. |
assign_public_ip | bool Determines whether the host should get a public IP address on creation. After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assign_public_ip set as needed. Possible values:
|
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. |
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 . |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window |
anytime | AnytimeMaintenanceWindow An any-time maintenance window. |
weekly_maintenance_window | WeeklyMaintenanceWindow A weekly maintenance window. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week.
|
hour | int64 Hour of the day in the UTC timezone. Acceptable values are 1 to 24, inclusive. |
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 | google.protobuf.Any 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
RestoreClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the new Greenplum® cluster that is being created from a backup. |
backup_id | string ID of the backup that is being used for creating a cluster. |
Cluster
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. 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 | 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.
|
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.
|
status | enum Status Current state of the cluster.
|
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 |
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. |
Monitoring
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. |
SegmentSubclusterConfig
Field | Description |
---|---|
resources | Resources Computational resources allocated to Greenplum® segment subcluster hosts. |
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 | oneof: greenplum_config_set_6_17 , greenplum_config_set_6_19 , greenplum_config_set_6_21 , greenplum_config_set_6_22 or greenplum_config_set_6 |
greenplum_config_set_6_17 | GreenplumConfigSet6_17 |
greenplum_config_set_6_19 | GreenplumConfigSet6_19 |
greenplum_config_set_6_21 | GreenplumConfigSet6_21 |
greenplum_config_set_6_22 | GreenplumConfigSet6_22 |
greenplum_config_set_6 | GreenplumConfigSet6 |
pool | ConnectionPoolerConfigSet Odyssey® pool settings. |
background_activities | BackgroundActivitiesConfig |
pxf_config | PXFConfigSet |
GreenplumConfigSet6_17
Field | Description |
---|---|
effective_config | GreenplumConfig6_17 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_17 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_17 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_17
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
GreenplumConfigSet6_19
Field | Description |
---|---|
effective_config | GreenplumConfig6_19 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_19 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_19 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_19
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment. |
max_slot_wal_keep_size | google.protobuf.Int64Value The maximum size of WAL files that replication slots are allowed to retain in the pg_wal directory at checkpoint time. More info in PostgreSQL® documentation |
gp_workfile_limit_per_segment | google.protobuf.Int64Value 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 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_per_query | google.protobuf.Int64Value The maximum disk size that an individual query is allowed to use for creating temporary spill files at each segment. The default value is 0 (no limit). More info in Greenplum® documentation |
gp_workfile_limit_files_per_query | google.protobuf.Int64Value The maximum number of temporary spill files allowed per query at each segment. Spill files, also known as workfiles, are created when a query requires more memory than there is allocated. The current query is terminated if the limit is exceeded. Set to zero to disable the limit. Master session reloads if the parameter changes. Default value is 10000. More info in Greenplum® documentation |
max_prepared_transactions | google.protobuf.Int64Value The maximum number of transactions that can be in the prepared state simultaneously. More info in PostgreSQL® documentation |
gp_workfile_compression | google.protobuf.BoolValue Whether the spill files are compressed or not. More info in Greenplum® documentation |
max_statement_mem | google.protobuf.Int64Value The maximum memory limit for a query, in bytes. Helps to 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. Default value is 2097152000 (2000 MB). More info in Greenplum® documentation |
log_statement | enum LogStatement Logged SQL statements. PREPARE and EXPLAIN ANALYZE statements are also logged if their contained command belongs to an appropriate type. More info in Greenplum® documentation
|
GreenplumConfigSet6_21
Field | Description |
---|---|
effective_config | GreenplumConfig6_21 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_21 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_21 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_21
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6_22
Field | Description |
---|---|
effective_config | GreenplumConfig6_22 Required. Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config ). |
user_config | GreenplumConfig6_22 User-defined settings for a Greenplum® cluster. |
default_config | GreenplumConfig6_22 Default configuration for a Greenplum® cluster. |
GreenplumConfig6_22
Field | Description |
---|---|
max_connections | google.protobuf.Int64Value Maximum number of inbound connections on master segment |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_segment |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_per_query |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#gp_workfile_limit_files_per_query Default value is 10000 |
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 |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/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) |
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.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-config_params-guc-list.html#log_statement Default value is ddl
|
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 |
GreenplumConfigSet6
Field | Description |
---|---|
effective_config | GreenplumConfig6 Required. 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 |
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 |
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 |
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 |
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 |
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 |
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) |
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
|
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 |
ConnectionPoolerConfigSet
Field | Description |
---|---|
effective_config | ConnectionPoolerConfig Required. 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.
|
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 Server pool idle timeout, in seconds. A server connection closes after being idle for the specified time. Set to zero to disable the limit. |
BackgroundActivitiesConfig
Field | Description |
---|---|
table_sizes | TableSizes |
analyze_and_vacuum | AnalyzeAndVacuum |
TableSizes
Field | Description |
---|---|
starts[] | BackgroundActivityStartAt The maximum number of elements is 4. |
BackgroundActivityStartAt
Field | Description |
---|---|
hours | int64 Acceptable values are 0 to 23, inclusive. |
minutes | int64 Acceptable values are 0 to 59, inclusive. |
AnalyzeAndVacuum
Field | Description |
---|---|
start | BackgroundActivityStartAt |
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. |
PXFConfigSet
Field | Description |
---|---|
effective_config | PXFConfig Required. |
user_config | PXFConfig User-defined settings |
default_config | PXFConfig Default configuration |
PXFConfig
Field | Description |
---|---|
connection_timeout | google.protobuf.Int64Value Connection Acceptable values are 5 to 600, inclusive. |
upload_timeout | google.protobuf.Int64Value Acceptable values are 5 to 600, inclusive. |
max_threads | google.protobuf.Int64Value Thread pool Acceptable values are 1 to 1024, inclusive. |
pool_allow_core_thread_timeout | google.protobuf.BoolValue |
pool_core_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
pool_queue_capacity | google.protobuf.Int64Value The minimum value is 0. |
pool_max_size | google.protobuf.Int64Value Acceptable values are 1 to 1024, inclusive. |
xmx | google.protobuf.Int64Value JVM Acceptable values are 64 to 16384, inclusive. |
xms | google.protobuf.Int64Value Acceptable values are 64 to 16384, inclusive. |
CloudStorage
Field | Description |
---|---|
enable | bool enable Cloud Storage for cluster |