gpudb::AlterSystemPropertiesRequest Struct Reference

A set of input parameters for 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 const.

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

Definition at line 24 of file alter_system_properties.h.

Constructor & Destructor Documentation

gpudb::AlterSystemPropertiesRequest::AlterSystemPropertiesRequest ( )

inline

Constructs an AlterSystemPropertiesRequest object with default parameter values.

Definition at line 31 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]	propertyUpdatesMap_	Map containing the properties of the system to be updated. Error if empty. gpudb::alter_system_properties_sm_omp_threads: Set the number of OpenMP threads that will be used to service filter & aggregation requests against collections to the specified integer value. gpudb::alter_system_properties_kernel_omp_threads: Set the number of kernel OpenMP threads to the specified integer value. gpudb::alter_system_properties_concurrent_kernel_execution: Enables concurrent kernel execution if the value is true and disables it if the value is false. gpudb::alter_system_properties_true gpudb::alter_system_properties_false gpudb::alter_system_properties_subtask_concurrency_limit: Sets the maximum number of simultaneous threads allocated to a given request, on each rank. Note that thread allocation may also be limted by resource group limits and/or system load. gpudb::alter_system_properties_chunk_size: Sets the number of records per chunk to be used for all new tables. gpudb::alter_system_properties_evict_columns: Attempts to evict columns from memory to the persistent store. Value string is a semicolon separated list of entries, each entry being a table name optionally followed by a comma and a comma separated list of column names to attempt to evict. An empty value string will attempt to evict all tables and columns. gpudb::alter_system_properties_execution_mode: Sets the execution_mode for kernel executions to the specified string value. Possible values are host, device, default (engine decides) or an integer value that indicates max chunk size to exec on host gpudb::alter_system_properties_external_files_directory: Sets the root directory path where external table data files are accessed from. Path must exist on the head node gpudb::alter_system_properties_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 gpudb::alter_system_properties_clear_cache: Clears cached results. Useful to allow repeated timing of endpoints. Value string is the name of the table for which to clear the cached results, or an empty string to clear the cached results for all tables. gpudb::alter_system_properties_communicator_test: Invoke the communicator test and report timing results. Value string is is a semicolon separated list of [key]=[value] 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 in bytes of the messages to send; check_values=[enabled] where if enabled is true the value of the messages received are verified. gpudb::alter_system_properties_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 gpudb::alter_system_properties_true gpudb::alter_system_properties_false gpudb::alter_system_properties_network_speed: Invoke the network speed test and report timing results. Value string is a semicolon-separated list of [key]=[value] expressions. Valid expressions are: seconds=[time] where time is the time in seconds to run the test; data_size=[bytes] where bytes is the size in bytes of the block to be transferred; threads=[number of threads]; to_ranks=[space-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. gpudb::alter_system_properties_request_timeout: Number of minutes after which filtering (e.g., /filter) and aggregating (e.g., /aggregate/groupby) queries will timeout. The default value is '20'. gpudb::alter_system_properties_max_get_records_size: The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'. gpudb::alter_system_properties_enable_audit: Enable or disable auditing. gpudb::alter_system_properties_audit_headers: Enable or disable auditing of request headers. gpudb::alter_system_properties_audit_body: Enable or disable auditing of request bodies. gpudb::alter_system_properties_audit_data: Enable or disable auditing of request data. gpudb::alter_system_properties_shadow_agg_size: Size of the shadow aggregate chunk cache in bytes. The default value is '10000000'. gpudb::alter_system_properties_shadow_filter_size: Size of the shdow filter chunk cache in bytes. The default value is '10000000'. gpudb::alter_system_properties_synchronous_compression: compress vector on set_compression (instead of waiting for background thread). The default value is 'false'. gpudb::alter_system_properties_enable_overlapped_equi_join: Enable overlapped-equi-join filter. The default value is 'true'. gpudb::alter_system_properties_enable_compound_equi_join: Enable compound-equi-join filter plan type. The default value is 'false'.
[in]	options_	Optional parameters.

Definition at line 224 of file alter_system_properties.h.

Member Data Documentation

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

Definition at line 231 of file alter_system_properties.h.

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

Definition at line 230 of file alter_system_properties.h.

---

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

• gpudb/protocol/alter_system_properties.h