com.gpudb.protocol

Class CreateJoinTableRequest.Options

java.lang.Object

com.gpudb.protocol.CreateJoinTableRequest.Options

Enclosing class:

CreateJoinTableRequest

public static final class CreateJoinTableRequest.Options
extends Object

Optional parameters.

• COLLECTION_NAME: Name of a collection which is to contain the join. If the collection provided is non-existent, the collection will be automatically created. If empty, then the join will be at the top level.
• MAX_QUERY_DIMENSIONS: The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
• OPTIMIZE_LOOKUPS: Use more memory to speed up the joining of tables. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
  • MANUAL: refresh only occurs when manually requested by calling this endpoint with refresh option set to refresh or full_refresh
  • ON_QUERY: incrementally refresh (refresh just those records added) whenever a new query is issued and new data is inserted into the base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query
  • ON_INSERT: incrementally refresh (refresh just those records added) whenever new data is inserted into a base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query
  The default value is MANUAL.
• REFRESH: Do a manual refresh of the join if it exists - throws an error otherwise Supported values:
  • NO_REFRESH: don't refresh
  • REFRESH: incrementally refresh (refresh just those records added) if new data has been inserted into the base table. A full refresh of all the records occurs if there have been inserts to any non-base-tables since the last refresh
  • FULL_REFRESH: always refresh even if no new records have been added. Only refresh method guaranteed to do a full refresh (refresh all the records) if a delete or update has occurred since the last refresh.
  The default value is NO_REFRESH.
• TTL: Sets the TTL of the table specified in joinTableName. The value must be the desired TTL in minutes.

A set of string constants for the parameter options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLECTION_NAME Name of a collection which is to contain the join.
static String	FALSE
static String	FULL_REFRESH always refresh even if no new records have been added.
static String	MANUAL refresh only occurs when manually requested by calling this endpoint with refresh option set to refresh or full_refresh
static String	MAX_QUERY_DIMENSIONS The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate
static String	NO_REFRESH don't refresh
static String	ON_INSERT incrementally refresh (refresh just those records added) whenever new data is inserted into a base table.
static String	ON_QUERY incrementally refresh (refresh just those records added) whenever a new query is issued and new data is inserted into the base table.
static String	OPTIMIZE_LOOKUPS Use more memory to speed up the joining of tables.
static String	REFRESH incrementally refresh (refresh just those records added) if new data has been inserted into the base table.
static String	REFRESH_METHOD Method by which the join can be refreshed when the data in underlying member tables have changed.
static String	TRUE
static String	TTL Sets the TTL of the table specified in joinTableName.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_NAME

public static final String COLLECTION_NAME

Name of a collection which is to contain the join. If the collection provided is non-existent, the collection will be automatically created. If empty, then the join will be at the top level.

See Also:

Constant Field Values

MAX_QUERY_DIMENSIONS

public static final String MAX_QUERY_DIMENSIONS

The maximum number of tables in a join that can be accessed by a query and are not equated by a foreign-key to primary-key equality predicate

See Also:

Constant Field Values

OPTIMIZE_LOOKUPS

public static final String OPTIMIZE_LOOKUPS

Use more memory to speed up the joining of tables. 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

REFRESH_METHOD

public static final String REFRESH_METHOD

Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:

• MANUAL: refresh only occurs when manually requested by calling this endpoint with refresh option set to refresh or full_refresh
• ON_QUERY: incrementally refresh (refresh just those records added) whenever a new query is issued and new data is inserted into the base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query
• ON_INSERT: incrementally refresh (refresh just those records added) whenever new data is inserted into a base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query

The default value is MANUAL.

See Also:

Constant Field Values

MANUAL

public static final String MANUAL

refresh only occurs when manually requested by calling this endpoint with refresh option set to refresh or full_refresh

See Also:

Constant Field Values

ON_QUERY

public static final String ON_QUERY

incrementally refresh (refresh just those records added) whenever a new query is issued and new data is inserted into the base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query

See Also:

Constant Field Values

ON_INSERT

public static final String ON_INSERT

incrementally refresh (refresh just those records added) whenever new data is inserted into a base table. A full refresh of all the records occurs when a new query is issued and there have been inserts to any non-base-tables since the last query

See Also:

Constant Field Values

REFRESH

public static final String REFRESH

incrementally refresh (refresh just those records added) if new data has been inserted into the base table. A full refresh of all the records occurs if there have been inserts to any non-base-tables since the last refresh

See Also:

Constant Field Values

NO_REFRESH

public static final String NO_REFRESH

don't refresh

See Also:

Constant Field Values

FULL_REFRESH

public static final String FULL_REFRESH

always refresh even if no new records have been added. Only refresh method guaranteed to do a full refresh (refresh all the records) if a delete or update has occurred since the last refresh.

See Also:

Constant Field Values

TTL

public static final String TTL

Sets the TTL of the table specified in joinTableName. The value must be the desired TTL in minutes.

See Also:

Constant Field Values