Optional parameters. More...

Public Attributes
const string	COLLECTION_NAME = "collection_name"
	Name of a collection which is to contain the join. More...

const string	MAX_QUERY_DIMENSIONS = "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 More...

const string	OPTIMIZE_LOOKUPS = "optimize_lookups"
	Use more memory to speed up the joining of tables. More...

const string	TRUE = "true"

const string	FALSE = "false"

const string	REFRESH_METHOD = "refresh_method"
	Method by which the join can be refreshed when the data in underlying member tables have changed. More...

const string	MANUAL = "manual"
	refresh only occurs when manually requested by calling this endpoint with refresh option set to refresh or full_refresh More...

const string	ON_QUERY = "on_query"
	incrementally refresh (refresh just those records added) whenever a new query is issued and new data is inserted into the base table. More...

const string	ON_INSERT = "on_insert"
	incrementally refresh (refresh just those records added) whenever new data is inserted into a base table. More...

const string	REFRESH = "refresh"
	incrementally refresh (refresh just those records added) if new data has been inserted into the base table. More...

const string	NO_REFRESH = "no_refresh"
	don't refresh More...

const string	FULL_REFRESH = "full_refresh"
	always refresh even if no new records have been added. More...

const string	TTL = "ttl"
	Sets the TTL of the join table specified in join_table_name. More...

const string	VIEW_ID = "view_id"
	view this projection is part of. More...

const string	NO_COUNT = "no_count"
	return a count of 0 for the join table for logging and for show_table. More...

const string	CHUNK_SIZE = "chunk_size"
	Maximum size of a joined-chunk for this table. More...

const string	ALLOW_RIGHT_PRIMARY_KEY_JOIN = "allow_right_primary_key_join"
	When true allows right joins from a key to a primary key to be done as primary key joins. More...

Detailed Description

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. The default value is ''.
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. TTL will be set to not expire; any ttl specified will be ignored.
- 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. TTL will be set to not expire; any ttl specified will be ignored.
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 join table specified in . Ignored if refresh_method is either on_insert or on_query.
VIEW_ID: view this projection is part of. The default value is ''.
NO_COUNT: return a count of 0 for the join table for logging and for show_table. optimization needed for large overlapped equi-join stencils. The default value is 'false'.
CHUNK_SIZE: Maximum size of a joined-chunk for this table. Defaults to the gpudb.conf file chunk size
ALLOW_RIGHT_PRIMARY_KEY_JOIN: When true allows right joins from a key to a primary key to be done as primary key joins. Such a join table cannot be joined to other join tables. When false the right join shall be done as an equi-join. The default value is 'false'.

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

Definition at line 177 of file CreateJoinTable.cs.

Member Data Documentation

◆ ALLOW_RIGHT_PRIMARY_KEY_JOIN

const string kinetica.CreateJoinTableRequest.Options.ALLOW_RIGHT_PRIMARY_KEY_JOIN = "allow_right_primary_key_join"

When true allows right joins from a key to a primary key to be done as primary key joins.

Such a join table cannot be joined to other join tables. When false the right join shall be done as an equi-join. The default value is 'false'.

Definition at line 311 of file CreateJoinTable.cs.

◆ CHUNK_SIZE

const string kinetica.CreateJoinTableRequest.Options.CHUNK_SIZE = "chunk_size"

Maximum size of a joined-chunk for this table.

Defaults to the gpudb.conf file chunk size

Definition at line 304 of file CreateJoinTable.cs.

◆ COLLECTION_NAME

const string kinetica.CreateJoinTableRequest.Options.COLLECTION_NAME = "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. The default value is ''.

Definition at line 184 of file CreateJoinTable.cs.

◆ FALSE

const string kinetica.CreateJoinTableRequest.Options.FALSE = "false"

Definition at line 207 of file CreateJoinTable.cs.

◆ FULL_REFRESH

const string kinetica.CreateJoinTableRequest.Options.FULL_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.

Definition at line 285 of file CreateJoinTable.cs.

◆ MANUAL

const string kinetica.CreateJoinTableRequest.Options.MANUAL = "manual"

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

Definition at line 251 of file CreateJoinTable.cs.

◆ MAX_QUERY_DIMENSIONS

const string kinetica.CreateJoinTableRequest.Options.MAX_QUERY_DIMENSIONS = "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

Definition at line 189 of file CreateJoinTable.cs.

◆ NO_COUNT

const string kinetica.CreateJoinTableRequest.Options.NO_COUNT = "no_count"

return a count of 0 for the join table for logging and for show_table.

optimization needed for large overlapped equi-join stencils. The default value is 'false'.

Definition at line 300 of file CreateJoinTable.cs.

◆ NO_REFRESH

const string kinetica.CreateJoinTableRequest.Options.NO_REFRESH = "no_refresh"

don't refresh

Definition at line 279 of file CreateJoinTable.cs.

◆ ON_INSERT

const string kinetica.CreateJoinTableRequest.Options.ON_INSERT = "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. TTL will be set to not expire; any ttl specified will be ignored.

Definition at line 270 of file CreateJoinTable.cs.

◆ ON_QUERY

const string kinetica.CreateJoinTableRequest.Options.ON_QUERY = "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. TTL will be set to not expire; any ttl specified will be ignored.

Definition at line 261 of file CreateJoinTable.cs.

◆ OPTIMIZE_LOOKUPS

const string kinetica.CreateJoinTableRequest.Options.OPTIMIZE_LOOKUPS = "optimize_lookups"

Use more memory to speed up the joining of tables.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 205 of file CreateJoinTable.cs.

◆ REFRESH

const string kinetica.CreateJoinTableRequest.Options.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

Definition at line 276 of file CreateJoinTable.cs.

◆ REFRESH_METHOD

const string kinetica.CreateJoinTableRequest.Options.REFRESH_METHOD = "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. TTL will be set to not expire; any ttl specified will be ignored.
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. TTL will be set to not expire; any ttl specified will be ignored.

The default value is MANUAL.

Definition at line 246 of file CreateJoinTable.cs.

◆ TRUE

const string kinetica.CreateJoinTableRequest.Options.TRUE = "true"

Definition at line 206 of file CreateJoinTable.cs.

◆ TTL

const string kinetica.CreateJoinTableRequest.Options.TTL = "ttl"

Sets the TTL of the join table specified in join_table_name.

Ignored if refresh_method is either on_insert or on_query.

Definition at line 291 of file CreateJoinTable.cs.

◆ VIEW_ID

const string kinetica.CreateJoinTableRequest.Options.VIEW_ID = "view_id"

view this projection is part of.

The default value is ''.

Definition at line 295 of file CreateJoinTable.cs.

The documentation for this struct was generated from the following file:

Kinetica/Protocol/CreateJoinTable.cs

Public Attributes