Kinetica   C#   API  Version 7.2.3.0
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  {
44  public const string CONCURRENT_KERNEL_EXECUTION = "concurrent_kernel_execution";
45 
46  public const string TRUE = "true";
47  public const string FALSE = "false";
48 
53  public const string SUBTASK_CONCURRENCY_LIMIT = "subtask_concurrency_limit";
54 
57  public const string CHUNK_SIZE = "chunk_size";
58 
61  public const string CHUNK_COLUMN_MAX_MEMORY = "chunk_column_max_memory";
62 
65  public const string CHUNK_MAX_MEMORY = "chunk_max_memory";
66 
74  public const string EVICT_COLUMNS = "evict_columns";
75 
81  public const string EXECUTION_MODE = "execution_mode";
82 
87  public const string EXTERNAL_FILES_DIRECTORY = "external_files_directory";
88 
95  public const string FLUSH_TO_DISK = "flush_to_disk";
96 
102  public const string CLEAR_CACHE = "clear_cache";
103 
113  public const string COMMUNICATOR_TEST = "communicator_test";
114 
126  public const string NETWORK_SPEED = "network_speed";
127 
136  public const string REQUEST_TIMEOUT = "request_timeout";
137 
143  public const string MAX_GET_RECORDS_SIZE = "max_get_records_size";
144 
146  public const string MAX_GRBC_BATCH_SIZE = "max_grbc_batch_size";
147 
149  public const string ENABLE_AUDIT = "enable_audit";
150 
153  public const string AUDIT_HEADERS = "audit_headers";
154 
157  public const string AUDIT_BODY = "audit_body";
158 
160  public const string AUDIT_DATA = "audit_data";
161 
164  public const string AUDIT_RESPONSE = "audit_response";
165 
171  public const string SHADOW_AGG_SIZE = "shadow_agg_size";
172 
178  public const string SHADOW_FILTER_SIZE = "shadow_filter_size";
179 
183  public const string SYNCHRONOUS_COMPRESSION = "synchronous_compression";
184 
187  public const string ENABLE_OVERLAPPED_EQUI_JOIN = "enable_overlapped_equi_join";
188 
192  public const string ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN = "enable_one_step_compound_equi_join";
193 
199  public const string KAFKA_BATCH_SIZE = "kafka_batch_size";
200 
206  public const string KAFKA_POLL_TIMEOUT = "kafka_poll_timeout";
207 
213  public const string KAFKA_WAIT_TIME = "kafka_wait_time";
214 
234  public const string EGRESS_PARQUET_COMPRESSION = "egress_parquet_compression";
235 
236  public const string UNCOMPRESSED = "uncompressed";
237  public const string SNAPPY = "snappy";
238  public const string GZIP = "gzip";
239 
245  public const string EGRESS_SINGLE_FILE_MAX_SIZE = "egress_single_file_max_size";
246 
251  public const string MAX_CONCURRENT_KERNELS = "max_concurrent_kernels";
252 
257  public const string SYSTEM_METADATA_RETENTION_PERIOD = "system_metadata_retention_period";
258 
262  public const string TCS_PER_TOM = "tcs_per_tom";
263 
267  public const string TPS_PER_TOM = "tps_per_tom";
268 
275  public const string BACKGROUND_WORKER_THREADS = "background_worker_threads";
276 
279  public const string AI_ENABLE_RAG = "ai_enable_rag";
280 
282  public const string AI_API_PROVIDER = "ai_api_provider";
283 
285  public const string AI_API_URL = "ai_api_url";
286 
288  public const string AI_API_KEY = "ai_api_key";
289 
291  public const string AI_API_CONNECTION_TIMEOUT = "ai_api_connection_timeout";
292 
294  public const string AI_API_EMBEDDINGS_MODEL = "ai_api_embeddings_model";
295 
298  public const string TELM_PERSIST_QUERY_METRICS = "telm_persist_query_metrics";
299 
301  public const string POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT = "postgres_proxy_idle_connection_timeout";
302 
305  public const string POSTGRES_PROXY_KEEP_ALIVE = "postgres_proxy_keep_alive";
306 
311  public const string KIFS_DIRECTORY_DATA_LIMIT = "kifs_directory_data_limit";
312  } // end struct PropertyUpdatesMap
313 
317  public struct Options
318  {
331  public const string EVICT_TO_COLD = "evict_to_cold";
332 
333  public const string TRUE = "true";
334  public const string FALSE = "false";
335 
350  public const string PERSIST = "persist";
351  } // end struct Options
352 
757  public IDictionary<string, string> property_updates_map { get; set; } = new Dictionary<string, string>();
758 
798  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
799 
803 
1250  public AlterSystemPropertiesRequest( IDictionary<string, string> property_updates_map,
1251  IDictionary<string, string> options = null)
1252  {
1253  this.property_updates_map = property_updates_map ?? new Dictionary<string, string>();
1254  this.options = options ?? new Dictionary<string, string>();
1255  } // end constructor
1256  } // end class AlterSystemPropertiesRequest
1257 
1262  {
1265  public IDictionary<string, string> updated_properties_map { get; set; } = new Dictionary<string, string>();
1266 
1268  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
1269  } // end class AlterSystemPropertiesResponse
1270 } // end namespace kinetica
const string EGRESS_SINGLE_FILE_MAX_SIZE
Max file size (in MB) to allow saving to a single file.
const string SUBTASK_CONCURRENCY_LIMIT
Sets the maximum number of simultaneous threads allocated to a given request, on each rank.
const string FLUSH_TO_DISK
Flushes any changes to any tables to the persistent store.
AlterSystemPropertiesRequest()
Constructs an AlterSystemPropertiesRequest object with default parameters.
const string KAFKA_WAIT_TIME
Maximum time (seconds) to buffer records received from kafka before ingestion.
A set of results returned by Kinetica.alterSystemProperties.
const string SHADOW_AGG_SIZE
Size of the shadow aggregate chunk cache in bytes.
const string AUDIT_RESPONSE
Enable or disable auditing of response information.
const string EVICT_TO_COLD
If TRUE and evict_columns is specified, the given objects will be evicted to cold storage (if such a ...
const string EXTERNAL_FILES_DIRECTORY
Sets the root directory path where external table data files are accessed from.
A set of string constants for the parameter options.
const string SYSTEM_METADATA_RETENTION_PERIOD
Sets the system_metadata.retention_period value of the conf.
const string POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT
Idle connection timeout in seconds
const string EVICT_COLUMNS
Attempts to evict columns from memory to the persistent store.
IDictionary< string, string > property_updates_map
Map containing the properties of the system to be updated.
const string EXECUTION_MODE
Sets the execution_mode for kernel executions to the specified string value.
const string COMMUNICATOR_TEST
Invoke the communicator test and report timing results.
const string MAX_GET_RECORDS_SIZE
The maximum number of records the database will serve for a given data retrieval call.
const string KAFKA_BATCH_SIZE
Maximum number of records to be ingested in a single batch.
const string EGRESS_PARQUET_COMPRESSION
Parquet file compression type.
const string ENABLE_ONE_STEP_COMPOUND_EQUI_JOIN
Enable the one_step compound-equi-join algorithm.
const string SHADOW_FILTER_SIZE
Size of the shadow filter chunk cache in bytes.
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 MAX_CONCURRENT_KERNELS
Sets the max_concurrent_kernels value of the conf.
IDictionary< string, string > updated_properties_map
Map of values updated; for speed tests, a map of values measured to the measurement
AlterSystemPropertiesRequest(IDictionary< string, string > property_updates_map, IDictionary< string, string > options=null)
Constructs an AlterSystemPropertiesRequest object with the specified parameters.
const string KIFS_DIRECTORY_DATA_LIMIT
The default maximum capacity to apply when creating a KiFS directory (bytes).
IDictionary< string, string > info
Additional information.
const string CONCURRENT_KERNEL_EXECUTION
Enables concurrent kernel execution if the value is TRUE and disables it if the value is FALSE.
const string AUDIT_HEADERS
Enable or disable auditing of request headers.
A set of string constants for the parameter property_updates_map.
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.
const string NETWORK_SPEED
Invoke the network speed test and report timing results.
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 TPS_PER_TOM
Sets the tps_per_tom value of the conf.
const string AUDIT_DATA
Enable or disable auditing of request data.
const string AI_API_CONNECTION_TIMEOUT
AI API connection timeout in seconds
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 TCS_PER_TOM
Sets the tcs_per_tom value of the conf.
const string CHUNK_SIZE
Sets the number of records per chunk to be used for all new tables.
const string POSTGRES_PROXY_KEEP_ALIVE
Enable postgres proxy keep alive.
const string PERSIST
If TRUE the system configuration will be written to disk upon successful application of this request.
IDictionary< string, string > options
Optional parameters.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string SYNCHRONOUS_COMPRESSION
compress vector on set_compression (instead of waiting for background thread).
const string TELM_PERSIST_QUERY_METRICS
Enable or disable persisting of query metrics.
const string ENABLE_OVERLAPPED_EQUI_JOIN
Enable overlapped-equi-join filter.