com.gpudb.protocol

Class GetRecordsByColumnRequest.Options

java.lang.Object

com.gpudb.protocol.GetRecordsByColumnRequest.Options

Enclosing class:

GetRecordsByColumnRequest

public static final class GetRecordsByColumnRequest.Options
extends Object

• EXPRESSION: Optional filter expression to apply to the table.
• SORT_BY: Optional column that the data should be sorted by. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ''.
• SORT_ORDER: String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:
  • ASCENDING
  • DESCENDING
  The default value is ASCENDING.
• ORDER_BY: Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.
• CONVERT_WKTS_TO_WKBS: If true, then WKT string columns will be returned as WKB bytes. 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	ASCENDING
static String	CONVERT_WKTS_TO_WKBS If true, then WKT string columns will be returned as WKB bytes.
static String	DESCENDING
static String	EXPRESSION Optional filter expression to apply to the table.
static String	FALSE
static String	ORDER_BY Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'.
static String	SORT_BY Optional column that the data should be sorted by.
static String	SORT_ORDER String indicating how the returned values should be sorted - ascending or descending.
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

EXPRESSION

public static final String EXPRESSION

Optional filter expression to apply to the table.

See Also:

Constant Field Values

SORT_BY

public static final String SORT_BY

Optional column that the data should be sorted by. Used in conjunction with sort_order. The order_by option can be used in lieu of sort_by / sort_order. The default value is ''.

See Also:

Constant Field Values

SORT_ORDER

public static final String SORT_ORDER

String indicating how the returned values should be sorted - ascending or descending. If sort_order is provided, sort_by has to be provided. Supported values:

• ASCENDING
• DESCENDING

The default value is ASCENDING.

See Also:

Constant Field Values

ASCENDING

public static final String ASCENDING

See Also:

Constant Field Values

DESCENDING

public static final String DESCENDING

See Also:

Constant Field Values

ORDER_BY

public static final String ORDER_BY

Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.

See Also:

Constant Field Values

CONVERT_WKTS_TO_WKBS

public static final String CONVERT_WKTS_TO_WKBS

If true, then WKT string columns will be returned as WKB bytes. Supported values:

• TRUE
• FALSE

The default value is FALSE.

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