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

A set of parameters for Kinetica.createJoinTable. More...

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

Classes

struct  Options
 A set of string constants for the parameter options. 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, in [schema_name. More...
 
IList< string > table_names = new List<string>() [get, set]
 The list of table names composing the join, each in [schema_name. 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 Dictionary<string, 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.

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

Constructor & Destructor Documentation

◆ CreateJoinTableRequest() [1/2]

kinetica.CreateJoinTableRequest.CreateJoinTableRequest ( )
inline

Constructs a CreateJoinTableRequest object with default parameters.

Definition at line 266 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, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
table_namesThe list of table names composing the join, each in [schema_name.]table_name format, using standard name resolution rules. 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.
  • CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of join_table_name . This is always allowed even if the caller does not have permission to create tables. The generated name is returned in QUALIFIED_JOIN_TABLE_NAME. Supported values: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the join as part of join_table_name and use Kinetica.createSchema to create the schema if non-existent] Name of a schema for the join. If the schema is non-existent, it will be automatically created. The default value is ''.
  • MAX_QUERY_DIMENSIONS: No longer used.
  • OPTIMIZE_LOOKUPS: Use more memory to speed up the joining of tables. Supported values: The default value is FALSE.
  • STRATEGY_DEFINITION: The tier strategy for the table and its columns.
  • TTL: Sets the TTL of the join table specified in join_table_name .
  • 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 Kinetica.showTable; optimization needed for large overlapped equi-join stencils. The default value is 'false'.
  • CHUNK_SIZE: Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size
  • ENABLE_VIRTUAL_CHUNKING: Collect chunks with accumulated size less than chunk_size into a single chunk. The default value is 'false'.
  • ENABLE_PK_EQUI_JOIN: Use equi-join to do primary key joins rather than using primary-key-index
The default value is an empty Dictionary.

Definition at line 411 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 138 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 146 of file CreateJoinTable.cs.

◆ join_table_name

string kinetica.CreateJoinTableRequest.join_table_name
getset

Name of the join table to be created, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria.

Definition at line 118 of file CreateJoinTable.cs.

◆ options

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 262 of file CreateJoinTable.cs.

◆ table_names

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

The list of table names composing the join, each in [schema_name.

]table_name format, using standard name resolution rules.

Corresponds to a SQL statement FROM clause.

Definition at line 126 of file CreateJoinTable.cs.

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