AlterSystemPropertiesRequest.PropertyUpdatesMap (Kinetica Java API 7.2.3.0 API)

java.lang.Object
- com.gpudb.protocol.AlterSystemPropertiesRequest.PropertyUpdatesMap

Enclosing class:

AlterSystemPropertiesRequest
```
public static final class AlterSystemPropertiesRequest.PropertyUpdatesMap
extends Object
```
A set of string constants for the AlterSystemPropertiesRequest parameter propertyUpdatesMap.
Map containing the properties of the system to be updated. Error if empty.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AI_API_CONNECTION_TIMEOUT` AI API connection timeout in seconds
`static String`	`AI_API_EMBEDDINGS_MODEL` AI API model name
`static String`	`AI_API_KEY` AI API key
`static String`	`AI_API_PROVIDER` AI API provider type
`static String`	`AI_API_URL` AI API URL
`static String`	`AI_ENABLE_RAG` Enable RAG.
`static String`	`AUDIT_BODY` Enable or disable auditing of request bodies.
`static String`	`AUDIT_DATA` Enable or disable auditing of request data.
`static String`	`AUDIT_HEADERS` Enable or disable auditing of request headers.
`static String`	`AUDIT_RESPONSE` Enable or disable auditing of response information.
`static String`	`BACKGROUND_WORKER_THREADS` Size of the worker rank background thread pool.
`static String`	`CHUNK_COLUMN_MAX_MEMORY` Sets the target maximum data size for each column in a chunk to be used for all new tables.
`static String`	`CHUNK_MAX_MEMORY` Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
`static String`	`CHUNK_SIZE` Sets the number of records per chunk to be used for all new tables.
`static String`	`CLEAR_CACHE` Clears cached results.
`static String`	`COMMUNICATOR_TEST` Invoke the communicator test and report timing results.
`static String`	`CONCURRENT_KERNEL_EXECUTION` Enables concurrent kernel execution if the value is `TRUE` and disables it if the value is `FALSE`.
`static String`	`EGRESS_PARQUET_COMPRESSION` Parquet file compression type.
`static String`	`EGRESS_SINGLE_FILE_MAX_SIZE` Max file size (in MB) to allow saving to a single file.
`static String`	`ENABLE_AUDIT` Enable or disable auditing.
`static String`	`ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN` Enable the one_step compound-equi-join algorithm.
`static String`	`ENABLE_OVERLAPPED_EQUI_JOIN` Enable overlapped-equi-join filter.
`static String`	`EVICT_COLUMNS` Attempts to evict columns from memory to the persistent store.
`static String`	`EXECUTION_MODE` Sets the execution_mode for kernel executions to the specified string value.
`static String`	`EXTERNAL_FILES_DIRECTORY` Sets the root directory path where external table data files are accessed from.
`static String`	`FALSE`
`static String`	`FLUSH_TO_DISK` Flushes any changes to any tables to the persistent store.
`static String`	`GZIP`
`static String`	`KAFKA_BATCH_SIZE` Maximum number of records to be ingested in a single batch.
`static String`	`KAFKA_POLL_TIMEOUT` Maximum time (milliseconds) for each poll to get records from kafka.
`static String`	`KAFKA_WAIT_TIME` Maximum time (seconds) to buffer records received from kafka before ingestion.
`static String`	`KIFS_DIRECTORY_DATA_LIMIT` The default maximum capacity to apply when creating a KiFS directory (bytes).
`static String`	`MAX_CONCURRENT_KERNELS` Sets the max_concurrent_kernels value of the conf.
`static String`	`MAX_GET_RECORDS_SIZE` The maximum number of records the database will serve for a given data retrieval call.
`static String`	`MAX_GRBC_BATCH_SIZE` <DEVELOPER>
`static String`	`NETWORK_SPEED` Invoke the network speed test and report timing results.
`static String`	`POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT` Idle connection timeout in seconds
`static String`	`POSTGRES_PROXY_KEEP_ALIVE` Enable postgres proxy keep alive.
`static String`	`REQUEST_TIMEOUT` Number of minutes after which filtering (e.g., `GPUdb.filter`) and aggregating (e.g., `GPUdb.aggregateGroupBy`) queries will timeout.
`static String`	`SHADOW_AGG_SIZE` Size of the shadow aggregate chunk cache in bytes.
`static String`	`SHADOW_FILTER_SIZE` Size of the shadow filter chunk cache in bytes.
`static String`	`SNAPPY`
`static String`	`SUBTASK_CONCURRENCY_LIMIT` Sets the maximum number of simultaneous threads allocated to a given request, on each rank.
`static String`	`SYNCHRONOUS_COMPRESSION` compress vector on set_compression (instead of waiting for background thread).
`static String`	`SYSTEM_METADATA_RETENTION_PERIOD` Sets the system_metadata.retention_period value of the conf.
`static String`	`TCS_PER_TOM` Sets the tcs_per_tom value of the conf.
`static String`	`TELM_PERSIST_QUERY_METRICS` Enable or disable persisting of query metrics.
`static String`	`TPS_PER_TOM` Sets the tps_per_tom value of the conf.
`static String`	`TRUE`
`static String`	`UNCOMPRESSED`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONCURRENT_KERNEL_EXECUTION
```
public static final String CONCURRENT_KERNEL_EXECUTION
```
    Enables concurrent kernel execution if the value is TRUE and disables it if the value is FALSE. Supported values:
    - TRUE
    - FALSE
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final String TRUE
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final String FALSE
```
    See Also:
    
    Constant Field Values
  - SUBTASK_CONCURRENCY_LIMIT
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - CHUNK_SIZE
```
public static final String CHUNK_SIZE
```
    Sets the number of records per chunk to be used for all new tables.
    
    See Also:
    
    Constant Field Values
  - CHUNK_COLUMN_MAX_MEMORY
```
public static final String CHUNK_COLUMN_MAX_MEMORY
```
    Sets the target maximum data size for each column in a chunk to be used for all new tables.
    
    See Also:
    
    Constant Field Values
  - CHUNK_MAX_MEMORY
```
public static final String CHUNK_MAX_MEMORY
```
    Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
    
    See Also:
    
    Constant Field Values
  - EVICT_COLUMNS
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - EXECUTION_MODE
```
public static final String 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
    
    See Also:
    
    Constant Field Values
  - EXTERNAL_FILES_DIRECTORY
```
public static final String EXTERNAL_FILES_DIRECTORY
```
    Sets the root directory path where external table data files are accessed from. Path must exist on the head node
    
    See Also:
    
    Constant Field Values
  - FLUSH_TO_DISK
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - CLEAR_CACHE
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - COMMUNICATOR_TEST
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - NETWORK_SPEED
```
public static final String 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.
    
    See Also:
    
    Constant Field Values
  - REQUEST_TIMEOUT
```
public static final String REQUEST_TIMEOUT
```
    Number of minutes after which filtering (e.g., GPUdb.filter) and aggregating (e.g., GPUdb.aggregateGroupBy) queries will timeout. The default value is '20'. The minimum allowed value is '0'. The maximum allowed value is '1440'.
    
    See Also:
    
    Constant Field Values
  - MAX_GET_RECORDS_SIZE
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - MAX_GRBC_BATCH_SIZE
```
public static final String MAX_GRBC_BATCH_SIZE
```
    <DEVELOPER>
    
    See Also:
    
    Constant Field Values
  - ENABLE_AUDIT
```
public static final String ENABLE_AUDIT
```
    Enable or disable auditing.
    
    See Also:
    
    Constant Field Values
  - AUDIT_HEADERS
```
public static final String AUDIT_HEADERS
```
    Enable or disable auditing of request headers.
    
    See Also:
    
    Constant Field Values
  - AUDIT_BODY
```
public static final String AUDIT_BODY
```
    Enable or disable auditing of request bodies.
    
    See Also:
    
    Constant Field Values
  - AUDIT_DATA
```
public static final String AUDIT_DATA
```
    Enable or disable auditing of request data.
    
    See Also:
    
    Constant Field Values
  - AUDIT_RESPONSE
```
public static final String AUDIT_RESPONSE
```
    Enable or disable auditing of response information.
    
    See Also:
    
    Constant Field Values
  - SHADOW_AGG_SIZE
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - SHADOW_FILTER_SIZE
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - SYNCHRONOUS_COMPRESSION
```
public static final String SYNCHRONOUS_COMPRESSION
```
    compress vector on set_compression (instead of waiting for background thread). The default value is 'false'.
    
    See Also:
    
    Constant Field Values
  - ENABLE_OVERLAPPED_EQUI_JOIN
```
public static final String ENABLE_OVERLAPPED_EQUI_JOIN
```
    Enable overlapped-equi-join filter. The default value is 'true'.
    
    See Also:
    
    Constant Field Values
  - ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
```
public static final String ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
```
    Enable the one_step compound-equi-join algorithm. The default value is 'true'.
    
    See Also:
    
    Constant Field Values
  - KAFKA_BATCH_SIZE
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - KAFKA_POLL_TIMEOUT
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - KAFKA_WAIT_TIME
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - EGRESS_PARQUET_COMPRESSION
```
public static final String EGRESS_PARQUET_COMPRESSION
```
    Parquet file compression type. Supported values:
    The default value is SNAPPY.
    See Also:
    
    Constant Field Values
  - UNCOMPRESSED
```
public static final String UNCOMPRESSED
```
    See Also:
    
    Constant Field Values
  - SNAPPY
```
public static final String SNAPPY
```
    See Also:
    
    Constant Field Values
  - GZIP
```
public static final String GZIP
```
    See Also:
    
    Constant Field Values
  - EGRESS_SINGLE_FILE_MAX_SIZE
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - MAX_CONCURRENT_KERNELS
```
public static final String MAX_CONCURRENT_KERNELS
```
    Sets the max_concurrent_kernels value of the conf. The minimum allowed value is '0'. The maximum allowed value is '256'.
    
    See Also:
    
    Constant Field Values
  - SYSTEM_METADATA_RETENTION_PERIOD
```
public static final String SYSTEM_METADATA_RETENTION_PERIOD
```
    Sets the system_metadata.retention_period value of the conf. The minimum allowed value is '1'.
    
    See Also:
    
    Constant Field Values
  - TCS_PER_TOM
```
public static final String TCS_PER_TOM
```
    Sets the tcs_per_tom value of the conf. The minimum allowed value is '2'. The maximum allowed value is '8192'.
    
    See Also:
    
    Constant Field Values
  - TPS_PER_TOM
```
public static final String TPS_PER_TOM
```
    Sets the tps_per_tom value of the conf. The minimum allowed value is '2'. The maximum allowed value is '8192'.
    
    See Also:
    
    Constant Field Values
  - BACKGROUND_WORKER_THREADS
```
public static final String 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'.
    
    See Also:
    
    Constant Field Values
  - AI_ENABLE_RAG
```
public static final String AI_ENABLE_RAG
```
    Enable RAG. The default value is 'false'.
    
    See Also:
    
    Constant Field Values
  - AI_API_PROVIDER
```
public static final String AI_API_PROVIDER
```
    AI API provider type
    
    See Also:
    
    Constant Field Values
  - AI_API_URL
```
public static final String AI_API_URL
```
    AI API URL
    
    See Also:
    
    Constant Field Values
  - AI_API_KEY
```
public static final String AI_API_KEY
```
    AI API key
    
    See Also:
    
    Constant Field Values
  - AI_API_CONNECTION_TIMEOUT
```
public static final String AI_API_CONNECTION_TIMEOUT
```
    AI API connection timeout in seconds
    
    See Also:
    
    Constant Field Values
  - AI_API_EMBEDDINGS_MODEL
```
public static final String AI_API_EMBEDDINGS_MODEL
```
    AI API model name
    
    See Also:
    
    Constant Field Values
  - TELM_PERSIST_QUERY_METRICS
```
public static final String TELM_PERSIST_QUERY_METRICS
```
    Enable or disable persisting of query metrics.
    
    See Also:
    
    Constant Field Values
  - POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
```
public static final String POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
```
    Idle connection timeout in seconds
    
    See Also:
    
    Constant Field Values
  - POSTGRES_PROXY_KEEP_ALIVE
```
public static final String POSTGRES_PROXY_KEEP_ALIVE
```
    Enable postgres proxy keep alive. The default value is 'false'.
    
    See Also:
    
    Constant Field Values
  - KIFS_DIRECTORY_DATA_LIMIT
```
public static final String KIFS_DIRECTORY_DATA_LIMIT
```
    The default maximum capacity to apply when creating a KiFS directory (bytes). The minimum allowed value is '-1'.
    
    See Also:
    
    Constant Field Values

Class AlterSystemPropertiesRequest.PropertyUpdatesMap

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONCURRENT_KERNEL_EXECUTION

TRUE

FALSE

SUBTASK_CONCURRENCY_LIMIT

CHUNK_SIZE

CHUNK_COLUMN_MAX_MEMORY

CHUNK_MAX_MEMORY

EVICT_COLUMNS

EXECUTION_MODE

EXTERNAL_FILES_DIRECTORY

FLUSH_TO_DISK

CLEAR_CACHE

COMMUNICATOR_TEST

NETWORK_SPEED

REQUEST_TIMEOUT

MAX_GET_RECORDS_SIZE

MAX_GRBC_BATCH_SIZE

ENABLE_AUDIT

AUDIT_HEADERS

AUDIT_BODY

AUDIT_DATA

AUDIT_RESPONSE

SHADOW_AGG_SIZE

SHADOW_FILTER_SIZE

SYNCHRONOUS_COMPRESSION

ENABLE_OVERLAPPED_EQUI_JOIN

ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN

KAFKA_BATCH_SIZE

KAFKA_POLL_TIMEOUT

KAFKA_WAIT_TIME

EGRESS_PARQUET_COMPRESSION

UNCOMPRESSED

SNAPPY

GZIP

EGRESS_SINGLE_FILE_MAX_SIZE

MAX_CONCURRENT_KERNELS

SYSTEM_METADATA_RETENTION_PERIOD

TCS_PER_TOM

TPS_PER_TOM

BACKGROUND_WORKER_THREADS

AI_ENABLE_RAG

AI_API_PROVIDER

AI_API_URL

AI_API_KEY

AI_API_CONNECTION_TIMEOUT

AI_API_EMBEDDINGS_MODEL

TELM_PERSIST_QUERY_METRICS

POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT

POSTGRES_PROXY_KEEP_ALIVE

KIFS_DIRECTORY_DATA_LIMIT