GPUdb C++ API  Version 5.2.0.0
Public Member Functions | Public Attributes | List of all members
gpudb::AlterSystemPropertiesRequest Struct Reference

A set of input parameters for alterSystemProperties(const AlterSystemPropertiesRequest&) const. More...

#include <gpudb/protocol/alter_system_properties.h>

Public Member Functions

 AlterSystemPropertiesRequest ()
 Constructs an AlterSystemPropertiesRequest object with default parameter values. More...
 
 AlterSystemPropertiesRequest (const std::map< std::string, std::string > &propertyUpdatesMap, const std::map< std::string, std::string > &options)
 Constructs an AlterSystemPropertiesRequest object with the specified parameters. More...
 

Public Attributes

std::map< std::string, std::string > propertyUpdatesMap
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for alterSystemProperties(const AlterSystemPropertiesRequest&) const.

The alter_system_properties endpoint is primarily used to simplify the testing of GPUdb and is not expected to be used during normal execution. Commands are given through the properties_update_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Definition at line 22 of file alter_system_properties.h.

Constructor & Destructor Documentation

gpudb::AlterSystemPropertiesRequest::AlterSystemPropertiesRequest ( )
inline

Constructs an AlterSystemPropertiesRequest object with default parameter values.

Definition at line 29 of file alter_system_properties.h.

gpudb::AlterSystemPropertiesRequest::AlterSystemPropertiesRequest ( const std::map< std::string, std::string > &  propertyUpdatesMap,
const std::map< std::string, std::string > &  options 
)
inline

Constructs an AlterSystemPropertiesRequest object with the specified parameters.

Parameters
[in]propertyUpdatesMapMap containing the properties of the system to be updated. Error if empty.
  • sm_omp_threads: Set the number of sm_omp_threads to the specified integer value.
  • kernel_omp_threads: Set the number of kernel_omp_threads to the specified integer value.
  • concurrent_kernel_execution: Enables concurrent kernel execution if the value is 'true' and disables it if the value is 'false'.
  • chunk_size: Sets the chunk size of all new sets to the specified integer value.
  • flush_to_disk: Flushes any changes to any tables to the persistent store. These changes include updates to the vector store, object store, and text search store, Value string is ignored
  • clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is ignored

  • communicator_test: Invoke the communicator test and report timing results. Value string is is a comma separated list of <key>=

    expressions. Expressions are: num_transactions = <num> where <num> is the number of request reply transactions to invoke per test; message_size = <bytes> where bytes is the size of the messages to send in bytes; check_values = <enabled> where if enabled is true the value of the messages received are verified.

  • set_message_timers_enabled: Enables the communicator test to collect additional timing statistics when the value string is 'true'. Disables the collection when the value string is 'false'
  • bulk_add_test: Invoke the bulk_add test and report timing results. Value string is ignored.

  • network_speed: Invoke the network speed test and report timing results. Value string is a comma separated list of <key>=

    expressions. Expressions are: seconds = <time> where time is the time in seconds to run the test; data_size = <size> where <size> is the size in bytes of the block to be transferred; threads = <number of="" threads>="">; to_ranks = <comma separated="" list="" of="" ranks>=""> where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.

  • request_timeout: Number of minutes after which /filter/* and /aggregate/* queries will timeout.
  • max_get_records_size: set max_get_records_size. default 20000
[in]optionsOptional parameters. Default value is an empty std::map.

Definition at line 117 of file alter_system_properties.h.

Member Data Documentation

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

Definition at line 124 of file alter_system_properties.h.

std::map<std::string, std::string> gpudb::AlterSystemPropertiesRequest::propertyUpdatesMap

Definition at line 123 of file alter_system_properties.h.

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