Polyglot SQL API Documentation - v0.2.0
    Preparing search index...

    Type Alias Join

    Represent a JOIN clause between two table sources.

    The join condition can be specified via on (ON predicate) or using (USING column list), but not both. The kind field determines the join type (INNER, LEFT, CROSS, etc.).

    type Join = {
        comments?: string[];
        deferred_condition: boolean;
        directed: boolean;
        join_hint?: string | null;
        kind: JoinKind;
        match_condition?: Expression | null;
        nesting_group: number;
        on: Expression | null;
        pivots?: Expression[];
        this: Expression;
        use_inner_keyword: boolean;
        use_outer_keyword: boolean;
        using: Identifier[];
    }
    Index

    Properties

    comments? deferred_condition directed join_hint? kind match_condition? nesting_group on pivots? this use_inner_keyword use_outer_keyword using

    Properties

    comments?: string[]

    Comments collected between join-kind keywords (for example INNER <comment> JOIN)

    deferred_condition: boolean

    Whether the ON/USING condition was deferred (assigned right-to-left for chained JOINs)

    directed: boolean

    Snowflake: DIRECTED keyword in JOIN (e.g., CROSS DIRECTED JOIN)

    join_hint?: string | null

    TSQL join hint: LOOP, HASH, MERGE (e.g., INNER LOOP JOIN)

    kind: JoinKind

    The join type (INNER, LEFT, RIGHT, FULL, CROSS, etc.).

    match_condition?: Expression | null

    Snowflake ASOF JOIN match condition (MATCH_CONDITION clause)

    nesting_group: number

    Nesting group identifier for nested join pretty-printing. Joins in the same group were parsed together; group boundaries come from deferred condition resolution phases.

    on: Expression | null

    The ON condition (mutually exclusive with using).

    pivots?: Expression[]

    PIVOT/UNPIVOT operations that follow this join (Oracle/TSQL syntax)

    this: Expression

    The right-hand table expression being joined.

    use_inner_keyword: boolean

    Whether INNER keyword was explicitly used (INNER JOIN vs JOIN)

    use_outer_keyword: boolean

    Whether OUTER keyword was explicitly used (LEFT OUTER JOIN vs LEFT JOIN)

    using: Identifier[]

    The USING column list (mutually exclusive with on).

    Settings

    Member Visibility

    On This Page

    Properties