Skip to main content

Crate fp_join

Crate fp_join 

Source
Expand description

Merge / join engine for frankenpandas — implements pandas-shape pd.merge / pd.merge_ordered / pd.merge_asof / Series.join for DataFrame and Series operands.

§Why a separate crate

Joins have substantial machinery — hash-build phases, asof search, validate-mode integrity checks, bumpalo-backed intermediate buffers — that doesn’t belong inside fp-frame’s row/column primitives. fp-join layers on top of fp-columnar / fp-index / fp-frame and exposes a merge surface matching the pandas API shape.

§Top-level entry points

§DataFrame extension trait

DataFrameMergeExt adds df.merge(...) / df.join(...) method-style entry points so callers get fluent chaining after use fp_join::DataFrameMergeExt;.

§Tunables

§Error reporting

JoinError enumerates the failure modes (key column mismatch, validate-mode violation, dtype mismatch on key column, …).

§Cross-crate relationships

  • fp-columnar (Column, ColumnError) for column storage operations.
  • fp-frame for the DataFrame / Series value types.
  • fp-index for row alignment plans + label types.
  • fp-types for the underlying scalar machinery.

Structs§

JoinExecutionOptions
JoinedSeries
MergeAsofOptions
Options for asof merge operations.
MergeExecutionOptions
MergedDataFrame
Result of a DataFrame merge operation.

Enums§

AsofDirection
Direction for asof merge matching.
JoinError
JoinType
MergeValidateMode

Constants§

DEFAULT_ARENA_BUDGET_BYTES

Traits§

DataFrameMergeExt
Extension trait adding .merge() and .join() instance methods to DataFrame.

Functions§

join_series
join_series_with_options
merge_asof
Perform an asof merge between two DataFrames.
merge_asof_with_options
Perform an asof merge between two DataFrames with additional options.
merge_dataframes
Merge two DataFrames on a single key column.
merge_dataframes_on
Merge two DataFrames on one or more key columns with identical key names.
merge_dataframes_on_with
Merge two DataFrames on one or more key columns.
merge_dataframes_on_with_options
Merge two DataFrames on one or more key columns with execution options.
merge_ordered
Perform an ordered merge of two DataFrames.