CollectionFilterResult#

class dataframely.collection.CollectionFilterResult[source]#

Container for results of calling Collection.filter().

Methods:

collect_all

Collect the results from the filter operation.

Attributes:

failure

Information about the rows that failed validation for each member.

result

The collection with members filtered for the rows passing validation.

collect_all(
**kwargs: Any,
) CollectionFilterResult[C][source]#

Collect the results from the filter operation.

Using this method is more efficient than individually calling collect() on both the result and failure objects as this method takes advantage of common subplan elimination.

Parameters:

kwargs – Keyword arguments passed directly to polars.collect_all().

Returns:

The same filter result object with all lazy frames collected and exposed as “shallow” lazy frames.

Attention

Until pola-rs/polars#24129 is released, the performance advantage of this method is limited.

failure: dict[str, FailureInfo]#

Information about the rows that failed validation for each member.

result: C#

The collection with members filtered for the rows passing validation.