Module builder

This module provides a builder for creating LogicalPlans

Structs

LogicalPlanBuilder

Builder for logical plans

LogicalPlanBuilderOptions

Options for LogicalPlanBuilder

LogicalTableSource

Basic TableSource implementation intended for use in tests and documentation. It is expected that users will provide their own TableSource implementations or use DataFusion’s DefaultTableSource.

Constants

UNNAMED_TABLE

Default table name for unnamed table

Functions

add_group_by_exprs_from_dependencies

Add additional “synthetic” group by expressions based on functional dependencies.

build_join_schema

Creates a schema for a join operation. The fields from the left side are first

change_redundant_column

get_struct_unnested_columns

project

Create Projection

requalify_sides_if_needed

(Re)qualify the sides of a join if needed, i.e. if the columns from one side would otherwise conflict with the columns from the other. This is especially useful for queries that come as Substrait, since Substrait doesn’t currently allow specifying aliases, neither for columns nor for tables. DataFusion requires columns to be uniquely identifiable, in some places (see e.g. DFSchema::check_names). The function returns:

subquery_alias

Create a SubqueryAlias to wrap a LogicalPlan.

table_scan

Create a LogicalPlanBuilder representing a scan of a table with the provided name and schema. This is mostly used for testing and documentation.

table_scan_with_filter_and_fetch

Create a LogicalPlanBuilder representing a scan of a table with the provided name and schema, filters, and inlined fetch. This is mostly used for testing and documentation.

table_scan_with_filters

Create a LogicalPlanBuilder representing a scan of a table with the provided name and schema, and inlined filters. This is mostly used for testing and documentation.

table_source

table_source_with_constraints

union

Union two LogicalPlans.

union_by_name

Like union, but combine rows from different tables by name, rather than by position.

unnest

Create a LogicalPlan::Unnest plan

unnest_with_options

Create a LogicalPlan::Unnest plan with options This function receive a list of columns to be unnested because multiple unnest can be performed on the same column (e.g unnest with different depth) The new schema will contains post-unnest fields replacing the original field

validate_unique_names

Errors if one or more expressions have equal names.

wrap_projection_for_join_if_necessary

Wrap projection for a plan, if the join keys contains normal expression.