A set of parameters for Kinetica.alterSystemProperties(IDictionary{string, string},IDictionary{string, string}). More...

Inheritance diagram for kinetica.AlterSystemPropertiesRequest:

Collaboration diagram for kinetica.AlterSystemPropertiesRequest:

Classes
struct	Options
	Optional parameters. More...

struct	PropertyUpdatesMap
	Map containing the properties of the system to be updated. More...

Public Member Functions
	AlterSystemPropertiesRequest ()
	Constructs an AlterSystemPropertiesRequest object with default parameters. More...

	AlterSystemPropertiesRequest (IDictionary< string, string > property_updates_map, IDictionary< string, string > options=null)
	Constructs an AlterSystemPropertiesRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
IDictionary< string, string >	property_updates_map `[get, set]`
	Map containing the properties of the system to be updated. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.alterSystemProperties(IDictionary{string, string},IDictionary{string, string}).

The Kinetica.alterSystemProperties(IDictionary{string, string},IDictionary{string, string}) 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').

Definition at line 25 of file AlterSystemProperties.cs.

Constructor & Destructor Documentation

kinetica.AlterSystemPropertiesRequest.AlterSystemPropertiesRequest ( )

inline

Constructs an AlterSystemPropertiesRequest object with default parameters.

Definition at line 954 of file AlterSystemProperties.cs.

kinetica.AlterSystemPropertiesRequest.AlterSystemPropertiesRequest	(	IDictionary< string, string >	property_updates_map,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an AlterSystemPropertiesRequest object with the specified parameters.

Parameters

property_updates_map

Map containing the properties of the system to be updated. Error if empty.

SM_OMP_THREADS: Set the number of OpenMP threads that will be used to service filter & aggregation requests to the specified integer value.
KERNEL_OMP_THREADS: Set the number of kernel OpenMP threads to the specified integer value.
CONCURRENT_KERNEL_EXECUTION: Enables concurrent kernel execution if the value is true and disables it if the value is false. Supported values:
- TRUE
- FALSE
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.
CHUNK_SIZE: Sets the number of records per chunk to be used for all new tables.
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.
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
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 is ignored
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.
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.
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.
REQUEST_TIMEOUT: Number of minutes after which filtering (e.g., /filter) and aggregating (e.g., /aggregate/groupby) queries will timeout. The default value is '20'.
MAX_GET_RECORDS_SIZE: The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'.
MAX_GRBC_BATCH_SIZE: <DEVELOPER>
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'.
SHADOW_FILTER_SIZE: Size of the shadow filter chunk cache in bytes. The default value is '10000000'.
SYNCHRONOUS_COMPRESSION: compress vector on set_compression (instead of waiting for background thread). The default value is 'false'.
ENABLE_OVERLAPPED_EQUI_JOIN: Enable overlapped-equi-join filter. The default value is 'true'.
KAFKA_BATCH_SIZE: Maximum number of records to be ingested in a single batch. The default value is '1000'.
KAFKA_POLL_TIMEOUT: Maximum time (milliseconds) for each poll to get records from kafka. The default value is '0'.
KAFKA_WAIT_TIME: Maximum time (seconds) to buffer records received from kafka before ingestion. The default value is '30'.
EGRESS_PARQUET_COMPRESSION: Parquet file compression type Supported values:
- UNCOMPRESSED
- SNAPPY
- GZIP
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'.
MAX_CONCURRENT_KERNELS: Sets the max_concurrent_kernels value of the conf.
TCS_PER_TOM: Sets the tcs_per_tom value of the conf.
TPS_PER_TOM: Sets the tps_per_tom value of the conf.
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
POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT: Idle connection timeout in seconds
POSTGRES_PROXY_KEEP_ALIVE: Enable postgres proxy keep alive. The default value is 'false'.

options

Optional 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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
The default value is TRUE.

The default value is an empty Dictionary.

Definition at line 1290 of file AlterSystemProperties.cs.

Property Documentation

IDictionary<string, string> kinetica.AlterSystemPropertiesRequest.options = new Dictionary<string, string>()

getset

Optional 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:
- TRUE
- FALSE
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:
- TRUE
- FALSE
The default value is TRUE.

The default value is an empty Dictionary.

Definition at line 949 of file AlterSystemProperties.cs.

IDictionary<string, string> kinetica.AlterSystemPropertiesRequest.property_updates_map

getset

Map containing the properties of the system to be updated.

Error if empty.

SM_OMP_THREADS: Set the number of OpenMP threads that will be used to service filter & aggregation requests to the specified integer value.
KERNEL_OMP_THREADS: Set the number of kernel OpenMP threads to the specified integer value.
CONCURRENT_KERNEL_EXECUTION: Enables concurrent kernel execution if the value is true and disables it if the value is false. Supported values:
- TRUE
- FALSE
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.
CHUNK_SIZE: Sets the number of records per chunk to be used for all new tables.
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.
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
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 is ignored
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.
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.
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.
REQUEST_TIMEOUT: Number of minutes after which filtering (e.g., /filter) and aggregating (e.g., /aggregate/groupby) queries will timeout. The default value is '20'.
MAX_GET_RECORDS_SIZE: The maximum number of records the database will serve for a given data retrieval call. The default value is '20000'.
MAX_GRBC_BATCH_SIZE: <DEVELOPER>
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'.
SHADOW_FILTER_SIZE: Size of the shadow filter chunk cache in bytes. The default value is '10000000'.
SYNCHRONOUS_COMPRESSION: compress vector on set_compression (instead of waiting for background thread). The default value is 'false'.
ENABLE_OVERLAPPED_EQUI_JOIN: Enable overlapped-equi-join filter. The default value is 'true'.
KAFKA_BATCH_SIZE: Maximum number of records to be ingested in a single batch. The default value is '1000'.
KAFKA_POLL_TIMEOUT: Maximum time (milliseconds) for each poll to get records from kafka. The default value is '0'.
KAFKA_WAIT_TIME: Maximum time (seconds) to buffer records received from kafka before ingestion. The default value is '30'.
EGRESS_PARQUET_COMPRESSION: Parquet file compression type Supported values:
- UNCOMPRESSED
- SNAPPY
- GZIP
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'.
MAX_CONCURRENT_KERNELS: Sets the max_concurrent_kernels value of the conf.
TCS_PER_TOM: Sets the tcs_per_tom value of the conf.
TPS_PER_TOM: Sets the tps_per_tom value of the conf.
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
POSTGRES_PROXY_IDLE_CONNECTION_TIMEOUT: Idle connection timeout in seconds
POSTGRES_PROXY_KEEP_ALIVE: Enable postgres proxy keep alive. The default value is 'false'.

Definition at line 904 of file AlterSystemProperties.cs.

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

Kinetica/Protocol/AlterSystemProperties.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation