Skip to main content

​
◆ alterSystemProperties() [1/2]

AlterSystemPropertiesResponse kinetica.Kinetica.alterSystemProperties (AlterSystemPropertiesRequestrequest_)
 inline

The alterSystemProperties endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

Commands are given through the property_updates_map whose keys are commands and values are strings representing integer values (for example ‘8000’) or boolean values (‘true’ or ‘false’).

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 11448 of file KineticaFunctions.cs.

​
◆ alterSystemProperties() [2/2]

AlterSystemPropertiesResponse kinetica.Kinetica.alterSystemProperties (IDictionary< string, string >property_updates_map,
IDictionary< string, string >options = null )
 inline

The alterSystemProperties endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

Commands are given through the property_updates_map whose keys are commands and values are strings representing integer values (for example ‘8000’) or boolean values (‘true’ or ‘false’).

Parameters
property_updates_mapMap containing the properties of the system to be updated. Error if empty.
  • CONCURRENT_KERNEL_EXECUTION: Enables concurrent kernel execution if the value is TRUE and disables it if the value is FALSE. Supported values:
  • 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.
  • CHUNK_SIZE: Sets the number of records per chunk to be used for all new tables.
  • CHUNK_COLUMN_MAX_MEMORY: Sets the target maximum data size for each column in a chunk to be used for all new tables.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
  • 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.
  • EXTERNAL_FILES_DIRECTORY: Sets the root directory path where external table data files are accessed from. Path must exist on the head node.
  • REQUEST_TIMEOUT: Number of minutes after which filtering (e.g., filter) and aggregating (e.g., aggregateGroupBy) queries will timeout. The default value is ‘20’. The minimum allowed value is ‘0’. The maximum allowed value is ‘1440’.
  • 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’.
  • ENABLE_AUDIT: Enable or disable auditing.
  • AUDIT_HEADERS: Enable or disable auditing of request headers.
  • AUDIT_BODY: Enable or disable auditing of request bodies.
  • AUDIT_DATA: Enable or disable auditing of request data.
  • AUDIT_RESPONSE: Enable or disable auditing of response information.
  • 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’.
  • 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’.
  • ENABLE_OVERLAPPED_EQUI_JOIN: Enable overlapped-equi-join filter. The default value is ‘true’.
  • ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN: Enable the one_step compound-equi-join algorithm. The default value is ‘true’.
  • 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’.
  • 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’.
  • 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’.
  • DATALAKE_TABLE_METADATA_CACHE_ENABLED: Enable caching of datalake table metadata.
  • DATALAKE_TABLE_METADATA_CACHE_SIZE: Maximum number of datalake table metadata entries to cache.
  • DATALAKE_TABLE_METADATA_CACHE_TTL: Time-to-live (seconds) for cached datalake table metadata entries.
  • DATALAKE_TABLE_METADATA_CACHE_SNAPSHOT_CHECK: When enabled, check the current datalake snapshot on cache hits and invalidate entries that have changed.
  • DATALAKE_CATALOG_CONNECTION_CACHE_SIZE: Maximum number of cached datalake REST catalog connections.
  • ICEBERG_MANIFEST_CACHE_ENABLED: Enable caching of parsed Iceberg manifest and manifest-list files.
  • EGRESS_PARQUET_COMPRESSION: Parquet file compression type. Supported values:The default value is SNAPPY.
  • 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’.
  • MAX_CONCURRENT_KERNELS: Sets the max_concurrent_kernels value of the conf. The minimum allowed value is ‘0’. The maximum allowed value is ‘256’.
  • SYSTEM_METADATA_RETENTION_PERIOD: Sets the system_metadata.retention_period value of the conf. The minimum allowed value is ‘1’.
  • 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’.
  • 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’.
  • REMOTE_IO_THREADS: 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.
  • 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’.
  • LOG_DEBUG_JOB_INFO: Outputs various job-related information to the rank logs. Used for troubleshooting.
  • 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’.
  • AI_ENABLE_RAG: Enable RAG. The default value is ‘false’.
  • AI_API_PROVIDER: AI API provider type.
  • AI_API_URL: AI API URL.
  • AI_API_KEY: AI API key.
  • AI_API_CONNECTION_TIMEOUT: AI API connection timeout in seconds.
  • AI_API_EMBEDDINGS_MODEL: AI API model name.
  • TELM_PERSIST_QUERY_METRICS: Enable or disable persisting of query metrics.
  • TELM_FORCE_METRICS_DURATION: Capture metrics for any query exceeding this duration in seconds.
  • POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT: Idle connection timeout in seconds.
  • POSTGRES_PROXY_KEEP_ALIVE: Enable postgres proxy keep alive. The default value is ‘false’.
  • KIFS_DIRECTORY_DATA_LIMIT: The default maximum capacity to apply when creating a KiFS directory (bytes). The minimum allowed value is ‘-1’.
  • 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.
  • 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’.
  • HA_CONSUMER_REPLAY_OFFSET: Initializes HA replay from the given timestamp (as milliseconds since unix epoch). The minimum allowed value is ‘-1’.
  • ADMIN_ACCESS_ONLY: Restricts access to system admin users only. The default value is ‘false’.
optionsOptional parameters.
  • EVICT_TO_COLD: If TRUE and evict_columns is specified, the given objects will be evicted to cold storage (if such a tier exists). Supported values:
  • PERSIST: 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. Supported values:The default value is TRUE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 11981 of file KineticaFunctions.cs.

​
◆ AlterSystemPropertiesAsync() [1/2]

async System.Threading.Tasks.Task< AlterSystemPropertiesResponse > kinetica.Kinetica.AlterSystemPropertiesAsync (AlterSystemPropertiesRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

The alterSystemProperties endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

(async)

Commands are given through the property_updates_map whose keys are commands and values are strings representing integer values (for example ‘8000’) or boolean values (‘true’ or ‘false’).

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 11471 of file KineticaFunctions.cs.

​
◆ AlterSystemPropertiesAsync() [2/2]

async System.Threading.Tasks.Task< AlterSystemPropertiesResponse > kinetica.Kinetica.AlterSystemPropertiesAsync (IDictionary< string, string >property_updates_map,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

The alterSystemProperties endpoint is primarily used to simplify the testing of the system and is not expected to be used during normal execution.

(async)

Commands are given through the property_updates_map whose keys are commands and values are strings representing integer values (for example ‘8000’) or boolean values (‘true’ or ‘false’).

Parameters
property_updates_mapMap containing the properties of the system to be updated. Error if empty.
  • CONCURRENT_KERNEL_EXECUTION: Enables concurrent kernel execution if the value is TRUE and disables it if the value is FALSE. Supported values:
  • 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.
  • CHUNK_SIZE: Sets the number of records per chunk to be used for all new tables.
  • CHUNK_COLUMN_MAX_MEMORY: Sets the target maximum data size for each column in a chunk to be used for all new tables.
  • CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
  • 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.
  • EXTERNAL_FILES_DIRECTORY: Sets the root directory path where external table data files are accessed from. Path must exist on the head node.
  • REQUEST_TIMEOUT: Number of minutes after which filtering (e.g., filter) and aggregating (e.g., aggregateGroupBy) queries will timeout. The default value is ‘20’. The minimum allowed value is ‘0’. The maximum allowed value is ‘1440’.
  • 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’.
  • ENABLE_AUDIT: Enable or disable auditing.
  • AUDIT_HEADERS: Enable or disable auditing of request headers.
  • AUDIT_BODY: Enable or disable auditing of request bodies.
  • AUDIT_DATA: Enable or disable auditing of request data.
  • AUDIT_RESPONSE: Enable or disable auditing of response information.
  • 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’.
  • 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’.
  • ENABLE_OVERLAPPED_EQUI_JOIN: Enable overlapped-equi-join filter. The default value is ‘true’.
  • ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN: Enable the one_step compound-equi-join algorithm. The default value is ‘true’.
  • 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’.
  • 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’.
  • 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’.
  • DATALAKE_TABLE_METADATA_CACHE_ENABLED: Enable caching of datalake table metadata.
  • DATALAKE_TABLE_METADATA_CACHE_SIZE: Maximum number of datalake table metadata entries to cache.
  • DATALAKE_TABLE_METADATA_CACHE_TTL: Time-to-live (seconds) for cached datalake table metadata entries.
  • DATALAKE_TABLE_METADATA_CACHE_SNAPSHOT_CHECK: When enabled, check the current datalake snapshot on cache hits and invalidate entries that have changed.
  • DATALAKE_CATALOG_CONNECTION_CACHE_SIZE: Maximum number of cached datalake REST catalog connections.
  • ICEBERG_MANIFEST_CACHE_ENABLED: Enable caching of parsed Iceberg manifest and manifest-list files.
  • EGRESS_PARQUET_COMPRESSION: Parquet file compression type. Supported values:The default value is SNAPPY.
  • 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’.
  • MAX_CONCURRENT_KERNELS: Sets the max_concurrent_kernels value of the conf. The minimum allowed value is ‘0’. The maximum allowed value is ‘256’.
  • SYSTEM_METADATA_RETENTION_PERIOD: Sets the system_metadata.retention_period value of the conf. The minimum allowed value is ‘1’.
  • 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’.
  • 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’.
  • REMOTE_IO_THREADS: 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.
  • 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’.
  • LOG_DEBUG_JOB_INFO: Outputs various job-related information to the rank logs. Used for troubleshooting.
  • 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’.
  • AI_ENABLE_RAG: Enable RAG. The default value is ‘false’.
  • AI_API_PROVIDER: AI API provider type.
  • AI_API_URL: AI API URL.
  • AI_API_KEY: AI API key.
  • AI_API_CONNECTION_TIMEOUT: AI API connection timeout in seconds.
  • AI_API_EMBEDDINGS_MODEL: AI API model name.
  • TELM_PERSIST_QUERY_METRICS: Enable or disable persisting of query metrics.
  • TELM_FORCE_METRICS_DURATION: Capture metrics for any query exceeding this duration in seconds.
  • POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT: Idle connection timeout in seconds.
  • POSTGRES_PROXY_KEEP_ALIVE: Enable postgres proxy keep alive. The default value is ‘false’.
  • KIFS_DIRECTORY_DATA_LIMIT: The default maximum capacity to apply when creating a KiFS directory (bytes). The minimum allowed value is ‘-1’.
  • 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.
  • 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’.
  • HA_CONSUMER_REPLAY_OFFSET: Initializes HA replay from the given timestamp (as milliseconds since unix epoch). The minimum allowed value is ‘-1’.
  • ADMIN_ACCESS_ONLY: Restricts access to system admin users only. The default value is ‘false’.
optionsOptional parameters.
  • EVICT_TO_COLD: If TRUE and evict_columns is specified, the given objects will be evicted to cold storage (if such a tier exists). Supported values:
  • PERSIST: 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. Supported values:The default value is TRUE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 12492 of file KineticaFunctions.cs.