Expand description
Generated types for the protobuf substrait package.
Modules§
- aggregate_
function - Nested message and enum types in
AggregateFunction. - aggregate_
rel - Nested message and enum types in
AggregateRel. - capabilities
- Nested message and enum types in
Capabilities. - comparison_
join_ key - Nested message and enum types in
ComparisonJoinKey. - consistent_
partition_ window_ rel - Nested message and enum types in
ConsistentPartitionWindowRel. - ddl_rel
- Nested message and enum types in
DdlRel. - derivation_
expression - Nested message and enum types in
DerivationExpression. - exchange_
rel - Nested message and enum types in
ExchangeRel. - expand_
rel - Nested message and enum types in
ExpandRel. - expression
- Nested message and enum types in
Expression. - expression_
reference - Nested message and enum types in
ExpressionReference. - extensions
- Generated types for the protobuf
substrait.extensionspackage - fetch_
rel - Nested message and enum types in
FetchRel. - function_
argument - Nested message and enum types in
FunctionArgument. - function_
signature - Nested message and enum types in
FunctionSignature. - hash_
join_ rel - Nested message and enum types in
HashJoinRel. - join_
rel - Nested message and enum types in
JoinRel. - merge_
join_ rel - Nested message and enum types in
MergeJoinRel. - nested_
loop_ join_ rel - Nested message and enum types in
NestedLoopJoinRel. - parameterized_
type - Nested message and enum types in
ParameterizedType. - plan_
rel - Nested message and enum types in
PlanRel. - read_
rel - Nested message and enum types in
ReadRel. - rel
- Nested message and enum types in
Rel. - rel_
common - Nested message and enum types in
RelCommon. - set_rel
- Nested message and enum types in
SetRel. - sort_
field - Nested message and enum types in
SortField. - type
- Nested message and enum types in
Type. - update_
rel - Nested message and enum types in
UpdateRel. - write_
rel - Nested message and enum types in
WriteRel.
Structs§
- Aggregate
Function - An aggregate function.
- Aggregate
Rel - The relational operator representing a GROUP BY Aggregate
- Capabilities
- Defines a set of Capabilities that a system (producer or consumer) supports.
- Comparison
Join Key - Hash joins and merge joins are a specialization of the general join where the join expression is an series of comparisons between fields that are ANDed together. The behavior of this comparison is flexible
- Consistent
Partition Window Rel - ConsistentPartitionWindowRel provides the ability to perform calculations across sets of rows that are related to the current query row. It can be used to execute window functions where all the windows share the same partitioning and ordering.
- Cross
Rel - Cartesian product relational operator of two tables (left and right)
- DdlRel
- Derivation
Expression - Dynamic
Parameter - Expression that represents a dynamic parameter. Dynamic parameters are identified by a surrogate key within a plan.
- Dynamic
Parameter Binding - Represents a binding for a dynamic parameter.
- Exchange
Rel - A redistribution operation
- Expand
Rel - Duplicates records by emitting one or more rows per input row. The number of rows emitted per input row is the same for all input rows.
- Expression
- Expression
Reference - Extended
Expression - Describe a set of operations to complete. For compactness sake, identifiers are normalized at the plan level.
- Extension
Leaf Rel - Stub to support extension with a zero inputs
- Extension
Multi Rel - Stub to support extension with multiple inputs
- Extension
Object - A stub type that can be used to extend/introduce new table types outside the specification.
- Extension
Single Rel - Stub to support extension with a single input
- Fetch
Rel - The relational operator representing LIMIT/OFFSET or TOP type semantics.
- Filter
Rel - The relational operator capturing simple FILTERs (as in the WHERE clause of SQL)
- Function
Argument - The argument of a function
- Function
Option - An optional function argument. Typically used for specifying behavior in invalid or corner cases.
- Function
Signature - List of function signatures available.
- Hash
Join Rel - The hash equijoin join operator will build a hash table out of the right input based on a set of join keys. It will then probe that hash table for incoming inputs, finding matches.
- JoinRel
- The binary JOIN relational operator left-join-right, including various join types, a join condition and post_join_filter expression
- Merge
Join Rel - The merge equijoin does a join by taking advantage of two sets that are sorted on the join keys. This allows the join operation to be done in a streaming fashion.
- Named
Object Write - A base object for writing (e.g., a table or a view).
- Named
Struct - A message for modeling name/type pairs.
- Named
Table - A base table. The list of string is used to represent namespacing (e.g., mydb.mytable). This assumes shared catalog between systems exchanging a message.
- Nested
Loop Join Rel - The nested loop join (NLJ) operator will hold the entire right input and iterate over it using the left input, evaluating the join expression on the Cartesian product of all rows.
- Parameterized
Type - Plan
- Describe a set of operations to complete. For compactness sake, identifiers are normalized at the plan level.
- PlanRel
- Either a relation or root relation
- Plan
Version - This message type can be used to deserialize only the version of a Substrait Plan message. This prevents deserialization errors when there were breaking changes between the Substrait version of the tool that produced the plan and the Substrait version used to deserialize it, such that a consumer can emit a more helpful error message in this case.
- Project
Rel - This operator allows to represent calculated expressions of fields (e.g., a+b). Direct/Emit are used to represent classical relational projections
- ReadRel
- The scan operator of base data (physical or virtual), including filtering and projection.
- Reference
Rel - This rel is used to create references, in case we refer to a RelRoot field names will be ignored
- Rel
- A relation (used internally in a plan)
- RelCommon
- Common fields for all relational operators
- RelRoot
- A relation with output field names.
- SetRel
- The relational set operators (intersection/union/etc..)
- Sort
Field - The description of a field to sort on (including the direction of sorting and null semantics)
- SortRel
- The ORDERY BY (or sorting) relational operator. Beside describing a base relation, it includes a list of fields to sort on
- Type
- Update
Rel - The operator that modifies the columns of a table
- Version
- Write
Rel - The operator that modifies the content of a database (operates on 1 table at a time, but record-selection/source can be based on joining of multiple tables).
Enums§
- Aggregation
Phase - Describes which part of an aggregation or window function to perform within the context of distributed algorithms.