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 table specified in <member name="join_table_name">. 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.
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. Values: true, false.
refresh_method Method by which the join can be refreshed when the data in underlying member tables have changed. Values: manual, on_query, on_insert.
refresh Do a manual refresh of the join if it exists - throws an error otherwise Values: no_refresh, refresh, full_refresh.
ttl Sets the TTL of the table specified in . The value must be the desired TTL in minutes.

A set of string constants for the parameter <member name="options">.

Definition at line 67 of file CreateJoinTable.cs.

Member Data Documentation

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.

Definition at line 74 of file CreateJoinTable.cs.

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

Definition at line 86 of file CreateJoinTable.cs.

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 126 of file CreateJoinTable.cs.

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 97 of file CreateJoinTable.cs.

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 79 of file CreateJoinTable.cs.

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

don't refresh

Definition at line 120 of file CreateJoinTable.cs.

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

Definition at line 111 of file CreateJoinTable.cs.

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

Definition at line 104 of file CreateJoinTable.cs.

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

Use more memory to speed up the joining of tables.

Values: true, false.

Definition at line 84 of file CreateJoinTable.cs.

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 117 of file CreateJoinTable.cs.

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.

Values: manual, on_query, on_insert.

Definition at line 92 of file CreateJoinTable.cs.

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

Definition at line 85 of file CreateJoinTable.cs.

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

Sets the TTL of the table specified in <member name="join_table_name">.

The value must be the desired TTL in minutes.

Definition at line 131 of file CreateJoinTable.cs.

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

Kinetica/Protocol/CreateJoinTable.cs

Public Attributes

Detailed Description

Member Data Documentation