nodejs-polars
    Preparing search index...

    Type Alias CommonJoinOptions

    Common join options shared by all join variants.

    type CommonJoinOptions = {
        buildSide?: JoinBuildSide;
        coalesce?: boolean;
        maintainOrder?: MaintainOrderJoin;
        nullsEqual?: boolean;
        suffix?: string;
        validate?: string;
    }
    Index
    buildSide? coalesce? maintainOrder? nullsEqual? suffix? validate?
    buildSide?: JoinBuildSide

    Which side to prefer/force as the build side of the join. One of {'auto', 'left', 'right', 'force_left', 'force_right'}. Default: 'auto'

    coalesce?: boolean

    Coalescing behavior (merging of join columns). Default: undefined

    • undefined - (Default) Coalesce unless how='full' is specified.
    • true - Always coalesce join columns.
    • false - Never coalesce join columns.
    maintainOrder?: MaintainOrderJoin

    Which frame's row order to preserve, if any. One of {'none', 'left', 'right', 'left_right', 'right_left'}. Default: 'none'

    nullsEqual?: boolean

    Join on null values. When false, null values will never produce matches. Default: false

    suffix?: string

    Suffix to append to columns with a duplicate name.

    validate?: string

    Checks if join is of specified type. Default: 'm:m' Valid options: {'m:m', 'm:1', '1:m', '1:1'}

    • m:m - (Default) Many-to-many. Does not result in checks.
    • 1:1 - One-to-one. Checks if join keys are unique in both left and right datasets.
    • 1:m - One-to-many. Checks if join keys are unique in left dataset.
    • m:1 - Many-to-one. Checks if join keys are unique in right dataset.

    Settings
    Member Visibility

    On This Page
    Properties