com.gpudb.protocol

Class AdminVerifyDbRequest

java.lang.Object

com.gpudb.protocol.AdminVerifyDbRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.adminVerifyDb.

Verify database is in a consistent state. When inconsistencies or errors are found, the verified_ok flag in the response is set to false and the list of errors found is provided in the error_list.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
AdminVerifyDbRequest() Constructs an AdminVerifyDbRequest object with default parameters.
AdminVerifyDbRequest(Map<String,String> options) Constructs an AdminVerifyDbRequest 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() Optional parameters.
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.
AdminVerifyDbRequest	setOptions(Map<String,String> options) Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminVerifyDbRequest

public AdminVerifyDbRequest()

Constructs an AdminVerifyDbRequest object with default parameters.

AdminVerifyDbRequest

public AdminVerifyDbRequest(Map<String,String> options)

Constructs an AdminVerifyDbRequest object with the specified parameters.

Parameters:

options - Optional parameters.

• REBUILD_ON_ERROR: [DEPRECATED -- Use the Rebuild DB feature of GAdmin instead.]. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_NULLS: When TRUE, verifies that null values are set to zero. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_PERSIST: When TRUE, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set CONCURRENT_SAFE in options to TRUE or place the database offline. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CONCURRENT_SAFE: When TRUE, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• VERIFY_RANK0: If TRUE, compare rank0 table metadata against workers' metadata. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DELETE_ORPHANED_TABLES: If TRUE, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set CONCURRENT_SAFE in options to TRUE. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_ORPHANED_TABLES_ONLY: If TRUE, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TABLE_INCLUDES: Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_EXCLUDES.
• TABLE_EXCLUDES: Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_INCLUDES.

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.

getOptions

public Map<String,String> getOptions()

Optional parameters.

• REBUILD_ON_ERROR: [DEPRECATED -- Use the Rebuild DB feature of GAdmin instead.]. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_NULLS: When TRUE, verifies that null values are set to zero. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_PERSIST: When TRUE, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set CONCURRENT_SAFE in options to TRUE or place the database offline. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CONCURRENT_SAFE: When TRUE, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• VERIFY_RANK0: If TRUE, compare rank0 table metadata against workers' metadata. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DELETE_ORPHANED_TABLES: If TRUE, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set CONCURRENT_SAFE in options to TRUE. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_ORPHANED_TABLES_ONLY: If TRUE, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TABLE_INCLUDES: Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_EXCLUDES.
• TABLE_EXCLUDES: Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_INCLUDES.

The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters.

• REBUILD_ON_ERROR: [DEPRECATED -- Use the Rebuild DB feature of GAdmin instead.]. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_NULLS: When TRUE, verifies that null values are set to zero. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_PERSIST: When TRUE, persistent objects will be compared against their state in memory and workers will be checked for orphaned table data in persist. To check for orphaned worker data, either set CONCURRENT_SAFE in options to TRUE or place the database offline. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CONCURRENT_SAFE: When TRUE, allows this endpoint to be run safely with other concurrent database operations. Other operations may be slower while this is running. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• VERIFY_RANK0: If TRUE, compare rank0 table metadata against workers' metadata. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• DELETE_ORPHANED_TABLES: If TRUE, orphaned table directories found on workers for which there is no corresponding metadata will be deleted. It is recommended to run this while the database is offline OR set CONCURRENT_SAFE in options to TRUE. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VERIFY_ORPHANED_TABLES_ONLY: If TRUE, only the presence of orphaned table directories will be checked, all persistence and table consistency checks will be skipped. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• TABLE_INCLUDES: Comma-separated list of table names to include when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_EXCLUDES.
• TABLE_EXCLUDES: Comma-separated list of table names to exclude when verifying table consistency on wokers. Cannot be used simultaneously with TABLE_INCLUDES.

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