A set of parameters for /alter/system/properties. 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 /alter/system/properties.

The /alter/system/properties 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 <member name="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 22 of file AlterSystemProperties.cs.

Constructor & Destructor Documentation

kinetica.AlterSystemPropertiesRequest.AlterSystemPropertiesRequest ( )

inline

Constructs an AlterSystemPropertiesRequest object with default parameters.

Definition at line 285 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 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. Values: true, false.
chunk_size Sets the chunk size of all new sets to the specified integer value.
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 Values: true, false.
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.
max_get_records_size The maximum number of records the database will serve for a given data retrieval call

options Optional parameters.

Definition at line 378 of file AlterSystemProperties.cs.

Property Documentation

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

getset

Optional parameters.

Definition at line 280 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 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. Values: true, false.
chunk_size Sets the chunk size of all new sets to the specified integer value.
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 Values: true, false.
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.
max_get_records_size The maximum number of records the database will serve for a given data retrieval call

Definition at line 277 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