Function concat

  • concat(items: pl.DataFrame<any>[], options?: ConcatOptions): pl.DataFrame

    Aggregate all the Dataframes/Series in a List of DataFrames/Series to a single DataFrame/Series.

    Parameters

    • items: pl.DataFrame<any>[]

      DataFrames/Series/LazyFrames to concatenate.

    • Optionaloptions: ConcatOptions

      Options for concat

      • Optionalhow?: "vertical" | "horizontal" | "diagonal"
      • Optionalrechunk?: boolean

    Returns pl.DataFrame

    Example

    > const df1 = pl.DataFrame({"a": [1], "b": [3]});
    > const df2 = pl.DataFrame({"a": [2], "b": [4]});
    > pl.concat([df1, df2]);
    shape: (2, 2)
    ┌─────┬─────┐
    │ a   ┆ b   │
    │ --- ┆ --- │
    │ i64 ┆ i64 │
    ╞═════╪═════╡
    │ 1   ┆ 3   │
    ├╌╌╌╌╌┼╌╌╌╌╌┤
    │ 2   ┆ 4   │
    └─────┴─────┘

    > const a = pl.DataFrame({ a: ["a", "b"], b: [1, 2] });
    > const b = pl.DataFrame({ c: [5, 6], d: [7, 8], e: [9, 10]});
    > pl.concat([a, b], { how: "horizontal" });

    shape: (2, 5)
    ┌─────┬─────┬─────┬─────┬──────┐
    │ a   ┆ b   ┆ c   ┆ d   ┆ e    │
    │ --- ┆ --- ┆ --- ┆ --- ┆ ---  │
    │ str ┆ f64 ┆ f64 ┆ f64 ┆ f64  │
    ╞═════╪═════╪═════╪═════╪══════╡
    │ a   ┆ 1.0 ┆ 5.0 ┆ 7.0 ┆ 9.0  │
    │ b   ┆ 2.0 ┆ 6.0 ┆ 8.0 ┆ 10.0 │
    └─────┴─────┴─────┴─────┴──────┘

    > const df_d1 = pl.DataFrame({"a": [1], "b": [3]});
    > const df_d2 = pl.DataFrame({"a": [2], "c": [4]});
    > pl.concat([df_d1, df_d2], { how: "diagonal" });

    shape: (2, 3)
    ┌─────┬──────┬──────┐
    │ a   ┆ b    ┆ c    │
    │ --- ┆ ---  ┆ ---  │
    │ i64 ┆ i64  ┆ i64  │
    ╞═════╪══════╪══════╡
    │ 1   ┆ 3    ┆ null │
    │ 2   ┆ null ┆ 4    │
    └─────┴──────┴──────┘
  • concat(
        items: pl.Series<any, string>[],
        options?: { rechunk: boolean },
    ): pl.Series

    Aggregate all the Dataframes/Series in a List of DataFrames/Series to a single DataFrame/Series.

    Parameters

    • items: pl.Series<any, string>[]

      DataFrames/Series/LazyFrames to concatenate.

    • Optionaloptions: { rechunk: boolean }
      • rechunk: boolean

        rechunk the final DataFrame/Series.

    Returns pl.Series

    Example

    > const df1 = pl.DataFrame({"a": [1], "b": [3]});
    > const df2 = pl.DataFrame({"a": [2], "b": [4]});
    > pl.concat([df1, df2]);
    shape: (2, 2)
    ┌─────┬─────┐
    │ a   ┆ b   │
    │ --- ┆ --- │
    │ i64 ┆ i64 │
    ╞═════╪═════╡
    │ 1   ┆ 3   │
    ├╌╌╌╌╌┼╌╌╌╌╌┤
    │ 2   ┆ 4   │
    └─────┴─────┘

    > const a = pl.DataFrame({ a: ["a", "b"], b: [1, 2] });
    > const b = pl.DataFrame({ c: [5, 6], d: [7, 8], e: [9, 10]});
    > pl.concat([a, b], { how: "horizontal" });

    shape: (2, 5)
    ┌─────┬─────┬─────┬─────┬──────┐
    │ a   ┆ b   ┆ c   ┆ d   ┆ e    │
    │ --- ┆ --- ┆ --- ┆ --- ┆ ---  │
    │ str ┆ f64 ┆ f64 ┆ f64 ┆ f64  │
    ╞═════╪═════╪═════╪═════╪══════╡
    │ a   ┆ 1.0 ┆ 5.0 ┆ 7.0 ┆ 9.0  │
    │ b   ┆ 2.0 ┆ 6.0 ┆ 8.0 ┆ 10.0 │
    └─────┴─────┴─────┴─────┴──────┘

    > const df_d1 = pl.DataFrame({"a": [1], "b": [3]});
    > const df_d2 = pl.DataFrame({"a": [2], "c": [4]});
    > pl.concat([df_d1, df_d2], { how: "diagonal" });

    shape: (2, 3)
    ┌─────┬──────┬──────┐
    │ a   ┆ b    ┆ c    │
    │ --- ┆ ---  ┆ ---  │
    │ i64 ┆ i64  ┆ i64  │
    ╞═════╪══════╪══════╡
    │ 1   ┆ 3    ┆ null │
    │ 2   ┆ null ┆ 4    │
    └─────┴──────┴──────┘
  • concat(items: LazyDataFrame[], options?: ConcatOptions): LazyDataFrame

    Aggregate all the Dataframes/Series in a List of DataFrames/Series to a single DataFrame/Series.

    Parameters

    • items: LazyDataFrame[]

      DataFrames/Series/LazyFrames to concatenate.

    • Optionaloptions: ConcatOptions

      Options for concat

      • Optionalhow?: "vertical" | "horizontal" | "diagonal"
      • Optionalrechunk?: boolean

    Returns LazyDataFrame

    Example

    > const df1 = pl.DataFrame({"a": [1], "b": [3]});
    > const df2 = pl.DataFrame({"a": [2], "b": [4]});
    > pl.concat([df1, df2]);
    shape: (2, 2)
    ┌─────┬─────┐
    │ a   ┆ b   │
    │ --- ┆ --- │
    │ i64 ┆ i64 │
    ╞═════╪═════╡
    │ 1   ┆ 3   │
    ├╌╌╌╌╌┼╌╌╌╌╌┤
    │ 2   ┆ 4   │
    └─────┴─────┘

    > const a = pl.DataFrame({ a: ["a", "b"], b: [1, 2] });
    > const b = pl.DataFrame({ c: [5, 6], d: [7, 8], e: [9, 10]});
    > pl.concat([a, b], { how: "horizontal" });

    shape: (2, 5)
    ┌─────┬─────┬─────┬─────┬──────┐
    │ a   ┆ b   ┆ c   ┆ d   ┆ e    │
    │ --- ┆ --- ┆ --- ┆ --- ┆ ---  │
    │ str ┆ f64 ┆ f64 ┆ f64 ┆ f64  │
    ╞═════╪═════╪═════╪═════╪══════╡
    │ a   ┆ 1.0 ┆ 5.0 ┆ 7.0 ┆ 9.0  │
    │ b   ┆ 2.0 ┆ 6.0 ┆ 8.0 ┆ 10.0 │
    └─────┴─────┴─────┴─────┴──────┘

    > const df_d1 = pl.DataFrame({"a": [1], "b": [3]});
    > const df_d2 = pl.DataFrame({"a": [2], "c": [4]});
    > pl.concat([df_d1, df_d2], { how: "diagonal" });

    shape: (2, 3)
    ┌─────┬──────┬──────┐
    │ a   ┆ b    ┆ c    │
    │ --- ┆ ---  ┆ ---  │
    │ i64 ┆ i64  ┆ i64  │
    ╞═════╪══════╪══════╡
    │ 1   ┆ 3    ┆ null │
    │ 2   ┆ null ┆ 4    │
    └─────┴──────┴──────┘

Settings

Member Visibility