add

Creates a new column using an AddExpression and adds a new column to the end of this DataFrame (at the top level).

With an AddExpression, you define the value that each row in the new column should have. This can be based on values from the same row in the original DataFrame.

You can also use functions like prev and next to access other rows, and combine them with newValue to reference values already computed in the new column. For example, use prev().newValue() to access the new column value from the previous row.

Returns a new DataFrame with the new column appended to the original list of DataFrame.columns.

Example

// Add a new column "sum" that contains the sum of values from the "firstValue"
// and "secondValue" columns for each row.
val dfWithSum = df.add("sum") { firstValue + secondValue }

// Add a "fibonacci" column with the Fibonacci sequence:
// for the first two rows, the value is 1;
// for subsequent rows, it's the sum of the two previous Fibonacci values.
val dfWithFibonacci = df.add("fibonacci") {
    if (index() < 2) 1
    else prev()!!.newValue<Int>() + prev()!!.prev()!!.newValue<Int>()
}

For more information: See add on the documentation website.

Parameters

Throws

Creates a new column using AddExpression and inserts it at the specified ColumnPath.

With an AddExpression, you define the value that each row in the new column should have. This can be based on values from the same row in the original DataFrame.

You can also use functions like prev and next to access other rows, and combine them with newValue to reference values already computed in the new column. For example, use prev().newValue() to access the new column value from the previous row.

For more information: See add on the documentation website.

Returns a new DataFrame with the new column inserted at the given path.

If the specified path is partially or fully missing — that is, if any segment of the path does not correspond to an existing column or column group — all missing parts will be created automatically.

Example

// Add a new column "sum" inside the "info" column group (which will be created if it doesn't exist).
// The column contains the sum of values from the "firstValue" and "secondValue" columns for each row.
val dfWithSum = df.add(pathOf("info", "sum")) { firstValue + secondValue }

Parameters

Throws

Creates new columns using the AddDsl builder.

An AddDsl allows you to add multiple new columns and column groups to a DataFrame using concise syntax based on from, into operations and AddExpressions.

Returns a new DataFrame with the newly added columns.

Example

val dfWithAdded = df.add {
    // Add new column "yearOfBirth" computed as 2021 minus value in "age" column
    "yearOfBirth" from { 2021 - age }

    // Add column "is adult" with result of age > 18
    age > 18 into "is adult"

    // Add new column "role" using expression
    expr { if ( department == "IT") "developer" else "analyst" } into "role"

    // Add column group "details"
    group("details") {
        // Add column "last name length" with length of lastName
        name.lastName.length() into "last name length"

        // Add column "full name" by combining firstName and lastName
        "full name" from { name.firstName + " " + name.lastName }
    }
}

For more information: See add on the documentation website.

Parameters

Creates a new column using AddExpression and adds a new column to the end of each group (i.e., DataFrames) of this GroupBy (at the top level).

With an AddExpression, you define the value that each row in the new column should have. This can be based on values from the same row in the original DataFrame.

You can also use functions like prev and next to access other rows, and combine them with newValue to reference values already computed in the new column. For example, use prev().newValue() to access the new column value from the previous row.

Returns a new GroupBy with the new column appended to each group DataFrame to the original list of DataFrame.columns.

Check out GroupBy grammar.

For more information: See "GroupBy Transformation" on the documentation website.

Example

// Add a new column "sum" that contains the sum of values from the "firstValue"
// and "secondValue" columns for each row.
val gbWithSum = gb.add("sum") { firstValue + secondValue }

// Add a "fibonacci" column with the Fibonacci sequence:
// for the first two rows, the value is 1;
// for subsequent rows, it's the sum of the two previous Fibonacci values.
val gbWithFibonacci = gb.add("fibonacci") {
    if (index() < 2) 1
    else prev()!!.newValue<Int>() + prev()!!.prev()!!.newValue<Int>()
}

Parameters

Throws

this.addAll(*columns)

Adds new columns to the end of this DataFrame (at the top level).

Returns a new DataFrame with the new columns appended to the original list of DataFrame.columns.

For more information: See add on the documentation website.

Parameters

Throws

this.addAll(*dataFrames)

Adds all columns from the given dataFrames to the end of this DataFrame (at the top level).

Returns a new DataFrame with the columns from the specified dataFrames appended to the original list of DataFrame.columns.

For more information: See add on the documentation website.

Parameters

Throws