gpudb::AlterResourceGroupRequest

A set of parameters for GPUdb::alterResourceGroup. More…

#include <gpudb/protocol/alter_resource_group.h>

Public Member Functions
	AlterResourceGroupRequest ()
	Constructs an AlterResourceGroupRequest object with default parameters.

	AlterResourceGroupRequest (const std::string &name_, const std::map< std::string, std::map< std::string, std::string > > &tierAttributes_, const std::string &ranking_, const std::string &adjoiningResourceGroup_, const std::map< std::string, std::string > &options_)
	Constructs an AlterResourceGroupRequest object with the specified parameters.

Public Attributes
std::string	name
	Name of the group to be altered.

std::map< std::string, std::map< std::string, std::string > >	tierAttributes
	Optional map containing tier names and their respective attribute group limits.

std::string	ranking
	If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be placed.

std::string	adjoiningResourceGroup
	If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank.

std::map< std::string, std::string >	options
	Optional parameters.

Detailed Description

A set of parameters for GPUdb::alterResourceGroup.

Alters the properties of an existing resource group to facilitate resource management.

Definition at line 19 of file alter_resource_group.h.

Constructor & Destructor Documentation

◆ AlterResourceGroupRequest() [1/2]

gpudb::AlterResourceGroupRequest::AlterResourceGroupRequest ( )

inline

Constructs an AlterResourceGroupRequest object with default parameters.

Definition at line 25 of file alter_resource_group.h.

◆ AlterResourceGroupRequest() [2/2]

gpudb::AlterResourceGroupRequest::AlterResourceGroupRequest	(	const std::string &	name_,
		const std::map< std::string, std::map< std::string, std::string > > &	tierAttributes_,
		const std::string &	ranking_,
		const std::string &	adjoiningResourceGroup_,
		const std::map< std::string, std::string > &	options_ )

inline

Constructs an AlterResourceGroupRequest object with the specified parameters.

Parameters

[in]	name_	Name of the group to be altered. Must be an existing resource group name or an empty string when used in conjunction with is_default_group.
[in]	tierAttributes_	Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM and RAM tiers. For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: ‘VRAM’:‘max_memory’:‘1000000000’, ‘RAM’:‘max_memory’:‘10000000000’. alter_resource_group_max_memory: Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier. The default value is an empty map.
[in]	ranking_	If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be placed. Supported values: alter_resource_group_empty_string: Don’t change the ranking. alter_resource_group_first: Make this resource group the new first one in the ordering. alter_resource_group_last: Make this resource group the new last one in the ordering. alter_resource_group_before: Place this resource group before the one specified by adjoiningResourceGroup_ in the ordering. alter_resource_group_after: Place this resource group after the one specified by adjoiningResourceGroup_ in the ordering. The default value is alter_resource_group_empty_string.
[in]	adjoiningResourceGroup_	If ranking_ is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ”.
[in]	options_	Optional parameters. alter_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is ‘4’. alter_resource_group_max_data: Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is ‘-1’. alter_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘100’. alter_resource_group_max_tier_priority: Maximum priority of a tiered object for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘10’. alter_resource_group_is_default_group: If true, this request applies to the global default resource group. It is an error for this field to be true when the name_ field is also populated. Supported values: alter_resource_group_true alter_resource_group_false The default value is alter_resource_group_false. alter_resource_group_persist: If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values: alter_resource_group_true alter_resource_group_false The default value is alter_resource_group_true. The default value is an empty map.

Definition at line 186 of file alter_resource_group.h.

Member Data Documentation

◆ adjoiningResourceGroup

std::string gpudb::AlterResourceGroupRequest::adjoiningResourceGroup

If ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank.

The default value is ”.

Definition at line 257 of file alter_resource_group.h.

◆ name

std::string gpudb::AlterResourceGroupRequest::name

Name of the group to be altered.

Must be an existing resource group name or an empty string when used in conjunction with is_default_group.

Definition at line 200 of file alter_resource_group.h.

◆ options

std::map<std::string, std::string> gpudb::AlterResourceGroupRequest::options

Optional parameters.

alter_resource_group_max_cpu_concurrency: Maximum number of simultaneous threads that will be used to execute a request, per rank, for this group. The minimum allowed value is ‘4’.
alter_resource_group_max_data: Maximum amount of data, per rank, in bytes, that can be used by all database objects within this group. Set to -1 to indicate no upper limit. The minimum allowed value is ‘-1’.
alter_resource_group_max_scheduling_priority: Maximum priority of a scheduled task for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘100’.
alter_resource_group_max_tier_priority: Maximum priority of a tiered object for this group. The minimum allowed value is ‘1’. The maximum allowed value is ‘10’.
alter_resource_group_is_default_group: If true, this request applies to the global default resource group. It is an error for this field to be true when the name field is also populated. Supported values:
- alter_resource_group_true
- alter_resource_group_false
The default value is alter_resource_group_false.
alter_resource_group_persist: If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:
- alter_resource_group_true
- alter_resource_group_false
The default value is alter_resource_group_true.

The default value is an empty map.

Definition at line 314 of file alter_resource_group.h.

◆ ranking

std::string gpudb::AlterResourceGroupRequest::ranking

If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be placed.

Supported values:

alter_resource_group_empty_string: Don’t change the ranking.
alter_resource_group_first: Make this resource group the new first one in the ordering.
alter_resource_group_last: Make this resource group the new last one in the ordering.
alter_resource_group_before: Place this resource group before the one specified by adjoiningResourceGroup in the ordering.
alter_resource_group_after: Place this resource group after the one specified by adjoiningResourceGroup in the ordering.

The default value is alter_resource_group_empty_string.

Definition at line 249 of file alter_resource_group.h.

◆ tierAttributes

std::map<std::string, std::map<std::string, std::string> > gpudb::AlterResourceGroupRequest::tierAttributes

Optional map containing tier names and their respective attribute group limits.

The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM and RAM tiers.

For instance, to set max VRAM capacity to 1GB per rank per GPU and max RAM capacity to 10GB per rank, use: ‘VRAM’:‘max_memory’:‘1000000000’, ‘RAM’:‘max_memory’:‘10000000000’.

alter_resource_group_max_memory: Maximum amount of memory usable at one time, per rank, per GPU, for the VRAM tier; or maximum amount of memory usable at one time, per rank, for the RAM tier.

The default value is an empty map.

Definition at line 220 of file alter_resource_group.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/alter_resource_group.h

​ Public Member Functions

​ Public Attributes

​Detailed Description

​Constructor & Destructor Documentation

​◆ AlterResourceGroupRequest() [1/2]

​◆ AlterResourceGroupRequest() [2/2]

​Member Data Documentation

​◆ adjoiningResourceGroup

​◆ name

​◆ options

​◆ ranking

​◆ tierAttributes

Public Member Functions

Public Attributes