Kinetica C# API  Version 6.0.1.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap Struct Reference

Map containing the properties of the system to be updated. More...

Public Attributes

const string SM_OMP_THREADS = "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. More...
 
const string KERNEL_OMP_THREADS = "kernel_omp_threads"
 Set the number of kernel OpenMP threads to the specified integer value. More...
 
const string CONCURRENT_KERNEL_EXECUTION = "concurrent_kernel_execution"
 Enables concurrent kernel execution if the value is true and disables it if the value is false. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string CHUNK_SIZE = "chunk_size"
 Sets the chunk size of all new sets to the specified integer value. More...
 
const string FLUSH_TO_DISK = "flush_to_disk"
 Flushes any changes to any tables to the persistent store. More...
 
const string CLEAR_CACHE = "clear_cache"
 Clears cached results. More...
 
const string COMMUNICATOR_TEST = "communicator_test"
 Invoke the communicator test and report timing results. More...
 
const string SET_MESSAGE_TIMERS_ENABLED = "set_message_timers_enabled"
 Enables the communicator test to collect additional timing statistics when the value string is true. More...
 
const string BULK_ADD_TEST = "bulk_add_test"
 Invoke the bulk add test and report timing results. More...
 
const string NETWORK_SPEED = "network_speed"
 Invoke the network speed test and report timing results. More...
 
const string REQUEST_TIMEOUT = "request_timeout"
 Number of minutes after which filtering (e.g., /filter) and aggregating (e.g., /aggregate/groupby) queries will timeout. More...
 
const string MAX_GET_RECORDS_SIZE = "max_get_records_size"
 The maximum number of records the database will serve for a given data retrieval call More...
 

Detailed Description

Map containing the properties of the system to be updated.

Error if empty.

  • 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. Values: true, 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 Values: true, 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 semicolon-separated list of <key>=

    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/groupby) queries will timeout.
  • max_get_records_size The maximum number of records the database will serve for a given data retrieval call


A set of string constants for the parameter <member name="property_updates_map">.

Definition at line 113 of file AlterSystemProperties.cs.

Member Data Documentation

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.BULK_ADD_TEST = "bulk_add_test"

Invoke the bulk add test and report timing results.

Value string is ignored.

Definition at line 166 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_SIZE = "chunk_size"

Sets the chunk size of all new sets to the specified integer value.

Definition at line 135 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CLEAR_CACHE = "clear_cache"

Clears cached results.

Useful to allow repeated timing of endpoints. Value string is ignored

Definition at line 145 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.COMMUNICATOR_TEST = "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.

Definition at line 155 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CONCURRENT_KERNEL_EXECUTION = "concurrent_kernel_execution"

Enables concurrent kernel execution if the value is true and disables it if the value is false.

Values: true, false.

Definition at line 129 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.FALSE = "false"

Definition at line 131 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.FLUSH_TO_DISK = "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

Definition at line 141 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KERNEL_OMP_THREADS = "kernel_omp_threads"

Set the number of kernel OpenMP threads to the specified integer value.

Definition at line 123 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.MAX_GET_RECORDS_SIZE = "max_get_records_size"

The maximum number of records the database will serve for a given data retrieval call

Definition at line 187 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.NETWORK_SPEED = "network_speed"

Invoke the network speed test and report timing results.

Value string is a semicolon-separated list of <key>=

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.

Definition at line 178 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.REQUEST_TIMEOUT = "request_timeout"

Number of minutes after which filtering (e.g., /filter) and aggregating (e.g., /aggregate/groupby) queries will timeout.

Definition at line 183 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SET_MESSAGE_TIMERS_ENABLED = "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 Values: true, false.

Definition at line 162 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SM_OMP_THREADS = "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.

Definition at line 119 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TRUE = "true"

Definition at line 130 of file AlterSystemProperties.cs.


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