/alter/system/properties

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/alter/system/properties

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').

Input Parameter Description

Name	Type	Description
property_updates_map	map of strings	Map containing the properties of the system to be updated. Error if empty. Supported Parameters (keys) Parameter Description 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>=<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 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>=<value> 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. Default value is 20. The minimum allowed value is 0. The maximum allowed value is 200. max_get_records_size set max_get_records_size. default 20000 Default value is 20000. The minimum allowed value is 0. The maximum allowed value is 1000000.
options	map of strings	Optional parameters. Default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name	Type	Description
status	String	'OK' or 'ERROR'
message	String	Empty if success or an error message
data_type	String	'alter_system_properties_request' or 'none' in case of an error
data	String	Empty string
data_str	JSON or String	This embedded JSON represents the result of the /alter/system/properties endpoint: Name Type Description updated_properties_map map of strings map of values updated, For speed tests a map of values measured to the measurement Empty string in case of an error.