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(AdminRemoveRanksRequest).

Remove one or more ranks from the cluster. All data in the ranks to be removed is rebalanced to other ranks before the node is removed unless the rebalance_sharded_data or rebalance_unsharded_data parameters are set to false in the options.

Due to the rebalancing, this endpoint may take a long time to run, depending on the amount of data in the system. The API call may time out if run directly. It is recommended to run this endpoint asynchronously via GPUdb.createJob(CreateJobRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdminRemoveRanksRequest.Options Optional parameters.

Constructor Summary

Constructors

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

Method Summary

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()
List<Integer>	getRanks()
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)
AdminRemoveRanksRequest	setRanks(List<Integer> ranks)
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<Integer> ranks,
                               Map<String,String> options)

Constructs an AdminRemoveRanksRequest object with the specified parameters.

Parameters:

ranks - Rank numbers of the ranks to be removed from the cluster.

options - Optional parameters.

• REBALANCE_SHARDED_DATA: When true, data with primary keys or shard keys will be rebalanced to other ranks prior to rank removal. Note that for big clusters, 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: When true, unsharded data (data without primary keys and without shard keys) will be rebalanced to other ranks prior to rank removal. Note that for big clusters, 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 to send per rebalance round, during the rebalance portion of removing ranks. A higher aggressiveness setting will complete the rebalance faster. A lower aggressiveness setting will take longer, but allow for better interleaving between the rebalance and other queries. Allowed values are 1 through 10. The default value is '1'.

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<Integer> getRanks()

Returns:

Rank numbers of the ranks to be removed from the cluster.

setRanks

public AdminRemoveRanksRequest setRanks(List<Integer> ranks)

Parameters:

ranks - Rank numbers of the ranks to be removed from the cluster.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• REBALANCE_SHARDED_DATA: When true, data with primary keys or shard keys will be rebalanced to other ranks prior to rank removal. Note that for big clusters, 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: When true, unsharded data (data without primary keys and without shard keys) will be rebalanced to other ranks prior to rank removal. Note that for big clusters, 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 to send per rebalance round, during the rebalance portion of removing ranks. A higher aggressiveness setting will complete the rebalance faster. A lower aggressiveness setting will take longer, but allow for better interleaving between the rebalance and other queries. Allowed values are 1 through 10. The default value is '1'.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• REBALANCE_SHARDED_DATA: When true, data with primary keys or shard keys will be rebalanced to other ranks prior to rank removal. Note that for big clusters, 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: When true, unsharded data (data without primary keys and without shard keys) will be rebalanced to other ranks prior to rank removal. Note that for big clusters, 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 to send per rebalance round, during the rebalance portion of removing ranks. A higher aggressiveness setting will complete the rebalance faster. A lower aggressiveness setting will take longer, but allow for better interleaving between the rebalance and other queries. Allowed values are 1 through 10. The default value is '1'.

The default value is an empty Map.

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