Skip to main content

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 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”
 Size of the shadow aggregate chunk cache in bytes.
 
const string SHADOW_FILTER_SIZE = “shadow_filter_size”
 Size of the shadow filter chunk cache in bytes.
 
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 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 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 postgres proxy keep alive.
 
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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ADMIN_ACCESS_ONLY = “admin_access_only”
static

Restricts access to system admin users only.

The default value is ‘false’.

Definition at line 310 of file AlterSystemProperties.cs.

◆ AI_API_CONNECTION_TIMEOUT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_CONNECTION_TIMEOUT = “ai_api_connection_timeout”
static

AI API connection timeout in seconds.

Definition at line 266 of file AlterSystemProperties.cs.

◆ AI_API_EMBEDDINGS_MODEL

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_EMBEDDINGS_MODEL = “ai_api_embeddings_model”
static

AI API model name.

Definition at line 269 of file AlterSystemProperties.cs.

◆ AI_API_KEY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_KEY = “ai_api_key”
static

AI API key.

Definition at line 263 of file AlterSystemProperties.cs.

◆ AI_API_PROVIDER

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_PROVIDER = “ai_api_provider”
static

AI API provider type.

Definition at line 257 of file AlterSystemProperties.cs.

◆ AI_API_URL

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_URL = “ai_api_url”
static

AI API URL.

Definition at line 260 of file AlterSystemProperties.cs.

◆ AI_ENABLE_RAG

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_ENABLE_RAG = “ai_enable_rag”
static

Enable RAG.

The default value is ‘false’.

Definition at line 254 of file AlterSystemProperties.cs.

◆ AUDIT_BODY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_BODY = “audit_body”
static

Enable or disable auditing of request bodies.

Definition at line 112 of file AlterSystemProperties.cs.

◆ AUDIT_DATA

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_DATA = “audit_data”
static

Enable or disable auditing of request data.

Definition at line 115 of file AlterSystemProperties.cs.

◆ AUDIT_HEADERS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_HEADERS = “audit_headers”
static

Enable or disable auditing of request headers.

Definition at line 109 of file AlterSystemProperties.cs.

◆ AUDIT_RESPONSE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_RESPONSE = “audit_response”
static

Enable or disable auditing of response information.

Definition at line 119 of file AlterSystemProperties.cs.

◆ BACKGROUND_WORKER_THREADS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.BACKGROUND_WORKER_THREADS = “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 239 of file AlterSystemProperties.cs.

◆ CHUNK_COLUMN_MAX_MEMORY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_COLUMN_MAX_MEMORY = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_MAX_MEMORY = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_SIZE = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.COMPRESSION_CODEC = “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 295 of file AlterSystemProperties.cs.

◆ CONCURRENT_KERNEL_EXECUTION

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CONCURRENT_KERNEL_EXECUTION = “concurrent_kernel_execution”
static

Enables concurrent kernel execution if the value is TRUE and disables it if the value is FALSE.

Supported values:

Definition at line 47 of file AlterSystemProperties.cs.

◆ DISK_AUTO_OPTIMIZE_TIMEOUT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.DISK_AUTO_OPTIMIZE_TIMEOUT = “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 301 of file AlterSystemProperties.cs.

◆ EGRESS_PARQUET_COMPRESSION

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EGRESS_PARQUET_COMPRESSION = “egress_parquet_compression”
static

Parquet file compression type.

Supported values:

The default value is SNAPPY.

Definition at line 184 of file AlterSystemProperties.cs.

◆ EGRESS_SINGLE_FILE_MAX_SIZE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EGRESS_SINGLE_FILE_MAX_SIZE = “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 206 of file AlterSystemProperties.cs.

◆ ENABLE_AUDIT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_AUDIT = “enable_audit”
static

Enable or disable auditing.

Definition at line 106 of file AlterSystemProperties.cs.

◆ ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN = “enable_one_step_compound_equi_join”
static

Enable the one_step compound-equi-join algorithm.

The default value is ‘true’.

Definition at line 141 of file AlterSystemProperties.cs.

◆ ENABLE_OVERLAPPED_EQUI_JOIN

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_OVERLAPPED_EQUI_JOIN = “enable_overlapped_equi_join”
static

Enable overlapped-equi-join filter.

The default value is ‘true’.

Definition at line 136 of file AlterSystemProperties.cs.

◆ ENABLE_THREAD_HANG_LOGGING

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_THREAD_HANG_LOGGING = “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 250 of file AlterSystemProperties.cs.

◆ EXECUTION_MODE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EXECUTION_MODE = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EXTERNAL_FILES_DIRECTORY = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.FALSE = “false”
static

A boolean constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.

Definition at line 57 of file AlterSystemProperties.cs.

◆ GZIP

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.GZIP = “gzip”
static

A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.

Definition at line 199 of file AlterSystemProperties.cs.

◆ HA_CONSUMER_REPLAY_OFFSET

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.HA_CONSUMER_REPLAY_OFFSET = “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 306 of file AlterSystemProperties.cs.

◆ KAFKA_BATCH_SIZE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_BATCH_SIZE = “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 148 of file AlterSystemProperties.cs.

◆ KAFKA_POLL_TIMEOUT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_POLL_TIMEOUT = “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 154 of file AlterSystemProperties.cs.

◆ KAFKA_WAIT_TIME

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_WAIT_TIME = “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 160 of file AlterSystemProperties.cs.

◆ KIFS_DIRECTORY_DATA_LIMIT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.KIFS_DIRECTORY_DATA_LIMIT = “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 288 of file AlterSystemProperties.cs.

◆ LOG_DEBUG_JOB_INFO

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.LOG_DEBUG_JOB_INFO = “log_debug_job_info”
static

Outputs various job-related information to the rank logs.

Used for troubleshooting.

Definition at line 244 of file AlterSystemProperties.cs.

◆ MAX_CONCURRENT_KERNELS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.MAX_CONCURRENT_KERNELS = “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 212 of file AlterSystemProperties.cs.

◆ MAX_GET_RECORDS_SIZE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.MAX_GET_RECORDS_SIZE = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = “postgres_proxy_idle_connection_timeout”
static

Idle connection timeout in seconds.

Definition at line 279 of file AlterSystemProperties.cs.

◆ POSTGRES_PROXY_KEEP_ALIVE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_KEEP_ALIVE = “postgres_proxy_keep_alive”
static

Enable postgres proxy keep alive.

The default value is ‘false’.

Definition at line 283 of file AlterSystemProperties.cs.

◆ REQUEST_TIMEOUT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.REQUEST_TIMEOUT = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SHADOW_AGG_SIZE = “shadow_agg_size”
static

Size 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’.

Definition at line 126 of file AlterSystemProperties.cs.

◆ SHADOW_FILTER_SIZE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SHADOW_FILTER_SIZE = “shadow_filter_size”
static

Size 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’.

Definition at line 132 of file AlterSystemProperties.cs.

◆ SNAPPY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SNAPPY = “snappy”
static

A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.

Definition at line 194 of file AlterSystemProperties.cs.

◆ SUBTASK_CONCURRENCY_LIMIT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SUBTASK_CONCURRENCY_LIMIT = “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

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SYSTEM_METADATA_RETENTION_PERIOD = “system_metadata_retention_period”
static

Sets the system_metadata.retention_period value of the conf.

The minimum allowed value is ‘1’.

Definition at line 217 of file AlterSystemProperties.cs.

◆ TCS_PER_TOM

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TCS_PER_TOM = “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 225 of file AlterSystemProperties.cs.

◆ TELM_FORCE_METRICS_DURATION

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TELM_FORCE_METRICS_DURATION = “telm_force_metrics_duration”
static

Capture metrics for any query exceeding this duration in seconds.

Definition at line 276 of file AlterSystemProperties.cs.

◆ TELM_PERSIST_QUERY_METRICS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TELM_PERSIST_QUERY_METRICS = “telm_persist_query_metrics”
static

Enable or disable persisting of query metrics.

Definition at line 272 of file AlterSystemProperties.cs.

◆ TPS_PER_TOM

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TPS_PER_TOM = “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 233 of file AlterSystemProperties.cs.

◆ TRUE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TRUE = “true”
static

A boolean constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.

Definition at line 52 of file AlterSystemProperties.cs.

◆ UNCOMPRESSED

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.UNCOMPRESSED = “uncompressed”
static

A constant for the AlterSystemPropertiesRequest.PropertyUpdatesMap options.

Definition at line 189 of file AlterSystemProperties.cs.


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