core/org.jetbrains.kotlinx.dataframe.api/JoinDsl/match

match

open infix fun <C> ColumnReference<C>.match(other: ColumnReference<C>): ColumnMatch<C>
open infix fun <C> String.match(other: ColumnReference<C>): ColumnMatch<C>
open infix fun <C> ColumnReference<C>.match(other: String): ColumnMatch<C>
open infix fun String.match(other: String): ColumnMatch<Any?>

Matches columns from the left and right DataFrames for joining.

The receiver column must belong to the left DataFrame, and the argument (other) column must belong to the right DataFrame.

For more information: See join on the documentation website.

Receiver

column from the left DataFrame.

Return

ColumnMatch representing the column pair used for joining.

Parameters

other

column from the right DataFrame.

open infix fun <C> KProperty<C>.match(other: KProperty<C>): ColumnMatch<C>
open infix fun <C> ColumnReference<C>.match(other: KProperty<C>): ColumnMatch<C>
open infix fun <C> KProperty<C>.match(other: ColumnReference<C>): ColumnMatch<C>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

Generated by Dokka
© 2021–2026 JetBrains s.r.o. and contributors. Licensed under Apache 2.0. | Documentation | GitHub | Slack Community | X | YouTube