A set of string constants for the parameter AlterSystemPropertiesRequest.property_updates_map. More…
Static Public Attributes | |
| 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. | |
| const string | TRUE = “true” |
| A boolean constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options. | |
| const string | FALSE = “false” |
| A boolean constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options. | |
| const string | SUBTASK_CONCURRENCY_LIMIT = “subtask_concurrency_limit” |
| Sets the maximum number of simultaneous threads allocated to a given request, on each rank. | |
| const string | CHUNK_SIZE = “chunk_size” |
| Sets the number of records per chunk to be used for all new tables. | |
| const string | CHUNK_COLUMN_MAX_MEMORY = “chunk_column_max_memory” |
| Sets the target maximum data size for each column in a chunk to be used for all new tables. | |
| const string | CHUNK_MAX_MEMORY = “chunk_max_memory” |
| Indicates the target maximum data size for all columns in a chunk to be used for all new tables. | |
| const string | EXECUTION_MODE = “execution_mode” |
| Sets the execution_mode for kernel executions to the specified string value. | |
| const string | EXTERNAL_FILES_DIRECTORY = “external_files_directory” |
| Sets the root directory path where external table data files are accessed from. | |
| const string | REQUEST_TIMEOUT = “request_timeout” |
| Number of minutes after which filtering (e.g., Kinetica.filter) and aggregating (e.g., Kinetica.aggregateGroupBy) queries will timeout. | |
| 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. | |
| const string | SQL_SESSION_IDLE_TIMEOUT = “sql_session_idle_timeout” |
| Number of minutes after its last request that a client session is automatically dropped, along with its session temp tables (tables named #name in SQL). | |
| const string | ALLOW_ALTERNATE_DATE_FORMATS = “allow_alternate_date_formats” |
| 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. | |
| const string | ENABLE_AUDIT = “enable_audit” |
| Enable or disable auditing. | |
| const string | AUDIT_HEADERS = “audit_headers” |
| Enable or disable auditing of request headers. | |
| const string | AUDIT_BODY = “audit_body” |
| Enable or disable auditing of request bodies. | |
| const string | AUDIT_DATA = “audit_data” |
| Enable or disable auditing of request data. | |
| const string | AUDIT_RESPONSE = “audit_response” |
| Enable or disable auditing of response information. | |
| const string | SHADOW_AGG_SIZE = “shadow_agg_size” |
| [DEPRECATED–use SHADOW_CUBE_SIZE instead] Size of the shadow aggregate chunk cache in bytes. | |
| const string | SHADOW_FILTER_SIZE = “shadow_filter_size” |
| [DEPRECATED–use SHADOW_CUBE_SIZE instead] Size of the shadow filter chunk cache in bytes. | |
| const string | SHADOW_CUBE_SIZE = “shadow_cube_size” |
| Size of the shadow cube chunk cache in bytes, shared by aggregate and filter responses. | |
| const string | SHADOW_CUBE_PROBATION_PERCENT = “shadow_cube_probation_percent” |
| Shadow cube probation segment memory ceiling, as a percent of the protected byte budget; the probation entry cap is derived from it. | |
| const string | ENABLE_OVERLAPPED_EQUI_JOIN = “enable_overlapped_equi_join” |
| Enable overlapped-equi-join filter. | |
| const string | ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN = “enable_one_step_compound_equi_join” |
| Enable the one_step compound-equi-join algorithm. | |
| const string | KAFKA_BATCH_SIZE = “kafka_batch_size” |
| Maximum number of records to be ingested in a single batch. | |
| const string | KAFKA_POLL_TIMEOUT = “kafka_poll_timeout” |
| Maximum time (milliseconds) for each poll to get records from Kafka. | |
| const string | KAFKA_WAIT_TIME = “kafka_wait_time” |
| Maximum time (seconds) to buffer records received from Kafka before ingestion. | |
| const string | DATALAKE_TABLE_METADATA_CACHE_ENABLED = “datalake_table_metadata_cache_enabled” |
| Enable caching of datalake table metadata. | |
| const string | DATALAKE_TABLE_METADATA_CACHE_SIZE = “datalake_table_metadata_cache_size” |
| Maximum number of datalake table metadata entries to cache. | |
| const string | DATALAKE_TABLE_METADATA_CACHE_TTL = “datalake_table_metadata_cache_ttl” |
| Time-to-live (seconds) for cached datalake table metadata entries. | |
| const string | DATALAKE_TABLE_METADATA_CACHE_SNAPSHOT_CHECK = “datalake_table_metadata_cache_snapshot_check” |
| When enabled, check the current datalake snapshot on cache hits and invalidate entries that have changed. | |
| const string | DATALAKE_CATALOG_CONNECTION_CACHE_SIZE = “datalake_catalog_connection_cache_size” |
| Maximum number of cached datalake REST catalog connections. | |
| const string | ICEBERG_MANIFEST_CACHE_ENABLED = “iceberg_manifest_cache_enabled” |
| Enable caching of parsed Iceberg manifest and manifest-list files. | |
| const string | EGRESS_PARQUET_COMPRESSION = “egress_parquet_compression” |
| Parquet file compression type. | |
| const string | UNCOMPRESSED = “uncompressed” |
| A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options. | |
| const string | SNAPPY = “snappy” |
| A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options. | |
| const string | GZIP = “gzip” |
| A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options. | |
| const string | EGRESS_SINGLE_FILE_MAX_SIZE = “egress_single_file_max_size” |
| Max file size (in MB) to allow saving to a single file. | |
| const string | MAX_CONCURRENT_KERNELS = “max_concurrent_kernels” |
| Sets the max_concurrent_kernels value of the conf. | |
| const string | SYSTEM_METADATA_RETENTION_PERIOD = “system_metadata_retention_period” |
| Sets the system_metadata.retention_period value of the conf. | |
| const string | TCS_PER_TOM = “tcs_per_tom” |
| Size of the worker rank data calculation thread pool. | |
| const string | TPS_PER_TOM = “tps_per_tom” |
| Size of the worker rank data processing thread pool. | |
| const string | REMOTE_IO_THREADS = “remote_io_threads” |
| Size of the worker rank IO thread pool. | |
| const string | BACKGROUND_WORKER_THREADS = “background_worker_threads” |
| Size of the worker rank background thread pool. | |
| const string | LOG_DEBUG_JOB_INFO = “log_debug_job_info” |
| Outputs various job-related information to the rank logs. | |
| const string | ENABLE_THREAD_HANG_LOGGING = “enable_thread_hang_logging” |
| Log a stack trace for any thread that runs longer than a defined threshold. | |
| const string | AI_ENABLE_RAG = “ai_enable_rag” |
| Enable RAG. | |
| const string | AI_API_PROVIDER = “ai_api_provider” |
| AI API provider type. | |
| const string | AI_API_URL = “ai_api_url” |
| AI API URL. | |
| const string | AI_API_KEY = “ai_api_key” |
| AI API key. | |
| const string | AI_API_CONNECTION_TIMEOUT = “ai_api_connection_timeout” |
| AI API connection timeout in seconds. | |
| const string | AI_API_EMBEDDINGS_MODEL = “ai_api_embeddings_model” |
| AI API model name. | |
| const string | TELM_PERSIST_QUERY_METRICS = “telm_persist_query_metrics” |
| Enable or disable persisting of query metrics. | |
| const string | TELM_FORCE_METRICS_DURATION = “telm_force_metrics_duration” |
| Capture metrics for any query exceeding this duration in seconds. | |
| const string | POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = “postgres_proxy_idle_connection_timeout” |
| Idle connection timeout in seconds. | |
| const string | POSTGRES_PROXY_KEEP_ALIVE = “postgres_proxy_keep_alive” |
| Enable PostgreSQL proxy keep alive. | |
| const string | POSTGRES_PROXY_MAX_QUEUED_CONNECTIONS = “postgres_proxy_max_queued_connections” |
| Maximum number of PostgreSQL proxy connections queued while waiting for a server thread; connections arriving while the queue is full are refused. | |
| const string | KIFS_DIRECTORY_DATA_LIMIT = “kifs_directory_data_limit” |
| The default maximum capacity to apply when creating a KiFS directory (bytes). | |
| const string | COMPRESSION_CODEC = “compression_codec” |
| The default compression algorithm applied to any column without a column-level or table-level default compression specified at the time it was created. | |
| const string | DISK_AUTO_OPTIMIZE_TIMEOUT = “disk_auto_optimize_timeout” |
| Time interval in seconds after which the database will apply optimizations/transformations to persisted data, such as compression. | |
| const string | HA_CONSUMER_REPLAY_OFFSET = “ha_consumer_replay_offset” |
| Initializes HA replay from the given timestamp (as milliseconds since unix epoch). | |
| const string | ADMIN_ACCESS_ONLY = “admin_access_only” |
| Restricts access to system admin users only. | |
Detailed Description
A set of string constants for the parameter AlterSystemPropertiesRequest.property_updates_map.
Map containing the properties of the system to be updated. Error if empty.
Definition at line 27 of file AlterSystemProperties.cs.
Member Data Documentation
◆ ADMIN_ACCESS_ONLY
| static |
Restricts access to system admin users only.
The default value is ‘false’.
Definition at line 388 of file AlterSystemProperties.cs.
◆ AI_API_CONNECTION_TIMEOUT
| static |
AI API connection timeout in seconds.
Definition at line 336 of file AlterSystemProperties.cs.
◆ AI_API_EMBEDDINGS_MODEL
| static |
AI API model name.
Definition at line 339 of file AlterSystemProperties.cs.
◆ AI_API_KEY
| static |
AI API key.
Definition at line 333 of file AlterSystemProperties.cs.
◆ AI_API_PROVIDER
| static |
AI API provider type.
Definition at line 327 of file AlterSystemProperties.cs.
◆ AI_API_URL
| static |
AI API URL.
Definition at line 330 of file AlterSystemProperties.cs.
◆ AI_ENABLE_RAG
| static |
◆ ALLOW_ALTERNATE_DATE_FORMATS
| static |
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’.
Definition at line 121 of file AlterSystemProperties.cs.
◆ AUDIT_BODY
| static |
Enable or disable auditing of request bodies.
Definition at line 130 of file AlterSystemProperties.cs.
◆ AUDIT_DATA
| static |
Enable or disable auditing of request data.
Definition at line 133 of file AlterSystemProperties.cs.
◆ AUDIT_HEADERS
| static |
Enable or disable auditing of request headers.
Definition at line 127 of file AlterSystemProperties.cs.
◆ AUDIT_RESPONSE
| static |
Enable or disable auditing of response information.
Definition at line 137 of file AlterSystemProperties.cs.
◆ BACKGROUND_WORKER_THREADS
| static |
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’.
Definition at line 309 of file AlterSystemProperties.cs.
◆ CHUNK_COLUMN_MAX_MEMORY
| static |
Sets the target maximum data size for each column in a chunk to be used for all new tables.
Definition at line 71 of file AlterSystemProperties.cs.
◆ CHUNK_MAX_MEMORY
| static |
Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
Definition at line 75 of file AlterSystemProperties.cs.
◆ CHUNK_SIZE
| static |
Sets the number of records per chunk to be used for all new tables.
Definition at line 67 of file AlterSystemProperties.cs.
◆ COMPRESSION_CODEC
| static |
The default compression algorithm applied to any column without a column-level or table-level default compression specified at the time it was created.
Definition at line 373 of file AlterSystemProperties.cs.
◆ CONCURRENT_KERNEL_EXECUTION
| static |
◆ DATALAKE_CATALOG_CONNECTION_CACHE_SIZE
| static |
Maximum number of cached datalake REST catalog connections.
Definition at line 217 of file AlterSystemProperties.cs.
◆ DATALAKE_TABLE_METADATA_CACHE_ENABLED
| static |
Enable caching of datalake table metadata.
Definition at line 201 of file AlterSystemProperties.cs.
◆ DATALAKE_TABLE_METADATA_CACHE_SIZE
| static |
Maximum number of datalake table metadata entries to cache.
Definition at line 205 of file AlterSystemProperties.cs.
◆ DATALAKE_TABLE_METADATA_CACHE_SNAPSHOT_CHECK
| static |
When enabled, check the current datalake snapshot on cache hits and invalidate entries that have changed.
Definition at line 213 of file AlterSystemProperties.cs.
◆ DATALAKE_TABLE_METADATA_CACHE_TTL
| static |
Time-to-live (seconds) for cached datalake table metadata entries.
Definition at line 209 of file AlterSystemProperties.cs.
◆ DISK_AUTO_OPTIMIZE_TIMEOUT
| static |
Time interval in seconds after which the database will apply optimizations/transformations to persisted data, such as compression.
The minimum allowed value is ‘0’.
Definition at line 379 of file AlterSystemProperties.cs.
◆ EGRESS_PARQUET_COMPRESSION
| static |
Parquet file compression type.
Supported values:
The default value is SNAPPY.
Definition at line 245 of file AlterSystemProperties.cs.
◆ EGRESS_SINGLE_FILE_MAX_SIZE
| static |
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’.
Definition at line 267 of file AlterSystemProperties.cs.
◆ ENABLE_AUDIT
| static |
Enable or disable auditing.
Definition at line 124 of file AlterSystemProperties.cs.
◆ ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
| static |
Enable the one_step compound-equi-join algorithm.
The default value is ‘true’.
Definition at line 179 of file AlterSystemProperties.cs.
◆ ENABLE_OVERLAPPED_EQUI_JOIN
| static |
Enable overlapped-equi-join filter.
The default value is ‘true’.
Definition at line 174 of file AlterSystemProperties.cs.
◆ ENABLE_THREAD_HANG_LOGGING
| static |
Log a stack trace for any thread that runs longer than a defined threshold.
Used for troubleshooting. The default value is ‘true’.
Definition at line 320 of file AlterSystemProperties.cs.
◆ EXECUTION_MODE
| static |
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 82 of file AlterSystemProperties.cs.
◆ EXTERNAL_FILES_DIRECTORY
| static |
Sets the root directory path where external table data files are accessed from.
Path must exist on the head node.
Definition at line 87 of file AlterSystemProperties.cs.
◆ FALSE
| static |
A boolean constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.
Definition at line 57 of file AlterSystemProperties.cs.
◆ GZIP
| static |
A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.
Definition at line 260 of file AlterSystemProperties.cs.
◆ HA_CONSUMER_REPLAY_OFFSET
| static |
Initializes HA replay from the given timestamp (as milliseconds since unix epoch).
The minimum allowed value is ‘-1’.
Definition at line 384 of file AlterSystemProperties.cs.
◆ ICEBERG_MANIFEST_CACHE_ENABLED
| static |
Enable caching of parsed Iceberg manifest and manifest-list files.
Definition at line 221 of file AlterSystemProperties.cs.
◆ KAFKA_BATCH_SIZE
| static |
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’.
Definition at line 186 of file AlterSystemProperties.cs.
◆ KAFKA_POLL_TIMEOUT
| static |
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’.
Definition at line 192 of file AlterSystemProperties.cs.
◆ KAFKA_WAIT_TIME
| static |
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’.
Definition at line 198 of file AlterSystemProperties.cs.
◆ KIFS_DIRECTORY_DATA_LIMIT
| static |
The default maximum capacity to apply when creating a KiFS directory (bytes).
The minimum allowed value is ‘-1’.
Definition at line 366 of file AlterSystemProperties.cs.
◆ LOG_DEBUG_JOB_INFO
| static |
Outputs various job-related information to the rank logs.
Used for troubleshooting.
Definition at line 314 of file AlterSystemProperties.cs.
◆ MAX_CONCURRENT_KERNELS
| static |
Sets the max_concurrent_kernels value of the conf.
The minimum allowed value is ‘0’. The maximum allowed value is ‘256’.
Definition at line 274 of file AlterSystemProperties.cs.
◆ MAX_GET_RECORDS_SIZE
| static |
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’.
Definition at line 103 of file AlterSystemProperties.cs.
◆ POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
| static |
Idle connection timeout in seconds.
Definition at line 349 of file AlterSystemProperties.cs.
◆ POSTGRES_PROXY_KEEP_ALIVE
| static |
Enable PostgreSQL proxy keep alive.
The default value is ‘false’.
Definition at line 353 of file AlterSystemProperties.cs.
◆ POSTGRES_PROXY_MAX_QUEUED_CONNECTIONS
| static |
Maximum number of PostgreSQL proxy connections queued while waiting for a server thread; connections arriving while the queue is full are refused.
Takes effect immediately for new connections. The default value is ‘64’. The minimum allowed value is ‘1’.
Definition at line 361 of file AlterSystemProperties.cs.
◆ REMOTE_IO_THREADS
| static |
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.
Definition at line 303 of file AlterSystemProperties.cs.
◆ REQUEST_TIMEOUT
| static |
Number of minutes after which filtering (e.g., Kinetica.filter) and aggregating (e.g., Kinetica.aggregateGroupBy) queries will timeout.
The default value is ‘20’. The minimum allowed value is ‘0’. The maximum allowed value is ‘1440’.
Definition at line 96 of file AlterSystemProperties.cs.
◆ SHADOW_AGG_SIZE
| static |
[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’.
Definition at line 145 of file AlterSystemProperties.cs.
◆ SHADOW_CUBE_PROBATION_PERCENT
| static |
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’.
Definition at line 170 of file AlterSystemProperties.cs.
◆ SHADOW_CUBE_SIZE
| static |
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’.
Definition at line 163 of file AlterSystemProperties.cs.
◆ SHADOW_FILTER_SIZE
| static |
[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’.
Definition at line 152 of file AlterSystemProperties.cs.
◆ SNAPPY
| static |
A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.
Definition at line 255 of file AlterSystemProperties.cs.
◆ SQL_SESSION_IDLE_TIMEOUT
| static |
Number of minutes after its last request that a client session is automatically dropped, along with its session temp tables (tables named #name in SQL).
Use 0 to keep sessions until they are explicitly dropped with Kinetica.dropSession. The default value is ‘60’. The minimum allowed value is ‘0’.
Definition at line 113 of file AlterSystemProperties.cs.
◆ SUBTASK_CONCURRENCY_LIMIT
| static |
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.
Definition at line 63 of file AlterSystemProperties.cs.
◆ SYSTEM_METADATA_RETENTION_PERIOD
| static |
Sets the system_metadata.retention_period value of the conf.
The minimum allowed value is ‘1’.
Definition at line 281 of file AlterSystemProperties.cs.
◆ TCS_PER_TOM
| static |
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’.
Definition at line 289 of file AlterSystemProperties.cs.
◆ TELM_FORCE_METRICS_DURATION
| static |
Capture metrics for any query exceeding this duration in seconds.
Definition at line 346 of file AlterSystemProperties.cs.
◆ TELM_PERSIST_QUERY_METRICS
| static |
Enable or disable persisting of query metrics.
Definition at line 342 of file AlterSystemProperties.cs.
◆ TPS_PER_TOM
| static |
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’.
Definition at line 297 of file AlterSystemProperties.cs.
◆ TRUE
| static |
A boolean constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.
Definition at line 52 of file AlterSystemProperties.cs.
◆ UNCOMPRESSED
| static |
A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.
Definition at line 250 of file AlterSystemProperties.cs.
The documentation for this struct was generated from the following file:
- Kinetica/Protocol/AlterSystemProperties.cs