Skip to main content

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

#include <gpudb/protocol/alter_tier.h>

​
Public Member Functions

 AlterTierRequest ()
 Constructs an AlterTierRequest object with default parameters.
 
 AlterTierRequest (const std::string &name_, const std::map< std::string, std::string > &options_)
 Constructs an AlterTierRequest object with the specified parameters.
 

​
Public Attributes

std::string name
 Name of the tier to be altered.
 
std::map< std::string, std::string > options
 Optional parameters.
 

​
Detailed Description

A set of parameters for GPUdb::alterTier.

Alters properties of an existing tier to facilitate resource management.

To disable watermark-based eviction, set both high_watermark and low_watermark to 100.

Definition at line 25 of file alter_tier.h.

​
Constructor & Destructor Documentation

​
◆ AlterTierRequest() [1/2]

gpudb::AlterTierRequest::AlterTierRequest ()
 inline

Constructs an AlterTierRequest object with default parameters.

Definition at line 30 of file alter_tier.h.

​
◆ AlterTierRequest() [2/2]

gpudb::AlterTierRequest::AlterTierRequest (const std::string &name_,
const std::map< std::string, std::string > &options_ )
 inline

Constructs an AlterTierRequest object with the specified parameters.

Parameters
[in]name_Name of the tier to be altered. Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].
[in]options_Optional parameters.
  • alter_tier_capacity: Maximum size in bytes this tier may hold at once, per rank.
  • alter_tier_high_watermark: Threshold of usage of this tier’s resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.
  • alter_tier_low_watermark: Threshold of resource usage that once fallen below after crossing the high_watermark, will cease watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.
  • alter_tier_wait_timeout: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.
  • alter_tier_persist: If true 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:The default value is alter_tier_true.
  • alter_tier_rank: Apply the requested change only to a specific rank. The minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.
The default value is an empty map.

Definition at line 95 of file alter_tier.h.

​
Member Data Documentation

​
◆ name

std::string gpudb::AlterTierRequest::name

Name of the tier to be altered.

Must be an existing tier group name: vram, ram, disk[n], persist, cold[n].

Definition at line 105 of file alter_tier.h.

​
◆ options

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

Optional parameters.

  • alter_tier_capacity: Maximum size in bytes this tier may hold at once, per rank.
  • alter_tier_high_watermark: Threshold of usage of this tier’s resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.
  • alter_tier_low_watermark: Threshold of resource usage that once fallen below after crossing the high_watermark, will cease watermark-based eviction from this tier. The minimum allowed value is ‘0’. The maximum allowed value is ‘100’.
  • alter_tier_wait_timeout: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only.
  • alter_tier_persist: If true 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:The default value is alter_tier_true.
  • alter_tier_rank: Apply the requested change only to a specific rank. The minimum allowed value is ‘0’. The maximum allowed value is ‘10000’.

The default value is an empty map.

Definition at line 145 of file alter_tier.h.

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