Skip to main content
interface CreateJoinTableRequest
column_names: string[];
expressions?: string[];
join_table_name: string;
options?: Record<string, string>;
table_names: string[];
column_names: string[]

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.

expressions?: string[]

An optional list of expressions to combine and filter the joined tables. Corresponds to a SQL statement WHERE clause. For details see: expressions.

join_table_name: string

Name of the join table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.

options?: Record<string, string>

Optional parameters.

table_names: string[]

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.