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 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	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	MAX_GRBC_BATCH_SIZE = "max_grbc_batch_size"
	<DEVELOPER> 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	AUDIT_RESPONSE = "audit_response"
	Enable or disable auditing of response information. 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 shadow 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	KAFKA_BATCH_SIZE = "kafka_batch_size"
	Maximum number of records to be ingested in a single batch. More...

const string	KAFKA_POLL_TIMEOUT = "kafka_poll_timeout"
	Maximum time (milliseconds) for each poll to get records from kafka. More...

const string	KAFKA_WAIT_TIME = "kafka_wait_time"
	Maximum time (seconds) to buffer records received from kafka before ingestion. More...

const string	EGRESS_PARQUET_COMPRESSION = "egress_parquet_compression"
	Parquet file compression type Supported values: UNCOMPRESSED SNAPPY GZIP The default value is SNAPPY. More...

const string	UNCOMPRESSED = "uncompressed"

const string	SNAPPY = "snappy"

const string	GZIP = "gzip"

const string	EGRESS_SINGLE_FILE_MAX_SIZE = "egress_single_file_max_size"
	Max file size (in MB) to allow saving to a single file. More...

const string	MAX_CONCURRENT_KERNELS = "max_concurrent_kernels"
	Sets the max_concurrent_kernels value of the conf. More...

const string	TCS_PER_TOM = "tcs_per_tom"
	Sets the tcs_per_tom value of the conf. More...

const string	TPS_PER_TOM = "tps_per_tom"
	Sets the tps_per_tom value of the conf. More...

const string	AI_API_PROVIDER = "ai_api_provider"
	AI API provider type More...

const string	AI_API_URL = "ai_api_url"
	AI API URL More...

const string	AI_API_KEY = "ai_api_key"
	AI API key More...

const string	AI_API_CONNECTION_TIMEOUT = "ai_api_connection_timeout"
	AI API connection timeout in seconds More...

const string	POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = "postgres_proxy_idle_connection_timeout"
	Idle connection timeout in seconds More...

const string	POSTGRES_PROXY_KEEP_ALIVE = "postgres_proxy_keep_alive"
	Enable postgres proxy keep alive. 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 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
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.
CHUNK_SIZE: Sets the number of records per chunk to be used for all new tables.
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.
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
EXTERNAL_FILES_DIRECTORY: Sets the root directory path where external table data files are accessed from. Path must exist on the head node
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 the name of the table for which to clear the cached results, or an empty string to clear the cached results for all tables.
COMMUNICATOR_TEST: Invoke the communicator test and report timing results. Value string 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.
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.
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'.
MAX_GRBC_BATCH_SIZE: <DEVELOPER>
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.
AUDIT_RESPONSE: Enable or disable auditing of response information.
SHADOW_AGG_SIZE: Size of the shadow aggregate chunk cache in bytes. The default value is '10000000'.
SHADOW_FILTER_SIZE: Size of the shadow filter chunk cache in bytes. The default value is '10000000'.
SYNCHRONOUS_COMPRESSION: compress vector on set_compression (instead of waiting for background thread). The default value is 'false'.
ENABLE_OVERLAPPED_EQUI_JOIN: Enable overlapped-equi-join filter. The default value is 'true'.
KAFKA_BATCH_SIZE: Maximum number of records to be ingested in a single batch. The default value is '1000'.
KAFKA_POLL_TIMEOUT: Maximum time (milliseconds) for each poll to get records from kafka. The default value is '0'.
KAFKA_WAIT_TIME: Maximum time (seconds) to buffer records received from kafka before ingestion. The default value is '30'.
EGRESS_PARQUET_COMPRESSION: Parquet file compression type Supported values:
- UNCOMPRESSED
- SNAPPY
- GZIP
The default value is SNAPPY.
EGRESS_SINGLE_FILE_MAX_SIZE: Max file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is '10000'.
MAX_CONCURRENT_KERNELS: Sets the max_concurrent_kernels value of the conf.
TCS_PER_TOM: Sets the tcs_per_tom value of the conf.
TPS_PER_TOM: Sets the tps_per_tom value of the conf.
AI_API_PROVIDER: AI API provider type
AI_API_URL: AI API URL
AI_API_KEY: AI API key
AI_API_CONNECTION_TIMEOUT: AI API connection timeout in seconds
POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT: Idle connection timeout in seconds
POSTGRES_PROXY_KEEP_ALIVE: Enable postgres proxy keep alive. The default value is 'false'.

A set of string constants for the parameter property_updates_map.

Definition at line 317 of file AlterSystemProperties.cs.

Member Data Documentation

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_CONNECTION_TIMEOUT = "ai_api_connection_timeout"

AI API connection timeout in seconds

Definition at line 519 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_KEY = "ai_api_key"

AI API key

Definition at line 516 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_PROVIDER = "ai_api_provider"

AI API provider type

Definition at line 510 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_URL = "ai_api_url"

AI API URL

Definition at line 513 of file AlterSystemProperties.cs.

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

Enable or disable auditing of request bodies.

Definition at line 433 of file AlterSystemProperties.cs.

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

Enable or disable auditing of request data.

Definition at line 436 of file AlterSystemProperties.cs.

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

Enable or disable auditing of request headers.

Definition at line 429 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_RESPONSE = "audit_response"

Enable or disable auditing of response information.

Definition at line 440 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 354 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 385 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.COMMUNICATOR_TEST = "communicator_test"

Invoke the communicator test and report timing results.

Value string 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 395 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:

TRUE
FALSE

Definition at line 342 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EGRESS_PARQUET_COMPRESSION = "egress_parquet_compression"

Parquet file compression type Supported values:

The default value is SNAPPY.

Definition at line 489 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EGRESS_SINGLE_FILE_MAX_SIZE = "egress_single_file_max_size"

Max file size (in MB) to allow saving to a single file.

May be overridden by target limitations. The default value is '10000'.

Definition at line 497 of file AlterSystemProperties.cs.

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

Enable or disable auditing.

Definition at line 425 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 457 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 362 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 368 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 373 of file AlterSystemProperties.cs.

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

Definition at line 344 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 379 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.GZIP = "gzip"

Definition at line 492 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_BATCH_SIZE = "kafka_batch_size"

Maximum number of records to be ingested in a single batch.

The default value is '1000'.

Definition at line 461 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_POLL_TIMEOUT = "kafka_poll_timeout"

Maximum time (milliseconds) for each poll to get records from kafka.

The default value is '0'.

Definition at line 465 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_WAIT_TIME = "kafka_wait_time"

Maximum time (seconds) to buffer records received from kafka before ingestion.

The default value is '30'.

Definition at line 469 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 327 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.MAX_CONCURRENT_KERNELS = "max_concurrent_kernels"

Sets the max_concurrent_kernels value of the conf.

Definition at line 501 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 419 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.MAX_GRBC_BATCH_SIZE = "max_grbc_batch_size"

Definition at line 422 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 407 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = "postgres_proxy_idle_connection_timeout"

Idle connection timeout in seconds

Definition at line 522 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_KEEP_ALIVE = "postgres_proxy_keep_alive"

Enable postgres proxy keep alive.

The default value is 'false'.

Definition at line 526 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 414 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 444 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SHADOW_FILTER_SIZE = "shadow_filter_size"

Size of the shadow filter chunk cache in bytes.

The default value is '10000000'.

Definition at line 448 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 to the specified integer value.

Definition at line 323 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SNAPPY = "snappy"

Definition at line 491 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 350 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 453 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TCS_PER_TOM = "tcs_per_tom"

Sets the tcs_per_tom value of the conf.

Definition at line 504 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TPS_PER_TOM = "tps_per_tom"

Sets the tps_per_tom value of the conf.

Definition at line 507 of file AlterSystemProperties.cs.

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

Definition at line 343 of file AlterSystemProperties.cs.

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.UNCOMPRESSED = "uncompressed"

Definition at line 490 of file AlterSystemProperties.cs.

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

Kinetica/Protocol/AlterSystemProperties.cs

Public Attributes

Detailed Description

Member Data Documentation