Kinetica   C#   API  Version 7.2.3.1
AlterSystemProperties.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica;
10 
22 {
27  public struct PropertyUpdatesMap
28  {
43  public const string CONCURRENT_KERNEL_EXECUTION = "concurrent_kernel_execution";
44 
45  public const string TRUE = "true";
46  public const string FALSE = "false";
47 
52  public const string SUBTASK_CONCURRENCY_LIMIT = "subtask_concurrency_limit";
53 
56  public const string CHUNK_SIZE = "chunk_size";
57 
60  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
61 
64  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
65 
71  public const string EXECUTION_MODE = "execution_mode";
72 
76  public const string EXTERNAL_FILES_DIRECTORY = "external_files_directory";
77 
85  public const string REQUEST_TIMEOUT = "request_timeout";
86 
92  public const string MAX_GET_RECORDS_SIZE = "max_get_records_size";
93 
95  public const string ENABLE_AUDIT = "enable_audit";
96 
98  public const string AUDIT_HEADERS = "audit_headers";
99 
101  public const string AUDIT_BODY = "audit_body";
102 
104  public const string AUDIT_DATA = "audit_data";
105 
108  public const string AUDIT_RESPONSE = "audit_response";
109 
115  public const string SHADOW_AGG_SIZE = "shadow_agg_size";
116 
121  public const string SHADOW_FILTER_SIZE = "shadow_filter_size";
122 
125  public const string ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join";
126 
130  public const string ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN = "enable_one_step_compound_equi_join";
131 
137  public const string KAFKA_BATCH_SIZE = "kafka_batch_size";
138 
143  public const string KAFKA_POLL_TIMEOUT = "kafka_poll_timeout";
144 
149  public const string KAFKA_WAIT_TIME = "kafka_wait_time";
150 
169  public const string EGRESS_PARQUET_COMPRESSION = "egress_parquet_compression";
170 
171  public const string UNCOMPRESSED = "uncompressed";
172  public const string SNAPPY = "snappy";
173  public const string GZIP = "gzip";
174 
180  public const string EGRESS_SINGLE_FILE_MAX_SIZE = "egress_single_file_max_size";
181 
186  public const string MAX_CONCURRENT_KERNELS = "max_concurrent_kernels";
187 
191  public const string SYSTEM_METADATA_RETENTION_PERIOD = "system_metadata_retention_period";
192 
199  public const string TCS_PER_TOM = "tcs_per_tom";
200 
207  public const string TPS_PER_TOM = "tps_per_tom";
208 
213  public const string BACKGROUND_WORKER_THREADS = "background_worker_threads";
214 
218  public const string LOG_DEBUG_JOB_INFO = "log_debug_job_info";
219 
224  public const string ENABLE_THREAD_HANG_LOGGING = "enable_thread_hang_logging";
225 
228  public const string AI_ENABLE_RAG = "ai_enable_rag";
229 
231  public const string AI_API_PROVIDER = "ai_api_provider";
232 
234  public const string AI_API_URL = "ai_api_url";
235 
237  public const string AI_API_KEY = "ai_api_key";
238 
240  public const string AI_API_CONNECTION_TIMEOUT = "ai_api_connection_timeout";
241 
243  public const string AI_API_EMBEDDINGS_MODEL = "ai_api_embeddings_model";
244 
246  public const string TELM_PERSIST_QUERY_METRICS = "telm_persist_query_metrics";
247 
249  public const string POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = "postgres_proxy_idle_connection_timeout";
250 
253  public const string POSTGRES_PROXY_KEEP_ALIVE = "postgres_proxy_keep_alive";
254 
258  public const string KIFS_DIRECTORY_DATA_LIMIT = "kifs_directory_data_limit";
259 
265  public const string COMPRESSION_CODEC = "compression_codec";
266 
271  public const string DISK_AUTO_OPTIMIZE_TIMEOUT = "disk_auto_optimize_timeout";
272 
276  public const string HA_CONSUMER_REPLAY_OFFSET = "ha_consumer_replay_offset";
277 
280  public const string ADMIN_ACCESS_ONLY = "admin_access_only";
281  } // end struct PropertyUpdatesMap
282 
286  public struct Options
287  {
300  public const string EVICT_TO_COLD = "evict_to_cold";
301 
302  public const string TRUE = "true";
303  public const string FALSE = "false";
304 
319  public const string PERSIST = "persist";
320  } // end struct Options
321 
691  public IDictionary<string, string> property_updates_map { get; set; } = new Dictionary<string, string>();
692 
731  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
732 
736 
1147  public AlterSystemPropertiesRequest( IDictionary<string, string> property_updates_map,
1148  IDictionary<string, string> options = null)
1149  {
1150  this.property_updates_map = property_updates_map ?? new Dictionary<string, string>();
1151  this.options = options ?? new Dictionary<string, string>();
1152  } // end constructor
1153 } // end class AlterSystemPropertiesRequest
1154 
1159 {
1162  public IDictionary<string, string> updated_properties_map { get; set; } = new Dictionary<string, string>();
1163 
1165  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1166 } // end class AlterSystemPropertiesResponse
const string ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
Enable the one_step compound-equi-join algorithm.
const string AI_API_PROVIDER
AI API provider type.
const string 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
Indicates the target maximum data size for all columns in a chunk to be used for all new tables.
const string KAFKA_POLL_TIMEOUT
Maximum time (milliseconds) for each poll to get records from Kafka.
IDictionary< string, string > property_updates_map
Map containing the properties of the system to be updated.
const string EGRESS_SINGLE_FILE_MAX_SIZE
Max file size (in MB) to allow saving to a single file.
const string ADMIN_ACCESS_ONLY
Restricts access to system admin users only.
IDictionary< string, string > options
Optional parameters.
const string AUDIT_HEADERS
Enable or disable auditing of request headers.
const string TELM_PERSIST_QUERY_METRICS
Enable or disable persisting of query metrics.
const string ENABLE_THREAD_HANG_LOGGING
Log a stack trace for any thread that runs longer than a defined threshold.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string POSTGRES_PROXY_KEEP_ALIVE
Enable postgres proxy keep alive.
const string EVICT_TO_COLD
If TRUE and evict_columns is specified, the given objects will be evicted to cold storage (if such a ...
AlterSystemPropertiesRequest(IDictionary< string, string > property_updates_map, IDictionary< string, string > options=null)
Constructs an AlterSystemPropertiesRequest object with the specified parameters.
const string ENABLE_AUDIT
Enable or disable auditing.
const string HA_CONSUMER_REPLAY_OFFSET
Initializes HA replay from the given timestamp (as milliseconds since unix epoch).
const string SHADOW_FILTER_SIZE
Size of the shadow filter chunk cache in bytes.
const string KIFS_DIRECTORY_DATA_LIMIT
The default maximum capacity to apply when creating a KiFS directory (bytes).
const string AUDIT_DATA
Enable or disable auditing of request data.
const string EXTERNAL_FILES_DIRECTORY
Sets the root directory path where external table data files are accessed from.
const string EGRESS_PARQUET_COMPRESSION
Parquet file compression type.
const string BACKGROUND_WORKER_THREADS
Size of the worker rank background thread pool.
const string AUDIT_BODY
Enable or disable auditing of request bodies.
const string AI_API_EMBEDDINGS_MODEL
AI API model name.
const string SHADOW_AGG_SIZE
Size of the shadow aggregate chunk cache in bytes.
const string AI_API_CONNECTION_TIMEOUT
AI API connection timeout in seconds.
IDictionary< string, string > updated_properties_map
Map of values updated; for speed tests, a map of values measured to the measurement.
const string SUBTASK_CONCURRENCY_LIMIT
Sets the maximum number of simultaneous threads allocated to a given request, on each rank.
const string CONCURRENT_KERNEL_EXECUTION
Enables concurrent kernel execution if the value is TRUE and disables it if the value is FALSE.
const string POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
Idle connection timeout in seconds.
const string TCS_PER_TOM
Size of the worker rank data calculation thread pool.
AlterSystemPropertiesRequest()
Constructs an AlterSystemPropertiesRequest object with default parameters.
const string DISK_AUTO_OPTIMIZE_TIMEOUT
Time interval in seconds after which the database will apply optimizations/transformations to persist...
A set of string constants for the parameter property_updates_map.
const string KAFKA_WAIT_TIME
Maximum time (seconds) to buffer records received from Kafka before ingestion.
const string COMPRESSION_CODEC
The default compression algorithm applied to any column without a column-level or table-level default...
A set of results returned by Kinetica.alterSystemProperties.
const string SYSTEM_METADATA_RETENTION_PERIOD
Sets the system_metadata.retention_period value of the conf.
const string MAX_GET_RECORDS_SIZE
The maximum number of records the database will serve for a given data retrieval call.
const string ENABLE_OVERLAPPED_EQUI_JOIN
Enable overlapped-equi-join filter.
const string PERSIST
If TRUE the system configuration will be written to disk upon successful application of this request.
const string KAFKA_BATCH_SIZE
Maximum number of records to be ingested in a single batch.
const string LOG_DEBUG_JOB_INFO
Outputs various job-related information to the rank logs.
A set of parameters for Kinetica.alterSystemProperties.
const string REQUEST_TIMEOUT
Number of minutes after which filtering (e.g., Kinetica.filter) and aggregating (e....
const string MAX_CONCURRENT_KERNELS
Sets the max_concurrent_kernels value of the conf.
const string EXECUTION_MODE
Sets the execution_mode for kernel executions to the specified string value.
const string TPS_PER_TOM
Size of the worker rank data processing thread pool.
IDictionary< string, string > info
Additional information.
const string AUDIT_RESPONSE
Enable or disable auditing of response information.
const string CHUNK_SIZE
Sets the number of records per chunk to be used for all new tables.
A set of string constants for the parameter options.