Package com.gpudb.protocol

Class AdminRemoveRanksRequest

java.lang.Object

com.gpudb.protocol.AdminRemoveRanksRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.adminRemoveRanks.

Remove one or more ranks from an existing Kinetica cluster. All data will be rebalanced to other ranks before the rank(s) is removed unless the REBALANCE_SHARDED_DATA or REBALANCE_UNSHARDED_DATA parameters are set to FALSE in the options, in which case the corresponding sharded data and/or unsharded data (a.k.a. randomly-sharded) will be deleted.

The database must be offline for this operation, see GPUdb.adminOffline

This endpoint's processing time depends on the amount of data in the system, thus the API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb.createJob.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdminRemoveRanksRequest.Options	A set of string constants for the AdminRemoveRanksRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
AdminRemoveRanksRequest()	Constructs an AdminRemoveRanksRequest object with default parameters.
AdminRemoveRanksRequest(List<String> ranks, Map<String,String> options)	Constructs an AdminRemoveRanksRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	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()	Optional parameters.
List<String>	getRanks()	Each array value designates one or more ranks to remove from the cluster.
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.
AdminRemoveRanksRequest	setOptions(Map<String,String> options)	Optional parameters.
AdminRemoveRanksRequest	setRanks(List<String> ranks)	Each array value designates one or more ranks to remove from the cluster.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminRemoveRanksRequest

public AdminRemoveRanksRequest()

Constructs an AdminRemoveRanksRequest object with default parameters.

AdminRemoveRanksRequest

public AdminRemoveRanksRequest(List<String> ranks,
                               Map<String,String> options)

Constructs an AdminRemoveRanksRequest object with the specified parameters.

Parameters:

ranks - Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using GPUdb.adminSwitchover). At least one worker rank must be left in the cluster after the operation.

options - Optional parameters.

• REBALANCE_SHARDED_DATA: If TRUE, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• REBALANCE_UNSHARDED_DATA: If TRUE, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• AGGRESSIVENESS: Influences how much data is moved at a time during rebalance. A higher AGGRESSIVENESS will complete the rebalance faster. A lower AGGRESSIVENESS will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.

The default value is an empty Map.

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.

getRanks

public List<String> getRanks()

Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using GPUdb.adminSwitchover). At least one worker rank must be left in the cluster after the operation.

Returns:

The current value of ranks.

setRanks

public AdminRemoveRanksRequest setRanks(List<String> ranks)

Each array value designates one or more ranks to remove from the cluster. Values can be formatted as 'rankN' for a specific rank, 'hostN' (from the gpudb.conf file) to remove all ranks on that host, or the host IP address (hostN.address from the gpub.conf file) which also removes all ranks on that host. Rank 0 (the head rank) cannot be removed (but can be moved to another host using GPUdb.adminSwitchover). At least one worker rank must be left in the cluster after the operation.

Parameters:

ranks - The new value for ranks.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• REBALANCE_SHARDED_DATA: If TRUE, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• REBALANCE_UNSHARDED_DATA: If TRUE, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• AGGRESSIVENESS: Influences how much data is moved at a time during rebalance. A higher AGGRESSIVENESS will complete the rebalance faster. A lower AGGRESSIVENESS will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters.

• REBALANCE_SHARDED_DATA: If TRUE, sharded data will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of sharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• REBALANCE_UNSHARDED_DATA: If TRUE, unsharded data (a.k.a. randomly-sharded) will be rebalanced approximately equally across the cluster. Note that for clusters with large amounts of unsharded data, this data transfer could be time consuming and result in delayed query responses. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• AGGRESSIVENESS: Influences how much data is moved at a time during rebalance. A higher AGGRESSIVENESS will complete the rebalance faster. A lower AGGRESSIVENESS will take longer but allow for better interleaving between the rebalance and other queries. Valid values are constants from 1 (lowest) to 10 (highest). The default value is '10'.

The default value is an empty Map.

Parameters:

options - The new value for options.

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