Kinetica C# API  Version 6.2.0.1
Classes | Public Member Functions | Properties | List of all members
kinetica.CreateJoinTableRequest Class Reference

A set of parameters for Kinetica.createJoinTable(string,IList<string>,IList<string>,IList<string>,IDictionary<string, string>). More...

+ Inheritance diagram for kinetica.CreateJoinTableRequest:
+ Collaboration diagram for kinetica.CreateJoinTableRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 CreateJoinTableRequest ()
 Constructs a CreateJoinTableRequest object with default parameters. More...
 
 CreateJoinTableRequest (string join_table_name, IList< string > table_names, IList< string > column_names, IList< string > expressions=null, IDictionary< string, string > options=null)
 Constructs a CreateJoinTableRequest object with the specified parameters. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

string join_table_name [get, set]
 Name of the join table to be created. More...
 
IList< string > table_names [get, set]
 The list of table names composing the join. More...
 
IList< string > column_names = new List<string>() [get, set]
 List of member table columns or column expressions to be included in the join. More...
 
IList< string > expressions = new List<string>() [get, set]
 An optional list of expressions to combine and filter the joined tables. More...
 
IDictionary< string, string > options = new List<string>() [get, set]
 Optional parameters. More...
 
- Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 

Additional Inherited Members

- Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema SchemaFromType (System.Type t, KineticaType ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType. More...
 

Detailed Description

A set of parameters for Kinetica.createJoinTable(string,IList<string>,IList<string>,IList<string>,IDictionary<string, string>).


Creates a table that is the result of a SQL JOIN.
For join details and examples see: Joins. For limitations, see Join Limitations and Cautions.

Definition at line 24 of file CreateJoinTable.cs.

Constructor & Destructor Documentation

◆ CreateJoinTableRequest() [1/2]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( )
inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 495 of file CreateJoinTable.cs.

◆ CreateJoinTableRequest() [2/2]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( string  join_table_name,
IList< string >  table_names,
IList< string >  column_names,
IList< string >  expressions = null,
IDictionary< string, string >  options = null 
)
inline

Constructs a CreateJoinTableRequest object with the specified parameters.

Parameters
join_table_nameName of the join table to be created. Has the same naming restrictions as tables.
table_namesThe list of table names composing the join. Corresponds to a SQL statement FROM clause.
column_namesList of member table columns or column expressions to be included in the join. Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions composing the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables.
expressionsAn optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty List.
optionsOptional 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: 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.

Definition at line 670 of file CreateJoinTable.cs.

Property Documentation

◆ column_names

IList<string> kinetica.CreateJoinTableRequest.column_names = new List<string>()
getset

List of member table columns or column expressions to be included in the join.

Columns can be prefixed with 'table_id.column_name', where 'table_id' is the table name or alias. Columns can be aliased via the syntax 'column_name as alias'. Wild cards '*' can be used to include all columns across member tables or 'table_id.*' for all of a single table's columns. Columns and column expressions composing the join must be uniquely named or aliased–therefore, the '*' wild card cannot be used if column names aren't unique across all tables.

Definition at line 333 of file CreateJoinTable.cs.

◆ expressions

IList<string> kinetica.CreateJoinTableRequest.expressions = new List<string>()
getset

An optional list of expressions to combine and filter the joined tables.

Corresponds to a SQL statement WHERE clause. For details see: expressions. The default value is an empty List.

Definition at line 340 of file CreateJoinTable.cs.

◆ join_table_name

string kinetica.CreateJoinTableRequest.join_table_name
getset

Name of the join table to be created.

Has the same naming restrictions as tables.

Definition at line 318 of file CreateJoinTable.cs.

◆ options

IDictionary<string, string> kinetica.CreateJoinTableRequest.options = new List<string>()
getset

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: 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.

Definition at line 490 of file CreateJoinTable.cs.

◆ table_names

IList<string> kinetica.CreateJoinTableRequest.table_names
getset

The list of table names composing the join.

Corresponds to a SQL statement FROM clause.

Definition at line 322 of file CreateJoinTable.cs.

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