under

Inserts the new column previously specified with insert under the selected column group.

This works for existing column groups, as well as for ones that don't exist yet; in that case, they will be created.

For more information: See insert on the documentation website.

See Grammar for more details.

See SelectingColumns.ColumnsSelectionDsl.

Examples

// Insert a new column "age" under the column group with path ("info", "personal")
df.insert(age).under { info.personal }

// Insert a new column "age" under the previously-nonexistent column group with path ("info", "extraData")
df.insert(age).under { info.colGroup("extraData") }

// Insert a new column "sum" under the only top-level column group
val dfWithSum = df.insert("sum") { a + b }.under { colGroups().single() }

Parameters

Inserts the new column previously specified with insert under the given column group by its name.

If the column group with the provided name does not exist, it will be created automatically.

For more information: See insert on the documentation website.

See Grammar for more details.

Example

// Insert a new column "age" under the "info" column group.
df.insert(age).under("info")

Parameters

Moves columns, previously selected with move under a new or an existing column group within the DataFrame. If the column group doesn't exist, it will be created.

See Selecting Columns.

For more information: See move on the documentation website.

Select single or multiple columns using their names as Strings. (String API).

Examples:

df.move("age", "weight").under("info")
df.move { age and weight }.under("info")

Parameters

Moves columns, previously selected with move under a new or an existing column group specified by a column path within the DataFrame.

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.

See Selecting Columns.

For more information: See move on the documentation website.

Select or express columns using the Columns Selection DSL.

This DSL is initiated by a Columns Selector lambda, which operates in the context of the Columns Selection DSL and expects you to return a SingleColumn or ColumnSet (so, a ColumnsResolver). This is an entity formed by calling any (combination) of the functions in the DSL that is or can be resolved into one or more columns.

The Columns Selection DSL allows using Extension Properties for specifying columns type- and name-safe.

Check out: Columns Selection DSL Grammar

See Column Selectors on the documentation website.

Examples:

// move under an existing column group
df.move { age and weight }.under { info }
// move under a new column group
df.move { age and weight }.under { columnGroup(info) }

Parameters

this.under { columnPath }

DEPRECATED:

Use insert {}.under { columnPath } instead.

See Grammar for more details.