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	EXECUTION_MODE = "execution_mode"
	Sets the execution_mode for kernel executions to the specified string 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., 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	MEMORY_ALLOCATION_LIMIT_MB = "memory_allocation_limit_mb"
	Set the memory allocation limit for all rank processes in megabytes, 0 means no limit. 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	ENABLE_JOB_MANAGER = "enable_job_manager"
	Enable JobManager to enforce processing of requests in the order received. More...

const string	CHUNK_CACHE_ENABLED = "chunk_cache_enabled"
	Enable chunk level query caching. More...

const string	CHUNK_CACHE_SIZE = "chunk_cache_size"
	Size of the chunk cache in bytes. 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. Supported values:
- TRUE
- FALSE
CHUNK_SIZE: Sets the chunk size of all new sets to the specified integer value.
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
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 Supported 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. The default value is '20'.
MAX_GET_RECORDS_SIZE: The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'.
MEMORY_ALLOCATION_LIMIT_MB: Set the memory allocation limit for all rank processes in megabytes, 0 means no limit. Overrides any individual rank memory allocation limits. The default value is '0'.
ENABLE_AUDIT: Enable or disable auditing.
AUDIT_HEADERS: Enable or disable auditing of request headers.
AUDIT_BODY: Enable or disable auditing of request bodies.
AUDIT_DATA: Enable or disable auditing of request data.
ENABLE_JOB_MANAGER: Enable JobManager to enforce processing of requests in the order received.
CHUNK_CACHE_ENABLED: Enable chunk level query caching. Flushes the chunk cache when value is false
CHUNK_CACHE_SIZE: Size of the chunk cache in bytes. The default value is '10000000'.

A set of string constants for the parameter property_updates_map.

Definition at line 204 of file AlterSystemProperties.cs.

Member Data Documentation

◆ AUDIT_BODY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_BODY = "audit_body"

Enable or disable auditing of request bodies.

Definition at line 321 of file AlterSystemProperties.cs.

◆ AUDIT_DATA

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_DATA = "audit_data"

Enable or disable auditing of request data.

Definition at line 324 of file AlterSystemProperties.cs.

◆ AUDIT_HEADERS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_HEADERS = "audit_headers"

Enable or disable auditing of request headers.

Definition at line 317 of file AlterSystemProperties.cs.

◆ BULK_ADD_TEST

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 281 of file AlterSystemProperties.cs.

◆ CHUNK_CACHE_ENABLED

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_CACHE_ENABLED = "chunk_cache_enabled"

Enable chunk level query caching.

Flushes the chunk cache when value is false

Definition at line 332 of file AlterSystemProperties.cs.

◆ CHUNK_CACHE_SIZE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_CACHE_SIZE = "chunk_cache_size"

Size of the chunk cache in bytes.

The default value is '10000000'.

Definition at line 336 of file AlterSystemProperties.cs.

◆ CHUNK_SIZE

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 235 of file AlterSystemProperties.cs.

◆ CLEAR_CACHE

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 251 of file AlterSystemProperties.cs.

◆ COMMUNICATOR_TEST

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 261 of file AlterSystemProperties.cs.

◆ CONCURRENT_KERNEL_EXECUTION

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:

TRUE
FALSE

Definition at line 229 of file AlterSystemProperties.cs.

◆ ENABLE_AUDIT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_AUDIT = "enable_audit"

Enable or disable auditing.

Definition at line 313 of file AlterSystemProperties.cs.

◆ ENABLE_JOB_MANAGER

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_JOB_MANAGER = "enable_job_manager"

Enable JobManager to enforce processing of requests in the order received.

Definition at line 328 of file AlterSystemProperties.cs.

◆ EXECUTION_MODE

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 241 of file AlterSystemProperties.cs.

◆ FALSE

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

Definition at line 231 of file AlterSystemProperties.cs.

◆ FLUSH_TO_DISK

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 247 of file AlterSystemProperties.cs.

◆ KERNEL_OMP_THREADS

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 214 of file AlterSystemProperties.cs.

◆ MAX_GET_RECORDS_SIZE

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 305 of file AlterSystemProperties.cs.

◆ MEMORY_ALLOCATION_LIMIT_MB

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.MEMORY_ALLOCATION_LIMIT_MB = "memory_allocation_limit_mb"

Set the memory allocation limit for all rank processes in megabytes, 0 means no limit.

Overrides any individual rank memory allocation limits. The default value is '0'.

Definition at line 310 of file AlterSystemProperties.cs.

◆ NETWORK_SPEED

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 293 of file AlterSystemProperties.cs.

◆ REQUEST_TIMEOUT

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 300 of file AlterSystemProperties.cs.

◆ SET_MESSAGE_TIMERS_ENABLED

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:

TRUE
FALSE

Definition at line 277 of file AlterSystemProperties.cs.

◆ SM_OMP_THREADS

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 210 of file AlterSystemProperties.cs.

◆ TRUE

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

Definition at line 230 of file AlterSystemProperties.cs.

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

Kinetica/Protocol/AlterSystemProperties.cs

Public Attributes