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.
array of strings
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.
array of strings
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 array ( [] ).
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter 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.The default value is false.The supported values are:
true
false
[DEPRECATED—please specify the containing schema for the join as part of input parameter join_table_name and use /create/schema 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 ”.
Sets the TTL of the join table specified in input parameter join_table_name.
View this projection is part of.The default value is ”.
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.
Maximum number of records per joined-chunk for this table. Defaults to the gpudb.conf file chunk size.
Collect chunks with accumulated size less than chunk_size into a single chunk.The default value is false.
Maximum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk_size if virtual chunking otherwise enabled.
Minimum number of records per virtual-chunk. When set, enables virtual chunking. Defaults to chunk_size if virtual chunking otherwise enabled.
Materialize virtual chunks with only non-deleted values.The default value is false.
Allow using the lazy result store to cache computation of one side of a multichunk equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
Allow using the lazy result store to cache computation of one side of a multichunk predicate-equi-join. Reduces computation but also reduces parallelism to the number of chunks on the other side of the equi-join.
Use equi-join to do primary key joins rather than using primary key index.
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘create_join_table_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /create/jointable endpoint:
Show data_str
string
Value of input parameter join_table_name.
long
The number of records in the join table filtered by the given select expression.
map of string to strings
Additional information.The default value is an empty map ( {} ).
Show info
The fully qualified name of the join table (i.e. including the schema).
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.