A set of string constants for the parameter property_updates_map. More...

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. 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	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. More...

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. 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	REQUEST_TIMEOUT = "request_timeout"
	Number of minutes after which filtering (e.g., Kinetica.filter) and aggregating (e.g., Kinetica.aggregateGroupBy) 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	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	ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join"
	Enable overlapped-equi-join filter. More...

const string	ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN = "enable_one_step_compound_equi_join"
	Enable the one_step compound-equi-join algorithm. 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. 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	SYSTEM_METADATA_RETENTION_PERIOD = "system_metadata_retention_period"
	Sets the system_metadata.retention_period value of the conf. More...

const string	TCS_PER_TOM = "tcs_per_tom"
	Size of the worker rank data calculation thread pool. More...

const string	TPS_PER_TOM = "tps_per_tom"
	Size of the worker rank data processing thread pool. More...

const string	BACKGROUND_WORKER_THREADS = "background_worker_threads"
	Size of the worker rank background thread pool. More...

const string	LOG_DEBUG_JOB_INFO = "log_debug_job_info"
	Outputs various job-related information to the rank logs. More...

const string	ENABLE_THREAD_HANG_LOGGING = "enable_thread_hang_logging"
	Log a stack trace for any thread that runs longer than a defined threshold. More...

const string	AI_ENABLE_RAG = "ai_enable_rag"
	Enable RAG. 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	AI_API_EMBEDDINGS_MODEL = "ai_api_embeddings_model"
	AI API model name. More...

const string	TELM_PERSIST_QUERY_METRICS = "telm_persist_query_metrics"
	Enable or disable persisting of query metrics. 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...

const string	KIFS_DIRECTORY_DATA_LIMIT = "kifs_directory_data_limit"
	The default maximum capacity to apply when creating a KiFS directory (bytes). More...

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. More...

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. More...

const string	HA_CONSUMER_REPLAY_OFFSET = "ha_consumer_replay_offset"
	Initializes HA replay from the given timestamp (as milliseconds since unix epoch). More...

const string	ADMIN_ACCESS_ONLY = "admin_access_only"
	Restricts access to system admin users only. More...

Detailed Description

A set of string constants for the parameter 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 AlterSystemPropertiesRequest.PropertyUpdatesMap.ADMIN_ACCESS_ONLY = "admin_access_only"

Restricts access to system admin users only.

The default value is 'false'.

Definition at line 280 of file AlterSystemProperties.cs.

◆ AI_API_CONNECTION_TIMEOUT

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_CONNECTION_TIMEOUT = "ai_api_connection_timeout"

AI API connection timeout in seconds.

Definition at line 240 of file AlterSystemProperties.cs.

◆ AI_API_EMBEDDINGS_MODEL

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_EMBEDDINGS_MODEL = "ai_api_embeddings_model"

AI API model name.

Definition at line 243 of file AlterSystemProperties.cs.

◆ AI_API_KEY

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_KEY = "ai_api_key"

AI API key.

Definition at line 237 of file AlterSystemProperties.cs.

◆ AI_API_PROVIDER

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_PROVIDER = "ai_api_provider"

AI API provider type.

Definition at line 231 of file AlterSystemProperties.cs.

◆ AI_API_URL

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_URL = "ai_api_url"

AI API URL.

Definition at line 234 of file AlterSystemProperties.cs.

◆ AI_ENABLE_RAG

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_ENABLE_RAG = "ai_enable_rag"

Enable RAG.

The default value is 'false'.

Definition at line 228 of file AlterSystemProperties.cs.

◆ AUDIT_BODY

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_BODY = "audit_body"

Enable or disable auditing of request bodies.

Definition at line 101 of file AlterSystemProperties.cs.

◆ AUDIT_DATA

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_DATA = "audit_data"

Enable or disable auditing of request data.

Definition at line 104 of file AlterSystemProperties.cs.

◆ AUDIT_HEADERS

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_HEADERS = "audit_headers"

Enable or disable auditing of request headers.

Definition at line 98 of file AlterSystemProperties.cs.

◆ AUDIT_RESPONSE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_RESPONSE = "audit_response"

Enable or disable auditing of response information.

Definition at line 108 of file AlterSystemProperties.cs.

◆ BACKGROUND_WORKER_THREADS

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.BACKGROUND_WORKER_THREADS = "background_worker_threads"

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 213 of file AlterSystemProperties.cs.

◆ CHUNK_COLUMN_MAX_MEMORY

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.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.

Definition at line 60 of file AlterSystemProperties.cs.

◆ CHUNK_MAX_MEMORY

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.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.

Definition at line 64 of file AlterSystemProperties.cs.

◆ CHUNK_SIZE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_SIZE = "chunk_size"

Sets the number of records per chunk to be used for all new tables.

Definition at line 56 of file AlterSystemProperties.cs.

◆ COMPRESSION_CODEC

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.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.

Definition at line 265 of file AlterSystemProperties.cs.

◆ CONCURRENT_KERNEL_EXECUTION

const string 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 43 of file AlterSystemProperties.cs.

◆ DISK_AUTO_OPTIMIZE_TIMEOUT

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.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.

The minimum allowed value is '0'.

Definition at line 271 of file AlterSystemProperties.cs.

◆ EGRESS_PARQUET_COMPRESSION

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.EGRESS_PARQUET_COMPRESSION = "egress_parquet_compression"

Parquet file compression type.

Supported values:

The default value is SNAPPY.

Definition at line 169 of file AlterSystemProperties.cs.

◆ EGRESS_SINGLE_FILE_MAX_SIZE

const string 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'. The minimum allowed value is '1'. The maximum allowed value is '200000'.

Definition at line 180 of file AlterSystemProperties.cs.

◆ ENABLE_AUDIT

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_AUDIT = "enable_audit"

Enable or disable auditing.

Definition at line 95 of file AlterSystemProperties.cs.

◆ ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN = "enable_one_step_compound_equi_join"

Enable the one_step compound-equi-join algorithm.

The default value is 'true'.

Definition at line 130 of file AlterSystemProperties.cs.

◆ ENABLE_OVERLAPPED_EQUI_JOIN

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join"

Enable overlapped-equi-join filter.

The default value is 'true'.

Definition at line 125 of file AlterSystemProperties.cs.

◆ ENABLE_THREAD_HANG_LOGGING

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_THREAD_HANG_LOGGING = "enable_thread_hang_logging"

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 224 of file AlterSystemProperties.cs.

◆ EXECUTION_MODE

const string 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 71 of file AlterSystemProperties.cs.

◆ EXTERNAL_FILES_DIRECTORY

const string 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 76 of file AlterSystemProperties.cs.

◆ FALSE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.FALSE = "false"

Definition at line 46 of file AlterSystemProperties.cs.

◆ GZIP

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.GZIP = "gzip"

Definition at line 173 of file AlterSystemProperties.cs.

◆ HA_CONSUMER_REPLAY_OFFSET

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.HA_CONSUMER_REPLAY_OFFSET = "ha_consumer_replay_offset"

Initializes HA replay from the given timestamp (as milliseconds since unix epoch).

The minimum allowed value is '-1'.

Definition at line 276 of file AlterSystemProperties.cs.

◆ KAFKA_BATCH_SIZE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_BATCH_SIZE = "kafka_batch_size"

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 137 of file AlterSystemProperties.cs.

◆ KAFKA_POLL_TIMEOUT

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_POLL_TIMEOUT = "kafka_poll_timeout"

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 143 of file AlterSystemProperties.cs.

◆ KAFKA_WAIT_TIME

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.KAFKA_WAIT_TIME = "kafka_wait_time"

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 149 of file AlterSystemProperties.cs.

◆ KIFS_DIRECTORY_DATA_LIMIT

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.KIFS_DIRECTORY_DATA_LIMIT = "kifs_directory_data_limit"

The default maximum capacity to apply when creating a KiFS directory (bytes).

The minimum allowed value is '-1'.

Definition at line 258 of file AlterSystemProperties.cs.

◆ LOG_DEBUG_JOB_INFO

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.LOG_DEBUG_JOB_INFO = "log_debug_job_info"

Outputs various job-related information to the rank logs.

Used for troubleshooting.

Definition at line 218 of file AlterSystemProperties.cs.

◆ MAX_CONCURRENT_KERNELS

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.MAX_CONCURRENT_KERNELS = "max_concurrent_kernels"

Sets the max_concurrent_kernels value of the conf.

The minimum allowed value is '0'. The maximum allowed value is '256'.

Definition at line 186 of file AlterSystemProperties.cs.

◆ MAX_GET_RECORDS_SIZE

const string 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'. The minimum allowed value is '0'. The maximum allowed value is '1000000'.

Definition at line 92 of file AlterSystemProperties.cs.

◆ POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = "postgres_proxy_idle_connection_timeout"

Idle connection timeout in seconds.

Definition at line 249 of file AlterSystemProperties.cs.

◆ POSTGRES_PROXY_KEEP_ALIVE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_KEEP_ALIVE = "postgres_proxy_keep_alive"

Enable postgres proxy keep alive.

The default value is 'false'.

Definition at line 253 of file AlterSystemProperties.cs.

◆ REQUEST_TIMEOUT

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.REQUEST_TIMEOUT = "request_timeout"

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 85 of file AlterSystemProperties.cs.

◆ SHADOW_AGG_SIZE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.SHADOW_AGG_SIZE = "shadow_agg_size"

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 115 of file AlterSystemProperties.cs.

◆ SHADOW_FILTER_SIZE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.SHADOW_FILTER_SIZE = "shadow_filter_size"

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 121 of file AlterSystemProperties.cs.

◆ SNAPPY

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.SNAPPY = "snappy"

Definition at line 172 of file AlterSystemProperties.cs.

◆ SUBTASK_CONCURRENCY_LIMIT

const string 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 limited by resource group limits and/or system load.

Definition at line 52 of file AlterSystemProperties.cs.

◆ SYSTEM_METADATA_RETENTION_PERIOD

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.SYSTEM_METADATA_RETENTION_PERIOD = "system_metadata_retention_period"

Sets the system_metadata.retention_period value of the conf.

The minimum allowed value is '1'.

Definition at line 191 of file AlterSystemProperties.cs.

◆ TCS_PER_TOM

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.TCS_PER_TOM = "tcs_per_tom"

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 199 of file AlterSystemProperties.cs.

◆ TELM_PERSIST_QUERY_METRICS

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.TELM_PERSIST_QUERY_METRICS = "telm_persist_query_metrics"

Enable or disable persisting of query metrics.

Definition at line 246 of file AlterSystemProperties.cs.

◆ TPS_PER_TOM

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.TPS_PER_TOM = "tps_per_tom"

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 207 of file AlterSystemProperties.cs.

◆ TRUE

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.TRUE = "true"

Definition at line 45 of file AlterSystemProperties.cs.

◆ UNCOMPRESSED

const string AlterSystemPropertiesRequest.PropertyUpdatesMap.UNCOMPRESSED = "uncompressed"

Definition at line 171 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

◆ ADMIN_ACCESS_ONLY

◆ AI_API_CONNECTION_TIMEOUT

◆ AI_API_EMBEDDINGS_MODEL

◆ AI_API_KEY

◆ AI_API_PROVIDER

◆ AI_API_URL

◆ AI_ENABLE_RAG

◆ AUDIT_BODY

◆ AUDIT_DATA

◆ AUDIT_HEADERS

◆ AUDIT_RESPONSE

◆ BACKGROUND_WORKER_THREADS

◆ CHUNK_COLUMN_MAX_MEMORY

◆ CHUNK_MAX_MEMORY

◆ CHUNK_SIZE

◆ COMPRESSION_CODEC

◆ CONCURRENT_KERNEL_EXECUTION

◆ DISK_AUTO_OPTIMIZE_TIMEOUT

◆ EGRESS_PARQUET_COMPRESSION

◆ EGRESS_SINGLE_FILE_MAX_SIZE

◆ ENABLE_AUDIT

◆ ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN

◆ ENABLE_OVERLAPPED_EQUI_JOIN

◆ ENABLE_THREAD_HANG_LOGGING

◆ EXECUTION_MODE

◆ EXTERNAL_FILES_DIRECTORY

◆ FALSE

◆ GZIP

◆ HA_CONSUMER_REPLAY_OFFSET

◆ KAFKA_BATCH_SIZE

◆ KAFKA_POLL_TIMEOUT

◆ KAFKA_WAIT_TIME

◆ KIFS_DIRECTORY_DATA_LIMIT

◆ LOG_DEBUG_JOB_INFO

◆ MAX_CONCURRENT_KERNELS

◆ MAX_GET_RECORDS_SIZE

◆ POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT

◆ POSTGRES_PROXY_KEEP_ALIVE

◆ REQUEST_TIMEOUT

◆ SHADOW_AGG_SIZE

◆ SHADOW_FILTER_SIZE

◆ SNAPPY

◆ SUBTASK_CONCURRENCY_LIMIT

◆ SYSTEM_METADATA_RETENTION_PERIOD

◆ TCS_PER_TOM

◆ TELM_PERSIST_QUERY_METRICS

◆ TPS_PER_TOM

◆ TRUE

◆ UNCOMPRESSED