Polyglot SQL API Documentation - v0.1.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 = {
        deferred_condition: boolean;
        join_hint?: string | null;
        kind: JoinKind;
        match_condition?: Expression | null;
        on: Expression | null;
        pivots?: Expression[];
        this: Expression;
        use_inner_keyword: boolean;
        use_outer_keyword: boolean;
        using: Identifier[];
    }
    Index

    Properties

    deferred_condition join_hint? kind match_condition? on pivots? this use_inner_keyword use_outer_keyword using

    Properties

    deferred_condition: boolean

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

    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)

    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