Skip to main content

types

Access​

dataLens : bool​

Allows data export from the cluster to DataLens.

webSql : bool​

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

dataTransfer : bool​

Allows access for DataTransfer.

yandexQuery : bool​

Allow access for YandexQuery.

AnalyzeAndVacuum​

start : BackgroundActivityStartAt​
analyzeTimeout : 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.

vacuumTimeout : 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.

AnytimeMaintenanceWindow​

An any-time maintenance window.

BackgroundActivitiesConfig​

tableSizes : TableSizes​

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

analyzeAndVacuum : AnalyzeAndVacuum​

Configuration for ANALYZE and VACUUM operations.

queryKillerScripts : QueryKillerScripts​

Configuration for long running queries killer.

BackgroundActivityStartAt​

hours : int64​
minutes : int64​

Backup​

BackupMethod​

  • BACKUP_METHOD_UNSPECIFIED

  • BASE

    Base backup

  • INCREMENTAL

    Delta (incremental) Greenplum backup

BackupCreationType​

  • BACKUP_CREATION_TYPE_UNSPECIFIED

  • AUTOMATED

    Backup created by automated daily schedule

  • MANUAL

    Backup created by user request

id : string​

Required. ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp​

Time when the backup operation was completed.

sourceClusterId : string​

ID of the Greenplum® cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Time when the backup operation was started.

size : int64​

Size of the backup in bytes.

type : BackupCreationType​

How this backup was created (manual/automatic/etc...)

method : BackupMethod​

Method of backup creation

journalSize : int64​

Size of the journal associated with backup, in bytes

CloudStorage​

Cloud Storage Settings

enable : bool​

enable Cloud Storage for cluster

Cluster​

A Greenplum® cluster resource.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    Health of the cluster is unknown ([Host.health][1] for every host in the cluster is UNKNOWN).

  • ALIVE

    Cluster is working normally ([Host.health][2] for every host in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][3] for every host in the cluster is DEAD).

  • DEGRADED

    Cluster is working below capacity ([Host.health][4] for at least one host in the cluster is not ALIVE).

  • UNBALANCED

    Cluster is working below capacity ([Host.health][5] for at least one host in the cluster is UNBALANCED).

Status​

  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster has encountered a problem and cannot operate.

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster has stopped.

  • STARTING

    Cluster is starting.

id : string​

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

folderId : string​

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

createdAt : google.protobuf.Timestamp​

Time when the cluster was created.

name : string​

Name of the Greenplum® cluster. The name is unique within the folder.

config : GreenplumConfig​

Greenplum® cluster configuration.

description : string​

Description of the Greenplum® cluster.

labels : string​

Custom labels for the Greenplum® cluster as key:value pairs. Maximum 64 labels per resource.

environment : Environment​

Deployment environment of the Greenplum® cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the Greenplum® cluster.

masterConfig : MasterSubclusterConfig​

Configuration of the Greenplum® master subcluster.

segmentConfig : SegmentSubclusterConfig​

Configuration of the Greenplum® segment subcluster.

masterHostCount : int64​

Number of hosts in the master subcluster.

segmentHostCount : int64​

Number of hosts in the segment subcluster.

segmentInHost : int64​

Number of segments per host.

networkId : string​

ID of the cloud network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

maintenanceWindow : MaintenanceWindow​

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

plannedOperation : MaintenanceOperation​

Maintenance operation planned at nearest maintenance_window.

securityGroupIds : string​

User security groups.

userName : string​

Owner user name.

deletionProtection : bool​

Determines whether the cluster is protected from being deleted.

hostGroupIds : string​

Host groups hosting VMs of the cluster.

clusterConfig : ClusterConfigSet​

Greenplum® and Odyssey® configuration.

cloudStorage : CloudStorage​

Cloud storage settings

masterHostGroupIds : string​

Host groups hosting VMs of the master subcluster.

segmentHostGroupIds : string​

Host groups hosting VMs of the segment subcluster.

ClusterConfigSet​

One of greenplumConfig​

  • greenplumConfigSet_6_17 : GreenplumConfigSet6_17​
  • greenplumConfigSet_6_19 : GreenplumConfigSet6_19​
  • greenplumConfigSet_6_21 : GreenplumConfigSet6_21​
  • greenplumConfigSet_6_22 : GreenplumConfigSet6_22​
  • greenplumConfigSet_6 : GreenplumConfigSet6​
pool : ConnectionPoolerConfigSet​

Odyssey® pool settings.

backgroundActivities : BackgroundActivitiesConfig​

Managed Greenplum® background tasks configuration.

pxfConfig : PXFConfigSet​

ConnectionPoolerConfig​

PoolMode​

  • POOL_MODE_UNSPECIFIED

  • SESSION

    Assign server connection to a client until it disconnects. Default value.

  • TRANSACTION

    Assign server connection to a client for a transaction processing.

mode : 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.

clientIdleTimeout : 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.

ConnectionPoolerConfigSet​

effectiveConfig : ConnectionPoolerConfig​

Effective settings for an Odyssey® pooler (a combination of settings defined in ConnectionPoolerConfigSet.user_config and ConnectionPoolerConfigSet.default_config).

userConfig : ConnectionPoolerConfig​

User-defined settings for an Odyssey® pooler.

defaultConfig : ConnectionPoolerConfig​

Default configuration for an Odyssey® pooler.

GreenplumConfig​

version : string​

Version of the Greenplum® server software.

backupWindowStart : google.type.TimeOfDay​

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

backupRetainPeriodDays : google.protobuf.Int64Value​

Retention policy of automated backups.

access : Access​

Access policy for external services.

zoneId : string​

ID of the availability zone the cluster belongs to. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.

subnetId : string​

ID of the subnet the cluster belongs to. This subnet should be a part of the cloud network the cluster belongs to (see Cluster.network_id).

assignPublicIp : bool​

Determines whether the cluster has a public IP address.

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

GreenplumConfig6​

maxConnections : google.protobuf.Int64Value​

Maximum number of inbound connections on master segment

maxSlotWalKeepSize : 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

gpWorkfileLimitPerSegment : 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

gpWorkfileLimitPerQuery : 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

gpWorkfileLimitFilesPerQuery : 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

maxPreparedTransactions : 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

gpWorkfileCompression : 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

maxStatementMem : 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)

logStatement : 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

gpAddColumnInheritsTableSetting : 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_17​

maxConnections : google.protobuf.Int64Value​

Maximum number of inbound connections on master segment.

maxSlotWalKeepSize : 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.

gpWorkfileLimitPerSegment : 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.

gpWorkfileLimitPerQuery : 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.

gpWorkfileLimitFilesPerQuery : 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.

maxPreparedTransactions : google.protobuf.Int64Value​

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.

gpWorkfileCompression : google.protobuf.BoolValue​

Whether the spill files are compressed or not.

More info in Greenplum® documentation.

GreenplumConfig6_19​

maxConnections : google.protobuf.Int64Value​

Maximum number of inbound connections on master segment.

maxSlotWalKeepSize : 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.

gpWorkfileLimitPerSegment : 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.

gpWorkfileLimitPerQuery : 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.

gpWorkfileLimitFilesPerQuery : 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.

maxPreparedTransactions : google.protobuf.Int64Value​

The maximum number of transactions that can be in the prepared state simultaneously.

More info in PostgreSQL® documentation.

gpWorkfileCompression : google.protobuf.BoolValue​

Whether the spill files are compressed or not.

More info in Greenplum® documentation.

maxStatementMem : 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.

logStatement : 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​

maxConnections : google.protobuf.Int64Value​

Maximum number of inbound connections on master segment

maxSlotWalKeepSize : 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

gpWorkfileLimitPerSegment : 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

gpWorkfileLimitPerQuery : 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

gpWorkfileLimitFilesPerQuery : 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

maxPreparedTransactions : 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

gpWorkfileCompression : 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

maxStatementMem : 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)

logStatement : 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

gpAddColumnInheritsTableSetting : 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​

maxConnections : google.protobuf.Int64Value​

Maximum number of inbound connections on master segment

maxSlotWalKeepSize : 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

gpWorkfileLimitPerSegment : 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

gpWorkfileLimitPerQuery : 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

gpWorkfileLimitFilesPerQuery : 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

maxPreparedTransactions : 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

gpWorkfileCompression : 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

maxStatementMem : 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)

logStatement : 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

gpAddColumnInheritsTableSetting : 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​

effectiveConfig : GreenplumConfig6​

Effective settings for a Greenplum (a combination of settings defined in user_config and default_config).

userConfig : GreenplumConfig6​

User-defined settings for a Greenplum.

defaultConfig : GreenplumConfig6​

Default configuration for a Greenplum.

GreenplumConfigSet6_17​

Configuration settings version 6.17

effectiveConfig : GreenplumConfig6_17​

Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config).

userConfig : GreenplumConfig6_17​

User-defined settings for a Greenplum® cluster.

defaultConfig : GreenplumConfig6_17​

Default configuration for a Greenplum® cluster.

GreenplumConfigSet6_19​

Configuration settings version 6.19

effectiveConfig : GreenplumConfig6_19​

Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config).

userConfig : GreenplumConfig6_19​

User-defined settings for a Greenplum® cluster.

defaultConfig : GreenplumConfig6_19​

Default configuration for a Greenplum® cluster.

GreenplumConfigSet6_21​

effectiveConfig : GreenplumConfig6_21​

Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config).

userConfig : GreenplumConfig6_21​

User-defined settings for a Greenplum® cluster.

defaultConfig : GreenplumConfig6_21​

Default configuration for a Greenplum® cluster.

GreenplumConfigSet6_22​

effectiveConfig : GreenplumConfig6_22​

Effective settings for a Greenplum® cluster (a combination of settings defined in user_config and default_config).

userConfig : GreenplumConfig6_22​

User-defined settings for a Greenplum® cluster.

defaultConfig : GreenplumConfig6_22​

Default configuration for a Greenplum® cluster.

GreenplumRestoreConfig​

backupWindowStart : google.type.TimeOfDay​

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

access : Access​

Access policy for external services.

zoneId : 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.

subnetId : 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.

assignPublicIp : 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:

  • false - do not assign a public IP to the master host.
  • true - assign a public IP to the master host.

HBARule​

ConnectionType​

  • CONNECTION_TYPE_UNSPECIFIED

  • HOST

    Matches connection attempts made using TCP/IP.

  • HOSTSSL

    Matches connection attempts made using TCP/IP, but only when the connection is made with SSL encryption.

  • HOSTNOSSL

    Matches connection attempts made over TCP/IP that do not use SSL.

AuthMethod​

  • AUTH_METHOD_UNSPECIFIED

  • MD5

    Perform SCRAM-SHA-256 or MD5 authentication to verify the user's password.

  • LDAP

    Perform LDAP authentication, if MDB_GREENPLUM_LDAP flag is set

  • REJECT

    Disable authentication

priority : int64​

Priority of the Greenplum cluster rule.

connectionType : ConnectionType​
database : string​

Specifies which database names this record matches.

user : string​

Specifies which database role names this user matches.

address : string​

Specifies the client machine addresses that this record matches.

authMethod : AuthMethod​

Specifies the authentication method to use when a connection matches this record. https://gpdb.docs.pivotal.io/6-6/security-guide/topics/Authenticate.html

Host​

A Greenplum® cluster host resource.

Type​

  • TYPE_UNSPECIFIED

    Host type is not specified. Default value.

  • MASTER

    A Greenplum® master host.

  • REPLICA

    A Greenplum® master replica host.

  • SEGMENT

    A Greenplum® segment host.

Health​

  • UNKNOWN

    Health of the host is unknown. Default value.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable and cannot perform any of its essential functions.

  • DEGRADED

    The host is working below capacity or not fully functional.

  • UNBALANCED

    One or more segments are not in the preferred role.

name : string​

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.

clusterId : string​

ID of the Greenplum® cluster. The ID is assigned by the platform at creation time.

zoneId : string​

ID of the availability zone the Greenplum® host belongs to.

type : Type​

Type of the host. If the field has default value, it is not returned in the response.

resources : Resources​

Resources allocated to the Greenplum® host.

health : Health​

Aggregated health of the host. If the field has default value, it is not returned in the response.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Determines whether a public IP is assigned to the host.

MaintenanceOperation​

info : string​

The description of the operation.

delayedUntil : google.protobuf.Timestamp​

Delay time for the maintenance operation.

MaintenanceWindow​

One of policy​

  • anytime : AnytimeMaintenanceWindow​

    An any-time maintenance window.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    A weekly maintenance window.

MasterSubclusterConfig​

resources : Resources​

Computational resources allocated to Greenplum® master subcluster hosts.

Monitoring​

Monitoring system metadata.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the Greenplum® cluster.

PXFConfig​

connectionTimeout : google.protobuf.Int64Value​

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

Specify values in seconds.

uploadTimeout : google.protobuf.Int64Value​

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

Specify the values in seconds.

maxThreads : google.protobuf.Int64Value​

Maximum number of the Apache Tomcat® threads.

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

poolAllowCoreThreadTimeout : google.protobuf.BoolValue​

Determines whether the timeout for core streaming threads is permitted.

poolCoreSize : google.protobuf.Int64Value​

Number of core streaming threads per pool.

poolQueueCapacity : google.protobuf.Int64Value​

Maximum number of requests you can add to a pool queue for core streaming threads.

If 0, no pool queue is generated.

poolMaxSize : google.protobuf.Int64Value​

Maximum allowed number of core streaming threads.

xmx : google.protobuf.Int64Value​

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

xms : google.protobuf.Int64Value​

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

PXFConfigSet​

effectiveConfig : PXFConfig​
userConfig : PXFConfig​

User-defined settings.

defaultConfig : PXFConfig​

Default configuration.

PXFDatasource​

name : string​

Data source name.

One of settings​

  • s3 : PXFDatasourceS3​

    Settings of an external S3 data source.

  • jdbc : PXFDatasourceJDBC​

    Settings of an external JDBC data source.

  • hdfs : PXFDatasourceHDFS​

    Settings of an external HDFS data source.

  • hive : PXFDatasourceHive​

    Settings of an external Hive data source.

PXFDatasourceCore​

defaultFs : string​

URI whose scheme and authority determine the file system implementation.

securityAuthToLocal : string​

Rules for mapping Kerberos principals to operating system user accounts.

PXFDatasourceHDFS​

core : PXFDatasourceCore​

Settings of the file system and security rules.

kerberos : PXFDatasourceKerberos​

Settings of the Kerberos network authentication protocol.

userImpersonation : google.protobuf.BoolValue​

Enables authentication on behalf of the Greenplum® user when connecting to the remote file storage or DBMS.

The authentication is disabled by default.

username : string​

Login username for the remote file storage or DBMS if authentication on behalf of the Greenplum® user is enabled.

saslConnectionRetries : google.protobuf.Int64Value​

Maximum number of times that PXF retries a SASL connection request after a refused connection returns a GSS initiate failed error.

The default value is 5.

zkHosts : string​

ZooKeeper server hosts.

Specify values in the <address>:<port> format.

dfs : PXFDatasourceHDFSDfs​

Settings of the distributed file system.

yarn : PXFDatasourceHDFSYarn​

Settings of the ResourceManager service that is responsible for tracking resources in a cluster and scheduling applications (e.g., MapReduce jobs).

PXFDatasourceHDFSDfs​

haAutomaticFailoverEnabled : google.protobuf.BoolValue​

Determines whether automatic failover is enabled for the high availability of the file system.

The automatic failover is enabled by default.

blockAccessTokenEnabled : google.protobuf.BoolValue​

If true, access tokens are used as capabilities for accessing datanodes. If false, no access tokens are checked on accessing datanodes.

The check of access tokens is enabled by default.

useDatanodeHostname : google.protobuf.BoolValue​

Determines whether the datanode hostname is used when connecting to datanodes.

namenodes : PXFDatasourceHDFSDfsNamenode​

List of HDFS service logical names.

Specify them separated by commas. The names can be arbitrary.

nameservices : string​

Corresponds well-known HDFS client setting "dfs.nameservices" for this datasource

PXFDatasourceHDFSDfsNamenode​

rpcAddress : string​
serviceRpcAddress : string​
httpAddress : string​
httpsAddress : string​

PXFDatasourceHDFSYarn​

resourcemanagerHaEnabled : google.protobuf.BoolValue​

Determines whether high availability is enabled for YARN's ResourceManager services.

The high availability is enabled by default.

resourcemanagerHaAutoFailoverEnabled : google.protobuf.BoolValue​

Determines whether another ResourceManager should automatically become active when the active ResourceManager has failed and does not respond.

The switch of ResourceManagers is enabled by default if the high availability is enabled.

resourcemanagerHaAutoFailoverEmbedded : google.protobuf.BoolValue​

Determines whether the embedded ActiveStandbyElector method should be used for the election of the active ResourceManager. If the current active ResourceManager has failed and does not respond, the ActiveStandbyElector method makes another ResourceManager active which then takes over.

resourcemanagerClusterId : string​

Cluster ID. Specify it, so the ResourceManager service does not become active for a different cluster.

haRm : PXFDatasourceHDFSYarnHaRm​

Highly available ResourceManager service.

PXFDatasourceHDFSYarnHaRm​

resourcemanagerAddress : string​
resourcemanagerSchedulerAddress : string​
resourcemanagerResourceTrackerAddress : string​
resourcemanagerAdminAddress : string​
resourcemanagerWebappAddress : string​
resourcemanagerWebappHttpsAddress : string​

PXFDatasourceHive​

core : PXFDatasourceCore​

Settings of the file system and security rules.

kerberos : PXFDatasourceKerberos​

Settings of the Kerberos network authentication protocol.

userImpersonation : google.protobuf.BoolValue​

Enables authentication on behalf of the Greenplum® user when connecting to the remote file storage or DBMS.

The authentication is disabled by default.

username : string​

Login username for the remote file storage or DBMS if authentication on behalf of the Greenplum® user is enabled.

saslConnectionRetries : google.protobuf.Int64Value​

Maximum number of times that PXF retries a SASL connection request after a refused connection returns a GSS initiate failed error.

The default value is 5.

zkHosts : string​

ZooKeeper server hosts.

Specify values in the <address>:<port> format.

ppd : google.protobuf.BoolValue​

Specifies if predicate pushdown is enabled for queries on external tables.

The predicate pushdown is enabled by default.

metastoreUris : string​

List of URIs separated by commas. To request metadata, the remote DBMS connects to Metastore by one of these URIs.

metastoreKerberosPrincipal : string​

Service principal for the Metastore Thrift server.

authKerberosPrincipal : string​

Kerberos server principal.

PXFDatasourceJDBC​

driver : string​

JDBC driver class in Java. The possible values are the following:

  • com.simba.athena.jdbc.Driver
  • com.clickhouse.jdbc.ClickHouseDriver
  • com.ibm.as400.access.AS400JDBCDriver
  • com.microsoft.sqlserver.jdbc.SQLServerDriver
  • com.mysql.cj.jdbc.Driver
  • org.postgresql.Driver
  • oracle.jdbc.driver.OracleDriver
  • net.snowflake.client.jdbc.SnowflakeDriver
  • io.trino.jdbc.TrinoDriver
url : string​

URL that the JDBC driver uses to connect to the database. Examples:

  • jdbc:mysql://mysqlhost:3306/testdb: Local MySQL DB.
  • jdbc:postgresql://c-<cluster_id>.rw.mdb.yandexcloud.net:6432/db1: Managed Service for PostgreSQL cluster. The address contains the special FQDN of the cluster's master.
  • jdbc:oracle:thin:@host.example:1521:orcl: Oracle DB.
user : string​

Username of the DB owner.

password : string​

Password of the DB owner.

statementBatchSize : google.protobuf.Int64Value​

Number of rows to read in an external table, in a batch.

The default value is 100.

statementFetchSize : google.protobuf.Int64Value​

Number of rows to fetch (buffer) when reading from an external table.

The default value is 1000.

statementQueryTimeout : google.protobuf.Int64Value​

Amount of time (in seconds) the JDBC driver waits for a statement to run. This timeout applies to statements created for both read and write operations.

The default value is 60.

poolEnabled : google.protobuf.BoolValue​

Determines whether JDBC connection pooling is used in a server configuration. By default, it is used.

poolMaximumSize : google.protobuf.Int64Value​

Maximum number of connections to the DB backend.

The default value is 5.

poolConnectionTimeout : google.protobuf.Int64Value​

Maximum time, in milliseconds, to wait for a connection from the pool.

The default value is 30000.

poolIdleTimeout : google.protobuf.Int64Value​

Maximum amount of time, in milliseconds, after which an inactive connection is considered idle.

The default value is 30000.

poolMinimumIdle : google.protobuf.Int64Value​

Minimum number of idle connections maintained in the connection pool.

The default value is 0.

PXFDatasourceKerberos​

enable : google.protobuf.BoolValue​

Determines whether the Kerberos authentication server is used. By default, it is not used.

primary : string​

Host of the primary KDC server (Key Distribution Center).

realm : string​

Kerberos realm for a Greenplum® DB.

kdcServers : string​

KDC server hosts.

adminServer : string​

Administration server host. Usually, this is the primary Kerberos server.

defaultDomain : string​

Domain that is used for the host name extension. Applicable when Kerberos 4 service members become Kerberos 5 service members (for example, when rcmd.hostname is replaced with host/hostname.domain).

keytabBase64 : string​

Base64 encoded contents of the keytab file.

PXFDatasourceS3​

accessKey : string​

Public key to access S3 storage.

secretKey : string​

Secret key to access S3 storage.

fastUpload : google.protobuf.BoolValue​

Manages a fast upload of big files to S3 storage. In case of the false value, the PXF generates files on disk before sending them to the S3 storage. In case of the true value, the PXF generates files in RAM (the PXF writes to disc only if there is not enough RAM).

The fast upload is enabled by default.

endpoint : string​

S3 storage address. The default value is storage.yandexcloud.net used for Yandex Object Storage.

QueryKiller​

enable : google.protobuf.BoolValue​
maxAge : google.protobuf.Int64Value​

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

ignoreUsers : string​

Ignore these users when considering queries to terminate

QueryKillerScripts​

idle : QueryKiller​

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

idleInTransaction : QueryKiller​

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

longRunning : QueryKiller​

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

ResourcePreset​

A preset of resources for hardware configuration of Greenplum® hosts.

Type​

  • TYPE_UNSPECIFIED

  • MASTER

    Greenplum® master host.

  • SEGMENT

    Greenplum® segment host.

id : string​

ID of the resource preset.

zoneIds : string​

IDs of availability zones where the resource preset is available.

diskTypeIds : string​

IDs of availability disk types available in the resource preset.

cores : int64​

Number of CPU cores for a Greenplum® host created with the preset.

memory : int64​

RAM volume for a Greenplum® host created with the preset, in bytes.

type : Type​

Host type.

hostCountDivider : int64​

The number of hosts must be divisible by host_count_divider.

maxSegmentInHostCount : int64​

Maximum number of segments in segment host.

Resources​

resourcePresetId : string​

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

Available presets are listed in the documentation.

diskSize : int64​

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

diskTypeId : string​

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

RestoreResources​

resourcePresetId : string​

ID of the preset for computational resources available to a host (CPU, memory, etc.).

diskSize : int64​

Volume of the storage available to a host.

SegmentSubclusterConfig​

resources : Resources​

Computational resources allocated to Greenplum® segment subcluster hosts.

TableSizes​

starts : BackgroundActivityStartAt​

WeeklyMaintenanceWindow​

A weekly maintenance window.

WeekDay​

  • WEEK_DAY_UNSPECIFIED

  • MON

    Monday

  • TUE

    Tuesday

  • WED

    Wednesday

  • THU

    Thursday

  • FRI

    Friday

  • SAT

    Saturday

  • SUN

    Sunday

day : WeekDay​

Day of the week.

hour : int64​

Hour of the day in the UTC timezone.