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').

Input Parameter Description

NameTypeDescription
property_updates_mapmap of string to strings

Map containing the properties of the system to be updated. Error if empty.

Supported Parameters (keys)Parameter Description
concurrent_kernel_execution

Enables concurrent kernel execution if the value is true and disables it if the value is false. The supported values are:

  • true
  • false
subtask_concurrency_limitSets the maximum number of simultaneous threads allocated to a given request, on each rank. Note that thread allocation may also be limited by resource group limits and/or system load.
chunk_sizeSets the number of records per chunk to be used for all new tables.
chunk_column_max_memorySets the target maximum data size for each column in a chunk to be used for all new tables.
chunk_max_memoryIndicates the target maximum data size for all columns in a chunk to be used for all new tables.
execution_modeSets 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_directorySets the root directory path where external table data files are accessed from. Path must exist on the head node
request_timeoutNumber of minutes after which filtering (e.g., Filter ) and aggregating (e.g., Aggregate Group By ) queries will timeout. The default value is '20'.The minimum allowed value is 0. The maximum allowed value is 1440.
max_get_records_sizeThe maximum number of records the database will serve for a given data retrieval call. The default value is '20000'.The minimum allowed value is 0. The maximum allowed value is 1000000.
enable_auditEnable or disable auditing.
audit_headersEnable or disable auditing of request headers.
audit_bodyEnable or disable auditing of request bodies.
audit_dataEnable or disable auditing of request data.
audit_responseEnable or disable auditing of response information.
shadow_agg_sizeSize of the shadow aggregate chunk cache in bytes. The default value is '10000000'.The minimum allowed value is 0. The maximum allowed value is 2147483647.
shadow_filter_sizeSize of the shadow filter chunk cache in bytes. The default value is '10000000'.The minimum allowed value is 0. The maximum allowed value is 2147483647.
enable_overlapped_equi_joinEnable overlapped-equi-join filter. The default value is 'true'.
enable_one_step_compound_equi_joinEnable the one_step compound-equi-join algorithm. The default value is 'true'.
kafka_batch_sizeMaximum number of records to be ingested in a single batch. The default value is '1000'.The minimum allowed value is 1. The maximum allowed value is 10000000.
kafka_poll_timeoutMaximum time (milliseconds) for each poll to get records from kafka. The default value is '0'.The minimum allowed value is 0. The maximum allowed value is 1000.
kafka_wait_timeMaximum time (seconds) to buffer records received from kafka before ingestion. The default value is '30'.The minimum allowed value is 1. The maximum allowed value is 120.
egress_parquet_compression

Parquet file compression type The default value is snappy. The supported values are:

  • uncompressed
  • snappy
  • gzip
egress_single_file_max_sizeMax file size (in MB) to allow saving to a single file. May be overridden by target limitations. The default value is '10000'.The minimum allowed value is 1. The maximum allowed value is 200000.
max_concurrent_kernelsSets the max_concurrent_kernels value of the conf. The minimum allowed value is 0. The maximum allowed value is 256.
system_metadata_retention_periodSets the system_metadata.retention_period value of the conf. The minimum allowed value is 1.
tcs_per_tomSize of the worker rank data calculation thread pool. This is primarily used for computation-based operations such as aggregates and record retrieval. The minimum allowed value is 2. The maximum allowed value is 8192.
tps_per_tomSize of the worker rank data processing thread pool. This includes operations such as inserts, updates, & deletes on table data. Multi-head inserts are not affected by this limit. The minimum allowed value is 2. The maximum allowed value is 8192.
ai_enable_ragEnable RAG. The default value is 'false'.
ai_api_providerAI API provider type
ai_api_urlAI API URL
ai_api_keyAI API key
ai_api_connection_timeoutAI API connection timeout in seconds
ai_api_embeddings_modelAI API model name
telm_persist_query_metricsEnable or disable persisting of query metrics.
postgres_proxy_idle_connection_timeoutIdle connection timeout in seconds
postgres_proxy_keep_aliveEnable postgres proxy keep alive. The default value is 'false'.
kifs_directory_data_limitThe default maximum capacity to apply when creating a KiFS directory (bytes) The minimum allowed value is -1.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
evict_to_cold

If true and evict_columns is specified, the given objects will be evicted to cold storage (if such a tier exists). The supported values are:

  • true
  • false
persist

If true the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. The default value is true. The supported values are:

  • true
  • false

Output Parameter Description

NameTypeDescription
updated_properties_mapmap of string to stringsMap of values updated; for speed tests, a map of values measured to the measurement
infomap of string to stringsAdditional information.