​

Field Details

• ​

  CREATE_TEMP_TABLE

  public static final String CREATE_TEMP_TABLE

  If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of RESULT_TABLE. If RESULT_TABLE_PERSIST is FALSE (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_RESULT_TABLE_NAME. 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

• ​

  COLLECTION_NAME

  public static final String COLLECTION_NAME

  [DEPRECATED—please specify the containing schema as part of RESULT_TABLE and use GPUdb.createSchema to create the schema if non-existent] Name of a schema which is to contain the table specified in RESULT_TABLE. If the schema provided is non-existent, it will be automatically created.

  See Also:

  • Constant Field Values

• ​

  EXPRESSION

  public static final String EXPRESSION

  Filter expression to apply to the table.

  See Also:

  • Constant Field Values

• ​

  SORT_ORDER

  public static final String SORT_ORDER

  String indicating how the returned values should be sorted. 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

• ​

  RESULT_TABLE

  public static final String RESULT_TABLE

  The name of the table used to store the results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If present, no results are returned in the response. Not available if columnName is an unrestricted-length string.

  See Also:

  • Constant Field Values

• ​

  RESULT_TABLE_PERSIST

  public static final String RESULT_TABLE_PERSIST

  If TRUE, then the result table specified in RESULT_TABLE will be persisted and will not expire unless a TTL is specified. If FALSE, then the result table will be an in-memory table and will expire unless a TTL is specified otherwise. Supported values:

  • TRUE
  • FALSE

  The default value is FALSE.

  See Also:

  • Constant Field Values

• ​

  RESULT_TABLE_FORCE_REPLICATED

  public static final String RESULT_TABLE_FORCE_REPLICATED

  Force the result table to be replicated (ignores any sharding). Must be used in combination with the RESULT_TABLE option. Supported values:

  • TRUE
  • FALSE

  The default value is FALSE.

  See Also:

  • Constant Field Values

• ​

  RESULT_TABLE_GENERATE_PK

  public static final String RESULT_TABLE_GENERATE_PK

  If TRUE then set a primary key for the result table. Must be used in combination with the RESULT_TABLE option. Supported values:

  • TRUE
  • FALSE

  The default value is FALSE.

  See Also:

  • Constant Field Values

• ​

  TTL

  public static final String TTL

  Sets the TTL of the table specified in RESULT_TABLE.

  See Also:

  • Constant Field Values

• ​

  CHUNK_SIZE

  public static final String CHUNK_SIZE

  Indicates the number of records per chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.

  See Also:

  • Constant Field Values

• ​

  CHUNK_COLUMN_MAX_MEMORY

  public static final String CHUNK_COLUMN_MAX_MEMORY

  Indicates the target maximum data size for each column in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.

  See Also:

  • Constant Field Values

• ​

  CHUNK_MAX_MEMORY

  public static final String CHUNK_MAX_MEMORY

  Indicates the target maximum data size for all columns in a chunk to be used for the result table. Must be used in combination with the RESULT_TABLE option.

  See Also:

  • Constant Field Values

• ​

  COMPRESSION_CODEC

  public static final String COMPRESSION_CODEC

  The default compression codec for the result table’s columns.

  See Also:

  • Constant Field Values

• ​

  VIEW_ID

  public static final String VIEW_ID

  ID of view of which the result table will be a member. The default value is ”.

  See Also:

  • Constant Field Values