|
Kinetica C# API
Version 7.0.19.0
|
|
Kinetica C# API
Version 7.0.19.0
|
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 | SUBTASK_CONCURRENCY_LIMIT = "subtask_concurrency_limit" |
| Sets the maximum number of simultaneous threads allocated to a given request, on each rank. More... | |
| const string | CHUNK_SIZE = "chunk_size" |
| Sets the number of records per chunk to be used for all new tables. More... | |
| const string | EVICT_COLUMNS = "evict_columns" |
| Attempts to evict columns from memory to the persistent store. More... | |
| const string | EXECUTION_MODE = "execution_mode" |
| Sets the execution_mode for kernel executions to the specified string value. More... | |
| const string | EXTERNAL_FILES_DIRECTORY = "external_files_directory" |
| Sets the root directory path where external table data files are accessed from. 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 | 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., Kinetica.filter(string,string,string,IDictionary{string, string})) and aggregating (e.g., Kinetica.aggregateGroupBy(string,IList{string},long,long,IDictionary{string, string})) 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... | |
| const string | ENABLE_AUDIT = "enable_audit" |
| Enable or disable auditing. More... | |
| const string | AUDIT_HEADERS = "audit_headers" |
| Enable or disable auditing of request headers. More... | |
| const string | AUDIT_BODY = "audit_body" |
| Enable or disable auditing of request bodies. More... | |
| const string | AUDIT_DATA = "audit_data" |
| Enable or disable auditing of request data. More... | |
| const string | SHADOW_AGG_SIZE = "shadow_agg_size" |
| Size of the shadow aggregate chunk cache in bytes. More... | |
| const string | SHADOW_FILTER_SIZE = "shadow_filter_size" |
| Size of the shdow filter chunk cache in bytes. More... | |
| const string | SYNCHRONOUS_COMPRESSION = "synchronous_compression" |
| compress vector on set_compression (instead of waiting for background thread). More... | |
| const string | ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join" |
| Enable overlapped-equi-join filter. More... | |
| const string | ENABLE_COMPOUND_EQUI_JOIN = "enable_compound_equi_join" |
| Enable compound-equi-join filter plan type. More... | |
Map containing the properties of the system to be updated.
Error if empty.
A set of string constants for the parameter property_updates_map.
Definition at line 231 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_BODY = "audit_body" |
Enable or disable auditing of request bodies.
Definition at line 360 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_DATA = "audit_data" |
Enable or disable auditing of request data.
Definition at line 363 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_HEADERS = "audit_headers" |
Enable or disable auditing of request headers.
Definition at line 356 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_SIZE = "chunk_size" |
Sets the number of records per chunk to be used for all new tables.
Definition at line 268 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 the name of the table for which to clear the cached results, or an empty string to clear the cached results for all tables.
Definition at line 299 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 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.
Definition at line 309 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.
Supported values:
Definition at line 256 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_AUDIT = "enable_audit" |
Enable or disable auditing.
Definition at line 352 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_COMPOUND_EQUI_JOIN = "enable_compound_equi_join" |
Enable compound-equi-join filter plan type.
The default value is 'false'.
Definition at line 384 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join" |
Enable overlapped-equi-join filter.
The default value is 'true'.
Definition at line 380 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EVICT_COLUMNS = "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.
Definition at line 276 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EXECUTION_MODE = "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
Definition at line 282 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EXTERNAL_FILES_DIRECTORY = "external_files_directory" |
Sets the root directory path where external table data files are accessed from.
Path must exist on the head node
Definition at line 287 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.FALSE = "false" |
Definition at line 258 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 293 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 241 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.
The default value is '20000'.
Definition at line 349 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]=[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.
Definition at line 337 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.REQUEST_TIMEOUT = "request_timeout" |
Number of minutes after which filtering (e.g., Kinetica.filter(string,string,string,IDictionary{string, string})) and aggregating (e.g., Kinetica.aggregateGroupBy(string,IList{string},long,long,IDictionary{string, string})) queries will timeout.
The default value is '20'.
Definition at line 344 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 Supported values:
Definition at line 325 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SHADOW_AGG_SIZE = "shadow_agg_size" |
Size of the shadow aggregate chunk cache in bytes.
The default value is '10000000'.
Definition at line 367 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SHADOW_FILTER_SIZE = "shadow_filter_size" |
Size of the shdow filter chunk cache in bytes.
The default value is '10000000'.
Definition at line 371 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 237 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SUBTASK_CONCURRENCY_LIMIT = "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.
Definition at line 264 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SYNCHRONOUS_COMPRESSION = "synchronous_compression" |
compress vector on set_compression (instead of waiting for background thread).
The default value is 'false'.
Definition at line 376 of file AlterSystemProperties.cs.
| const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TRUE = "true" |
Definition at line 257 of file AlterSystemProperties.cs.
1.8.5 
