core/org.jetbrains.kotlinx.dataframe.schema/DataFrameSchema/compare

compare

abstract fun compare(other: DataFrameSchema, comparisonMode: ComparisonMode = ComparisonMode.LENIENT): CompareResult

Compares this schema with other schema.

Returns one of the possible CompareResults based on the specified comparisonMode:

LENIENT: Schemas may have different sets of columns. Missing or additional columns are reported as CompareResult.IsDerived or CompareResult.IsSuper.
STRICT: Schemas must have the same columns with the same names and types. Otherwise, the result is CompareResult.None.
STRICT_FOR_NESTED_SCHEMAS: Uses LENIENT comparison for the top-level schema and STRICT comparison for nested schemas.

Return

a CompareResult that indicates whether this schema compared to other is matching (neglecting order), derived, superset, or incomparable.

Parameters

comparisonMode

The mode to compare the schemas by. By default, generated markers for leaves aren't used as supertypes: @DataSchema(isOpen = false) Setting comparisonMode to ComparisonMode.STRICT_FOR_NESTED_SCHEMAS takes this into account for internal codegen logic.