com.gpudb.protocol

Class ShowTableRequest.Options

java.lang.Object

com.gpudb.protocol.ShowTableRequest.Options

Enclosing class:

ShowTableRequest

public static final class ShowTableRequest.Options
extends Object

Optional parameters.

• FORCE_SYNCHRONOUS: If true then the table sizes will wait for read lock before returning. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• GET_SIZES: If true then the table sizes will be returned; blank, otherwise. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• SHOW_CHILDREN: If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself.

  If tableName is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. Supported values:

  • TRUE
  • FALSE
  The default value is TRUE.
• NO_ERROR_IF_NOT_EXISTS: If false will return an error if the provided tableName does not exist. If true then it will return an empty result. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• GET_COLUMN_INFO: If true then column info (memory usage, etc) will be returned. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FALSE
static String	FORCE_SYNCHRONOUS If true then the table sizes will wait for read lock before returning.
static String	GET_COLUMN_INFO If true then column info (memory usage, etc) will be returned.
static String	GET_SIZES If true then the table sizes will be returned; blank, otherwise.
static String	NO_ERROR_IF_NOT_EXISTS If false will return an error if the provided tableName does not exist.
static String	SHOW_CHILDREN If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself.
static String	TRUE

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORCE_SYNCHRONOUS

public static final String FORCE_SYNCHRONOUS

If true then the table sizes will wait for read lock before returning. Supported values:

• TRUE
• FALSE

The default value is TRUE.

See Also:

Constant Field Values

TRUE

public static final String TRUE

See Also:

Constant Field Values

FALSE

public static final String FALSE

See Also:

Constant Field Values

GET_SIZES

public static final String GET_SIZES

If true then the table sizes will be returned; blank, otherwise. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

SHOW_CHILDREN

public static final String SHOW_CHILDREN

If tableName is a collection, then true will return information about the children of the collection, while false will return information about the collection itself.

If tableName is empty or '*', then show_children must be true (or not specified); otherwise, no results will be returned. Supported values:

• TRUE
• FALSE

The default value is TRUE.

See Also:

Constant Field Values

NO_ERROR_IF_NOT_EXISTS

public static final String NO_ERROR_IF_NOT_EXISTS

If false will return an error if the provided tableName does not exist. If true then it will return an empty result. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

GET_COLUMN_INFO

public static final String GET_COLUMN_INFO

If true then column info (memory usage, etc) will be returned. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values