Alter System Properties
The Alter System Properties 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 input parameter property_updates_map whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').
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 OpenMP threads that will be used to service filter & aggregation requests against collections to the specified integer value. |
kernel_omp_threads |
Set the number of kernel OpenMP 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. The allowed values are:
|
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 The allowed values are:
|
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 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=<size> where size 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. |
request_timeout |
Number of minutes after which filtering (e.g., Filter) and aggregating (e.g., Aggregate Group By) queries will timeout. Default value is 20. The minimum allowed value is 0. The maximum allowed value is 200. |
max_get_records_size |
The maximum number of records the database will serve for a given data retrieval call 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 ( {} ). |
Name |
Type |
Description |
updated_properties_map |
map of
strings |
map of values updated, For speed
tests a map of values measured to
the measurement |