Kinetica   C#   API  Version 7.2.3.0
kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap Struct Reference

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 EVICT_COLUMNS = "evict_columns"
 Attempts to evict columns from memory to the persistent store. 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 FLUSH_TO_DISK = "flush_to_disk"
 Flushes any changes to any tables to the persistent store. More...
 
const string CLEAR_CACHE = "clear_cache"
 Clears cached results. More...
 
const string COMMUNICATOR_TEST = "communicator_test"
 Invoke the communicator test and report timing results. More...
 
const string NETWORK_SPEED = "network_speed"
 Invoke the network speed test and report timing results. 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 MAX_GRBC_BATCH_SIZE = "max_grbc_batch_size"
 <DEVELOPER> 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 SYNCHRONOUS_COMPRESSION = "synchronous_compression"
 compress vector on set_compression (instead of waiting for background thread). 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"
 Sets the tcs_per_tom value of the conf. More...
 
const string TPS_PER_TOM = "tps_per_tom"
 Sets the tps_per_tom value of the conf. More...
 
const string BACKGROUND_WORKER_THREADS = "background_worker_threads"
 Size of the worker rank background thread pool. 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...
 

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

◆ AI_API_CONNECTION_TIMEOUT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_CONNECTION_TIMEOUT = "ai_api_connection_timeout"

AI API connection timeout in seconds

Definition at line 291 of file AlterSystemProperties.cs.

◆ AI_API_EMBEDDINGS_MODEL

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_EMBEDDINGS_MODEL = "ai_api_embeddings_model"

AI API model name

Definition at line 294 of file AlterSystemProperties.cs.

◆ AI_API_KEY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_KEY = "ai_api_key"

AI API key

Definition at line 288 of file AlterSystemProperties.cs.

◆ AI_API_PROVIDER

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_PROVIDER = "ai_api_provider"

AI API provider type

Definition at line 282 of file AlterSystemProperties.cs.

◆ AI_API_URL

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_API_URL = "ai_api_url"

AI API URL

Definition at line 285 of file AlterSystemProperties.cs.

◆ AI_ENABLE_RAG

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AI_ENABLE_RAG = "ai_enable_rag"

Enable RAG.

The default value is 'false'.

Definition at line 279 of file AlterSystemProperties.cs.

◆ AUDIT_BODY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_BODY = "audit_body"

Enable or disable auditing of request bodies.

Definition at line 157 of file AlterSystemProperties.cs.

◆ AUDIT_DATA

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_DATA = "audit_data"

Enable or disable auditing of request data.

Definition at line 160 of file AlterSystemProperties.cs.

◆ AUDIT_HEADERS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_HEADERS = "audit_headers"

Enable or disable auditing of request headers.

Definition at line 153 of file AlterSystemProperties.cs.

◆ AUDIT_RESPONSE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.AUDIT_RESPONSE = "audit_response"

Enable or disable auditing of response information.

Definition at line 164 of file AlterSystemProperties.cs.

◆ BACKGROUND_WORKER_THREADS

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

◆ CHUNK_COLUMN_MAX_MEMORY

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

◆ CHUNK_MAX_MEMORY

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

◆ CHUNK_SIZE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CHUNK_SIZE = "chunk_size"

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

Definition at line 57 of file AlterSystemProperties.cs.

◆ CLEAR_CACHE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.CLEAR_CACHE = "clear_cache"

Clears cached results.

Useful to allow repeated timing of endpoints. Value string is the name of the table for which to clear the cached results, or an empty string to clear the cached results for all tables.

Definition at line 102 of file AlterSystemProperties.cs.

◆ COMMUNICATOR_TEST

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.COMMUNICATOR_TEST = "communicator_test"

Invoke the communicator test and report timing results.

Value string is a semicolon separated list of [key]=[value] expressions. Expressions are: num_transactions=[num] where num is the number of request reply transactions to invoke per test; message_size=[bytes] where bytes is the size in bytes of the messages to send; check_values=[enabled] where if enabled is true the value of the messages received are verified.

Definition at line 113 of file AlterSystemProperties.cs.

◆ CONCURRENT_KERNEL_EXECUTION

const string kinetica.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:

Definition at line 44 of file AlterSystemProperties.cs.

◆ EGRESS_PARQUET_COMPRESSION

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EGRESS_PARQUET_COMPRESSION = "egress_parquet_compression"

Parquet file compression type.

Supported values:

The default value is SNAPPY.

Definition at line 234 of file AlterSystemProperties.cs.

◆ EGRESS_SINGLE_FILE_MAX_SIZE

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

◆ ENABLE_AUDIT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_AUDIT = "enable_audit"

Enable or disable auditing.

Definition at line 149 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"

Enable the one_step compound-equi-join algorithm.

The default value is 'true'.

Definition at line 192 of file AlterSystemProperties.cs.

◆ ENABLE_OVERLAPPED_EQUI_JOIN

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join"

Enable overlapped-equi-join filter.

The default value is 'true'.

Definition at line 187 of file AlterSystemProperties.cs.

◆ EVICT_COLUMNS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.EVICT_COLUMNS = "evict_columns"

Attempts to evict columns from memory to the persistent store.

Value string is a semicolon separated list of entries, each entry being a table name optionally followed by a comma and a comma separated list of column names to attempt to evict. An empty value string will attempt to evict all tables and columns.

Definition at line 74 of file AlterSystemProperties.cs.

◆ EXECUTION_MODE

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

◆ EXTERNAL_FILES_DIRECTORY

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

◆ FALSE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.FALSE = "false"

Definition at line 47 of file AlterSystemProperties.cs.

◆ FLUSH_TO_DISK

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.FLUSH_TO_DISK = "flush_to_disk"

Flushes any changes to any tables to the persistent store.

These changes include updates to the vector store, object store, and text search store. Value string can be 'true', 'false' or 'text_search' to flush the text search store only.

Definition at line 95 of file AlterSystemProperties.cs.

◆ GZIP

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.GZIP = "gzip"

Definition at line 238 of file AlterSystemProperties.cs.

◆ KAFKA_BATCH_SIZE

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

◆ KAFKA_POLL_TIMEOUT

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

◆ KAFKA_WAIT_TIME

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

◆ KIFS_DIRECTORY_DATA_LIMIT

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

◆ MAX_CONCURRENT_KERNELS

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

◆ MAX_GET_RECORDS_SIZE

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

◆ MAX_GRBC_BATCH_SIZE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.MAX_GRBC_BATCH_SIZE = "max_grbc_batch_size"

<DEVELOPER>

Definition at line 146 of file AlterSystemProperties.cs.

◆ NETWORK_SPEED

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.NETWORK_SPEED = "network_speed"

Invoke the network speed test and report timing results.

Value string is a semicolon-separated list of [key]=[value] expressions. Valid expressions are: seconds=[time] where time is the time in seconds to run the test; data_size=[bytes] where bytes is the size in bytes of the block to be transferred; threads=[number of threads]; to_ranks=[space-separated list of ranks] where the list of ranks is the ranks that rank 0 will send data to and get data from. If to_ranks is unspecified then all worker ranks are used.

Definition at line 126 of file AlterSystemProperties.cs.

◆ POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = "postgres_proxy_idle_connection_timeout"

Idle connection timeout in seconds

Definition at line 301 of file AlterSystemProperties.cs.

◆ POSTGRES_PROXY_KEEP_ALIVE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.POSTGRES_PROXY_KEEP_ALIVE = "postgres_proxy_keep_alive"

Enable postgres proxy keep alive.

The default value is 'false'.

Definition at line 305 of file AlterSystemProperties.cs.

◆ REQUEST_TIMEOUT

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

◆ SHADOW_AGG_SIZE

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

◆ SHADOW_FILTER_SIZE

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

◆ SNAPPY

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SNAPPY = "snappy"

Definition at line 237 of file AlterSystemProperties.cs.

◆ SUBTASK_CONCURRENCY_LIMIT

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

Definition at line 53 of file AlterSystemProperties.cs.

◆ SYNCHRONOUS_COMPRESSION

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.SYNCHRONOUS_COMPRESSION = "synchronous_compression"

compress vector on set_compression (instead of waiting for background thread).

The default value is 'false'.

Definition at line 183 of file AlterSystemProperties.cs.

◆ SYSTEM_METADATA_RETENTION_PERIOD

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

◆ TCS_PER_TOM

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TCS_PER_TOM = "tcs_per_tom"

Sets the tcs_per_tom value of the conf.

The minimum allowed value is '2'. The maximum allowed value is '8192'.

Definition at line 262 of file AlterSystemProperties.cs.

◆ TELM_PERSIST_QUERY_METRICS

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TELM_PERSIST_QUERY_METRICS = "telm_persist_query_metrics"

Enable or disable persisting of query metrics.

Definition at line 298 of file AlterSystemProperties.cs.

◆ TPS_PER_TOM

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TPS_PER_TOM = "tps_per_tom"

Sets the tps_per_tom value of the conf.

The minimum allowed value is '2'. The maximum allowed value is '8192'.

Definition at line 267 of file AlterSystemProperties.cs.

◆ TRUE

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.TRUE = "true"

Definition at line 46 of file AlterSystemProperties.cs.

◆ UNCOMPRESSED

const string kinetica.AlterSystemPropertiesRequest.PropertyUpdatesMap.UNCOMPRESSED = "uncompressed"

Definition at line 236 of file AlterSystemProperties.cs.


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