com.gpudb.protocol

Class AlterSystemPropertiesRequest

java.lang.Object

com.gpudb.protocol.AlterSystemPropertiesRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class AlterSystemPropertiesRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.alterSystemProperties(AlterSystemPropertiesRequest).

The GPUdb.alterSystemProperties(AlterSystemPropertiesRequest) 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 propertyUpdatesMap whose keys are commands and values are strings representing integer values (for example '8000') or boolean values ('true' or 'false').

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlterSystemPropertiesRequest.PropertyUpdatesMap Map containing the properties of the system to be updated.

Constructor Summary

Constructors

Constructor and Description
AlterSystemPropertiesRequest() Constructs an AlterSystemPropertiesRequest object with default parameters.
AlterSystemPropertiesRequest(Map<String,String> propertyUpdatesMap, Map<String,String> options) Constructs an AlterSystemPropertiesRequest object with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()
Map<String,String>	getPropertyUpdatesMap()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
AlterSystemPropertiesRequest	setOptions(Map<String,String> options)
AlterSystemPropertiesRequest	setPropertyUpdatesMap(Map<String,String> propertyUpdatesMap)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AlterSystemPropertiesRequest

public AlterSystemPropertiesRequest()

Constructs an AlterSystemPropertiesRequest object with default parameters.

AlterSystemPropertiesRequest

public AlterSystemPropertiesRequest(Map<String,String> propertyUpdatesMap,
                            Map<String,String> options)

Constructs an AlterSystemPropertiesRequest object with the specified parameters.

Parameters:

propertyUpdatesMap - 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:
  • TRUE
  • FALSE
• 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 = expressions. Expressions are: num_transactions= where num is the number of request reply transactions to invoke per test; message_size= where bytes is the size of the messages to send in bytes; check_values= 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:
  • 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 = expressions. Valid expressions are: seconds= where time is the time in seconds to run the test; data_size= where size is the size in bytes of the block to be transferred; threads=; to_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., GPUdb.filter(FilterRequest)) and aggregating (e.g., GPUdb.aggregateGroupByRaw(AggregateGroupByRequest)) queries will timeout.
• MAX_GET_RECORDS_SIZE: The maximum number of records the database will serve for a given data retrieval call
• 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.
• 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.

options - Optional parameters.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getPropertyUpdatesMap

public Map<String,String> getPropertyUpdatesMap()

Returns:

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:
  • TRUE
  • FALSE
• 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 = expressions. Expressions are: num_transactions= where num is the number of request reply transactions to invoke per test; message_size= where bytes is the size of the messages to send in bytes; check_values= 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:
  • 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 = expressions. Valid expressions are: seconds= where time is the time in seconds to run the test; data_size= where size is the size in bytes of the block to be transferred; threads=; to_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., GPUdb.filter(FilterRequest)) and aggregating (e.g., GPUdb.aggregateGroupByRaw(AggregateGroupByRequest)) queries will timeout.
• MAX_GET_RECORDS_SIZE: The maximum number of records the database will serve for a given data retrieval call
• 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.
• 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.

setPropertyUpdatesMap

public AlterSystemPropertiesRequest setPropertyUpdatesMap(Map<String,String> propertyUpdatesMap)

Parameters:

propertyUpdatesMap - 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:
  • TRUE
  • FALSE
• 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 = expressions. Expressions are: num_transactions= where num is the number of request reply transactions to invoke per test; message_size= where bytes is the size of the messages to send in bytes; check_values= 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:
  • 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 = expressions. Valid expressions are: seconds= where time is the time in seconds to run the test; data_size= where size is the size in bytes of the block to be transferred; threads=; to_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., GPUdb.filter(FilterRequest)) and aggregating (e.g., GPUdb.aggregateGroupByRaw(AggregateGroupByRequest)) queries will timeout.
• MAX_GET_RECORDS_SIZE: The maximum number of records the database will serve for a given data retrieval call
• 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.
• 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.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

setOptions

public AlterSystemPropertiesRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
       Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object