URL: http://<db.host>:<db.port>/alter/system/properties
Input Parameter Description
map of string to strings
Map containing the properties of the system to be updated. Error if empty.
Show property_updates_map
Show property_updates_map
Enables concurrent kernel execution if the value is true and disables it if the value is false.The supported values are:
- true
- false
Sets 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.
Sets the number of records per chunk to be used for all new tables.
Sets the target maximum data size for each column in a chunk to be used for all new tables.
Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
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.
Sets the root directory path where external table data files are accessed from. Path must exist on the head node.
Number of minutes after which filtering (e.g., /filter) and aggregating (e.g., /aggregate/groupby) queries will timeout.The default value is
20. The minimum allowed value is 0. The maximum allowed value is 1440.The 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.Accept additional date formats when ingesting and casting strings to dates, datetimes, and timestamps: ‘YYYYMMDD’, ‘YYYY/MM/DD’, and month-name forms like ‘Aug 20 2026’ or ‘20 August 2026’, each optionally followed by a time of day. Explicit formats given to TO_DATE(), etc. are unaffected.The default value is
false.Enable or disable auditing.
Enable or disable auditing of request headers.
Enable or disable auditing of request bodies.
Enable or disable auditing of request data.
Enable or disable auditing of response information.
[DEPRECATED—use shadow_cube_size instead] Size of the shadow aggregate chunk cache in bytes.The minimum allowed value is
0. The maximum allowed value is 16000000000.[DEPRECATED—use shadow_cube_size instead] Size of the shadow filter chunk cache in bytes.The minimum allowed value is
0. The maximum allowed value is 16000000000.Size of the shadow cube chunk cache in bytes, shared by aggregate and filter responses. Replaces the deprecated shadow_agg_size / shadow_filter_size options.The default value is
1000000000. The minimum allowed value is 0. The maximum allowed value is 32000000000.Shadow cube probation segment memory ceiling, as a percent of the protected byte budget; the probation entry cap is derived from it.The default value is
5. The minimum allowed value is 1. The maximum allowed value is 10.Enable overlapped-equi-join filter.The default value is
true.Enable the one_step compound-equi-join algorithm.The default value is
true.Maximum 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.Maximum 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.Maximum 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.Enable caching of datalake table metadata.
Maximum number of datalake table metadata entries to cache.
Time-to-live (seconds) for cached datalake table metadata entries.
When enabled, check the current datalake snapshot on cache hits and invalidate entries that have changed.
Maximum number of cached datalake REST catalog connections.
Enable caching of parsed Iceberg manifest and manifest-list files.
Parquet file compression type.The default value is
snappy.The supported values are:- uncompressed
- snappy
- gzip
Max 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.Sets the max_concurrent_kernels value of the conf.The minimum allowed value is
0. The maximum allowed value is 256.Sets the system_metadata.retention_period value of the conf.The minimum allowed value is
1.Size 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.Size of the worker rank data processing thread pool. This includes operations such as inserts, updates, and 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.Size of the worker rank IO thread pool. This is used for blocking IO operations such as reads from object storage or external file systems.
Size of the worker rank background thread pool. This includes background operations such as watermark evictions catalog table updates.The minimum allowed value is
1. The maximum allowed value is 8192.Outputs various job-related information to the rank logs. Used for troubleshooting.
Log a stack trace for any thread that runs longer than a defined threshold. Used for troubleshooting.The default value is
true.Enable RAG.The default value is
false.AI API provider type.
AI API URL.
AI API key.
AI API connection timeout in seconds.
AI API model name.
Enable or disable persisting of query metrics.
Capture metrics for any query exceeding this duration in seconds.
Idle connection timeout in seconds.
Enable PostgreSQL proxy keep alive.The default value is
false.The default maximum capacity to apply when creating a KiFS directory (bytes).The minimum allowed value is
-1.The default compression algorithm applied to any column without a column-level or table-level default compression specified at the time it was created.
Time interval in seconds after which the database will apply optimizations/transformations to persisted data, such as compression.The minimum allowed value is
0.Initializes HA replay from the given timestamp (as milliseconds since unix epoch).The minimum allowed value is
-1.Restricts access to system admin users only.The default value is
false.map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
Show options
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
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
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘alter_system_properties_response’ or ‘none’ in case of an error
String
Empty string
JSON or String