Kinetica C# API  Version 6.2.0.1
kinetica.AlterSystemPropertiesRequest Class Reference

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  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

◆ AlterSystemPropertiesRequest() [1/2]

kinetica.AlterSystemPropertiesRequest.AlterSystemPropertiesRequest ( )
inline

Constructs an AlterSystemPropertiesRequest object with default parameters.

Definition at line 523 of file AlterSystemProperties.cs.

◆ AlterSystemPropertiesRequest() [2/2]

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_mapMap 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 against collections 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:
  • CHUNK_SIZE: Sets the chunk size of all new sets to the specified integer value.
  • 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
  • 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 ignored
  • COMMUNICATOR_TEST: Invoke the communicator test and report timing results. Value string is is a comma separated list of <key>=

    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 of the messages to send in bytes; check_values=<enabled> where if enabled is true the value of the messages received are verified.

  • SET_MESSAGE_TIMERS_ENABLED: Enables the communicator test to collect additional timing statistics when the value string is true. Disables the collection when the value string is false Supported values:
  • BULK_ADD_TEST: Invoke the bulk add test and report timing results. Value string is ignored.
  • NETWORK_SPEED: Invoke the network speed test and report timing results. Value string is a semicolon-separated list of <key>=

    expressions. Valid expressions are: seconds=<time> where time is the time in seconds to run the test; data_size=<size> where size 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'.
  • MEMORY_ALLOCATION_LIMIT_MB: Set the memory allocation limit for all rank processes in megabytes, 0 means no limit. Overrides any individual rank memory allocation limits. The default value is '0'.
  • 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.
  • ENABLE_JOB_MANAGER: Enable JobManager to enforce processing of requests in the order received.
  • CHUNK_CACHE_ENABLED: Enable chunk level query caching. Flushes the chunk cache when value is false
  • CHUNK_CACHE_SIZE: Size of the chunk cache in bytes. The default value is '10000000'.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 705 of file AlterSystemProperties.cs.

Property Documentation

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 518 of file AlterSystemProperties.cs.

◆ property_updates_map

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 against collections 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:
  • CHUNK_SIZE: Sets the chunk size of all new sets to the specified integer value.
  • 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
  • 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 ignored
  • COMMUNICATOR_TEST: Invoke the communicator test and report timing results. Value string is is a comma separated list of <key>=

    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 of the messages to send in bytes; check_values=<enabled> where if enabled is true the value of the messages received are verified.

  • SET_MESSAGE_TIMERS_ENABLED: Enables the communicator test to collect additional timing statistics when the value string is true. Disables the collection when the value string is false Supported values:
  • BULK_ADD_TEST: Invoke the bulk add test and report timing results. Value string is ignored.
  • NETWORK_SPEED: Invoke the network speed test and report timing results. Value string is a semicolon-separated list of <key>=

    expressions. Valid expressions are: seconds=<time> where time is the time in seconds to run the test; data_size=<size> where size 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'.
  • MEMORY_ALLOCATION_LIMIT_MB: Set the memory allocation limit for all rank processes in megabytes, 0 means no limit. Overrides any individual rank memory allocation limits. The default value is '0'.
  • 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.
  • ENABLE_JOB_MANAGER: Enable JobManager to enforce processing of requests in the order received.
  • CHUNK_CACHE_ENABLED: Enable chunk level query caching. Flushes the chunk cache when value is false
  • CHUNK_CACHE_SIZE: Size of the chunk cache in bytes. The default value is '10000000'.

Definition at line 514 of file AlterSystemProperties.cs.


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