ShowTableRequest.Options (Kinetica Java API 7.1.10.4 API)

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 number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- GET_CACHED_SIZES: If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occuring. Supported values:
  - TRUE
  - FALSE
  The default value is FALSE.
- SHOW_CHILDREN: If tableName is a schema, then true will return information about the tables and views in the schema, and false will return information about the schema itself. If tableName is a table or view, show_children must be false. If tableName is empty, then show_children must be true. 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_CACHED_SIZES` If `true` then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise.
`static String`	`GET_COLUMN_INFO` If `true` then column info (memory usage, etc) will be returned.
`static String`	`GET_SIZES` If `true` then the number of records in each table, along with a cumulative count, 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 schema, then `true` will return information about the tables and views in the schema, and `false` will return information about the schema 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 number of records in each table, along with a cumulative count, will be returned; blank, otherwise. Supported values:
    - TRUE
    - FALSE
    The default value is FALSE.
    See Also:
    
    Constant Field Values
  - GET_CACHED_SIZES
```
public static final String GET_CACHED_SIZES
```
    If true then the number of records in each table, along with a cumulative count, will be returned; blank, otherwise. This version will return the sizes cached at rank 0, which may be stale if there is a multihead insert occuring. 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 schema, then true will return information about the tables and views in the schema, and false will return information about the schema itself. If tableName is a table or view, show_children must be false. If tableName is empty, then show_children must be true. 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

Class ShowTableRequest.Options

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORCE_SYNCHRONOUS

TRUE

FALSE

GET_SIZES

GET_CACHED_SIZES

SHOW_CHILDREN

NO_ERROR_IF_NOT_EXISTS

GET_COLUMN_INFO