Package io.substrait.proto
package io.substrait.proto
-
ClassDescriptionA generic object that can be used to embed additional extension information into the serialized substrait plan.A generic object that can be used to embed additional extension information into the serialized substrait plan.An aggregate function.Method in which equivalent records are merged before being aggregated.An aggregate function.The relational operator representing a GROUP BY AggregateThe relational operator representing a GROUP BY AggregateProtobuf type
substrait.AggregateRel.GroupingProtobuf typesubstrait.AggregateRel.GroupingProtobuf typesubstrait.AggregateRel.MeasureProtobuf typesubstrait.AggregateRel.MeasureDescribes which part of an aggregation or window function to perform within the context of distributed algorithms.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.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.Describes how the relation should consider if two rows are a matchDescribes how the relation should consider if two rows are a matchMost joins will use one of the following behaviors.ConsistentPartitionWindowRel provides the ability to perform calculations across sets of rows that are related to the current query row.ConsistentPartitionWindowRel provides the ability to perform calculations across sets of rows that are related to the current query row.This message mirrors the `WindowFunction` message but removes the fields defining the partition, sorts, and bounds, since those must be consistent across the various functions in this rel.This message mirrors the `WindowFunction` message but removes the fields defining the partition, sorts, and bounds, since those must be consistent across the various functions in this rel.Cartesian product relational operator of two tables (left and right)Cartesian product relational operator of two tables (left and right)Protobuf typesubstrait.DdlRelProtobuf typesubstrait.DdlRelProtobuf enumsubstrait.DdlRel.DdlObjectProtobuf enumsubstrait.DdlRel.DdlOpExpression that represents a dynamic parameter.Expression that represents a dynamic parameter.Represents a binding for a dynamic parameter.Represents a binding for a dynamic parameter.A redistribution operationSend all data to every target.Send all data to every target.A redistribution operationThe message to describe partition targets of an exchangeThe message to describe partition targets of an exchangeReturns zero or more bucket numbers per recordReturns zero or more bucket numbers per recordRoute approximatelyRoute approximatelyProtobuf typesubstrait.ExchangeRel.ScatterFieldsProtobuf typesubstrait.ExchangeRel.ScatterFieldsReturns a single bucket number per record.Returns a single bucket number per record.Duplicates records by emitting one or more rows per input row.Duplicates records by emitting one or more rows per input row.Protobuf typesubstrait.ExpandRel.ExpandFieldProtobuf typesubstrait.ExpandRel.ExpandFieldProtobuf typesubstrait.ExpandRel.SwitchingFieldProtobuf typesubstrait.ExpandRel.SwitchingFieldProtobuf typesubstrait.ExpressionProtobuf typesubstrait.ExpressionProtobuf typesubstrait.Expression.CastProtobuf typesubstrait.Expression.CastProtobuf enumsubstrait.Expression.Cast.FailureBehaviorProtobuf typesubstrait.Expression.EmbeddedFunctionProtobuf typesubstrait.Expression.EmbeddedFunctionProtobuf typesubstrait.Expression.EmbeddedFunction.PythonPickleFunctionProtobuf typesubstrait.Expression.EmbeddedFunction.PythonPickleFunctionProtobuf typesubstrait.Expression.EmbeddedFunction.WebAssemblyFunctionProtobuf typesubstrait.Expression.EmbeddedFunction.WebAssemblyFunctionDeprecated.Protobuf typesubstrait.Expression.EnumDeprecated.Protobuf typesubstrait.Expression.Enum.EmptyDeprecated.Deprecated.A reference to data within a structured object, supporting navigation into nested fields.A reference to data within a structured object, supporting navigation into nested fields.A reference to a lambda parameter within a lambda body expression.A reference to a lambda parameter within a lambda body expression.A root reference for the outer relation's subqueryA root reference for the outer relation's subquerySingleton that expresses this FieldReference is rooted off the root incoming record typeSingleton that expresses this FieldReference is rooted off the root incoming record typeProtobuf typesubstrait.Expression.IfThenProtobuf typesubstrait.Expression.IfThenProtobuf typesubstrait.Expression.IfThen.IfClauseProtobuf typesubstrait.Expression.IfThen.IfClauseA lambda expression representing an inline, anonymous function.A lambda expression representing an inline, anonymous function.Invokes an inline lambda expression with provided arguments.Invokes an inline lambda expression with provided arguments.Protobuf typesubstrait.Expression.LiteralProtobuf typesubstrait.Expression.LiteralProtobuf typesubstrait.Expression.Literal.DecimalProtobuf typesubstrait.Expression.Literal.DecimalProtobuf typesubstrait.Expression.Literal.IntervalCompoundProtobuf typesubstrait.Expression.Literal.IntervalCompoundProtobuf typesubstrait.Expression.Literal.IntervalDayToSecondProtobuf typesubstrait.Expression.Literal.IntervalDayToSecondProtobuf typesubstrait.Expression.Literal.IntervalYearToMonthProtobuf typesubstrait.Expression.Literal.IntervalYearToMonthProtobuf typesubstrait.Expression.Literal.ListProtobuf typesubstrait.Expression.Literal.ListProtobuf typesubstrait.Expression.Literal.MapProtobuf typesubstrait.Expression.Literal.MapProtobuf typesubstrait.Expression.Literal.Map.KeyValueProtobuf typesubstrait.Expression.Literal.Map.KeyValueProtobuf typesubstrait.Expression.Literal.PrecisionTimeProtobuf typesubstrait.Expression.Literal.PrecisionTimeProtobuf typesubstrait.Expression.Literal.PrecisionTimestampProtobuf typesubstrait.Expression.Literal.PrecisionTimestampProtobuf typesubstrait.Expression.Literal.StructProtobuf typesubstrait.Expression.Literal.StructProtobuf typesubstrait.Expression.Literal.UserDefinedProtobuf typesubstrait.Expression.Literal.UserDefinedProtobuf typesubstrait.Expression.Literal.VarCharProtobuf typesubstrait.Expression.Literal.VarCharA reference that takes an existing subtype and selectively removes fields from it.A reference that takes an existing subtype and selectively removes fields from it.Protobuf typesubstrait.Expression.MaskExpression.ListSelectProtobuf typesubstrait.Expression.MaskExpression.ListSelectProtobuf typesubstrait.Expression.MaskExpression.ListSelect.ListSelectItemProtobuf typesubstrait.Expression.MaskExpression.ListSelect.ListSelectItemProtobuf typesubstrait.Expression.MaskExpression.ListSelect.ListSelectItem.ListElementProtobuf typesubstrait.Expression.MaskExpression.ListSelect.ListSelectItem.ListElementProtobuf typesubstrait.Expression.MaskExpression.ListSelect.ListSelectItem.ListSliceProtobuf typesubstrait.Expression.MaskExpression.ListSelect.ListSelectItem.ListSliceProtobuf typesubstrait.Expression.MaskExpression.MapSelectProtobuf typesubstrait.Expression.MaskExpression.MapSelectProtobuf typesubstrait.Expression.MaskExpression.MapSelect.MapKeyProtobuf typesubstrait.Expression.MaskExpression.MapSelect.MapKeyProtobuf typesubstrait.Expression.MaskExpression.MapSelect.MapKeyExpressionProtobuf typesubstrait.Expression.MaskExpression.MapSelect.MapKeyExpressionProtobuf typesubstrait.Expression.MaskExpression.SelectProtobuf typesubstrait.Expression.MaskExpression.SelectProtobuf typesubstrait.Expression.MaskExpression.StructItemProtobuf typesubstrait.Expression.MaskExpression.StructItemProtobuf typesubstrait.Expression.MaskExpression.StructSelectProtobuf typesubstrait.Expression.MaskExpression.StructSelectProtobuf typesubstrait.Expression.MultiOrListProtobuf typesubstrait.Expression.MultiOrListProtobuf typesubstrait.Expression.MultiOrList.RecordProtobuf typesubstrait.Expression.MultiOrList.RecordExpression to dynamically construct nested types.Expression to dynamically construct nested types.Protobuf typesubstrait.Expression.Nested.ListProtobuf typesubstrait.Expression.Nested.ListProtobuf typesubstrait.Expression.Nested.MapProtobuf typesubstrait.Expression.Nested.MapProtobuf typesubstrait.Expression.Nested.Map.KeyValueProtobuf typesubstrait.Expression.Nested.Map.KeyValueProtobuf typesubstrait.Expression.Nested.StructProtobuf typesubstrait.Expression.Nested.StructA way to reference the inner property of a complex record.A way to reference the inner property of a complex record.Protobuf typesubstrait.Expression.ReferenceSegment.ListElementProtobuf typesubstrait.Expression.ReferenceSegment.ListElementProtobuf typesubstrait.Expression.ReferenceSegment.MapKeyProtobuf typesubstrait.Expression.ReferenceSegment.MapKeyProtobuf typesubstrait.Expression.ReferenceSegment.StructFieldProtobuf typesubstrait.Expression.ReferenceSegment.StructFieldA scalar function call.A scalar function call.Protobuf typesubstrait.Expression.SingularOrListProtobuf typesubstrait.Expression.SingularOrListSubquery relation expressionSubquery relation expressionPredicate checking that the left expression is contained in the right subquery Examples: x IN (SELECT * FROM t) (x, y) IN (SELECT a, b FROM t)Predicate checking that the left expression is contained in the right subquery Examples: x IN (SELECT * FROM t) (x, y) IN (SELECT a, b FROM t)A subquery with one row and one column.A subquery with one row and one column.A subquery comparison using ANY or ALL.A subquery comparison using ANY or ALL.Protobuf enumsubstrait.Expression.Subquery.SetComparison.ComparisonOpProtobuf enumsubstrait.Expression.Subquery.SetComparison.ReductionOpA predicate over a set of rows in the form of a subquery EXISTS and UNIQUE are common SQL forms of this operation.A predicate over a set of rows in the form of a subquery EXISTS and UNIQUE are common SQL forms of this operation.Protobuf enumsubstrait.Expression.Subquery.SetPredicate.PredicateOpProtobuf typesubstrait.Expression.SwitchExpressionProtobuf typesubstrait.Expression.SwitchExpressionProtobuf typesubstrait.Expression.SwitchExpression.IfValueProtobuf typesubstrait.Expression.SwitchExpression.IfValueA window function call.Defines one of the two boundaries for the window of a window function.Defines one of the two boundaries for the window of a window function.Defines that the bound extends to or from the current record.Defines that the bound extends to or from the current record.Defines that the bound extends this far ahead of the current record.Defines that the bound extends this far ahead of the current record.Defines that the bound extends this far back from the current record.Defines that the bound extends this far back from the current record.Defines an "unbounded bound": for lower bounds this means the start of the partition, and for upper bounds this means the end of the partition.Defines an "unbounded bound": for lower bounds this means the start of the partition, and for upper bounds this means the end of the partition.Protobuf enumsubstrait.Expression.WindowFunction.BoundsTypeA window function call.Protobuf typesubstrait.ExpressionReferenceProtobuf typesubstrait.ExpressionReferenceDescribe a set of operations to complete.Describe a set of operations to complete.Stub to support extension with a zero inputsStub to support extension with a zero inputsStub to support extension with multiple inputsStub to support extension with multiple inputsA stub type that can be used to extend/introduce new table types outside the specification.A stub type that can be used to extend/introduce new table types outside the specification.Stub to support extension with a single inputStub to support extension with a single inputThe relational operator representing LIMIT/OFFSET or TOP type semantics.The relational operator representing LIMIT/OFFSET or TOP type semantics.The relational operator capturing simple FILTERs (as in the WHERE clause of SQL)The relational operator capturing simple FILTERs (as in the WHERE clause of SQL)The argument of a functionThe argument of a functionAn optional function argument.An optional function argument.The hash equijoin operator will build a hash table out of one input (default `right`) based on a set of join keys.The hash equijoin operator will build a hash table out of one input (default `right`) based on a set of join keys.Protobuf enumsubstrait.HashJoinRel.BuildInputProtobuf enumsubstrait.HashJoinRel.JoinTypeThe binary JOIN relational operator left-join-right, including various join types, a join condition and post_join_filter expressionThe binary JOIN relational operator left-join-right, including various join types, a join condition and post_join_filter expressionProtobuf enumsubstrait.JoinRel.JoinTypeThe merge equijoin does a join by taking advantage of two sets that are sorted on the join keys.The merge equijoin does a join by taking advantage of two sets that are sorted on the join keys.Protobuf enumsubstrait.MergeJoinRel.JoinTypeA base object for writing (e.g., a table or a view).A base object for writing (e.g., a table or a view).A message for modeling name/type pairs.A message for modeling name/type pairs.A base table.A base table.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.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.Protobuf enumsubstrait.NestedLoopJoinRel.JoinTypeDescribe a set of operations to complete.Describe a set of operations to complete.Either a relation or root relationEither a relation or root relationThis message type can be used to deserialize only the version of a Substrait Plan message.This message type can be used to deserialize only the version of a Substrait Plan message.This operator allows to represent calculated expressions of fields (e.g., a+b).This operator allows to represent calculated expressions of fields (e.g., a+b).The scan operator of base data (physical or virtual), including filtering and projection.The scan operator of base data (physical or virtual), including filtering and projection.A stub type that can be used to extend/introduce new table types outside the specification.A stub type that can be used to extend/introduce new table types outside the specification.Read an Iceberg TableRead an Iceberg TableRead an Iceberg table using a metadata file.Read an Iceberg table using a metadata file.Represents a list of locally-accessible files in input of a scan operationRepresents a list of locally-accessible files in input of a scan operationMany files consist of indivisible chunks (e.g.Protobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.ArrowReadOptionsProtobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.ArrowReadOptionsMany files consist of indivisible chunks (e.g.Delimiter separated files may be compressed.Delimiter separated files may be compressed.Protobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.DwrfReadOptionsProtobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.DwrfReadOptionsProtobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.OrcReadOptionsProtobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.OrcReadOptionsProtobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.ParquetReadOptionsProtobuf typesubstrait.ReadRel.LocalFiles.FileOrFiles.ParquetReadOptionsA base table.A base table.A table composed of expressions.A table composed of expressions.This rel is used to create references, in case we refer to a RelRoot field names will be ignoredThis rel is used to create references, in case we refer to a RelRoot field names will be ignoredA relation (used internally in a plan)A relation (used internally in a plan)Common fields for all relational operatorsCommon fields for all relational operatorsDirect indicates no change on presence and ordering of fields in the outputDirect indicates no change on presence and ordering of fields in the outputRemap which fields are output and in which orderRemap which fields are output and in which orderChanges to the operation that can influence efficiency/performance but should not impact correctness.Changes to the operation that can influence efficiency/performance but should not impact correctness.Protobuf enumsubstrait.RelCommon.Hint.ComputationTypeProtobuf typesubstrait.RelCommon.Hint.LoadedComputationProtobuf typesubstrait.RelCommon.Hint.LoadedComputationTODO: nodes, cpu threads/%, memory, iops, etc.TODO: nodes, cpu threads/%, memory, iops, etc.Protobuf typesubstrait.RelCommon.Hint.SavedComputationProtobuf typesubstrait.RelCommon.Hint.SavedComputationThe statistics related to a hint (physical properties of records)The statistics related to a hint (physical properties of records)A relation with output field names.A relation with output field names.The relational set operators (intersection/union/etc..)The relational set operators (intersection/union/etc..)Protobuf enumsubstrait.SetRel.SetOpDescribes a mapping between a specific extension entity and the URN where that extension can be found.Describes a mapping between a specific extension entity and the URN where that extension can be found.Protobuf typesubstrait.extensions.SimpleExtensionDeclaration.ExtensionFunctionProtobuf typesubstrait.extensions.SimpleExtensionDeclaration.ExtensionFunctionDescribes a TypeDescribes a TypeProtobuf typesubstrait.extensions.SimpleExtensionDeclaration.ExtensionTypeVariationProtobuf typesubstrait.extensions.SimpleExtensionDeclaration.ExtensionTypeVariationProtobuf typesubstrait.extensions.SimpleExtensionURNProtobuf typesubstrait.extensions.SimpleExtensionURNThe description of a field to sort on (including the direction of sorting and null semantics)The description of a field to sort on (including the direction of sorting and null semantics)Protobuf enumsubstrait.SortField.SortDirectionThe ORDERY BY (or sorting) relational operator.The ORDERY BY (or sorting) relational operator.Note: type_variation_reference fields within Type messages reference a type_variation_anchor defined in the plan's extension declarations.Protobuf typesubstrait.Type.BinaryProtobuf typesubstrait.Type.BinaryProtobuf typesubstrait.Type.BooleanProtobuf typesubstrait.Type.BooleanNote: type_variation_reference fields within Type messages reference a type_variation_anchor defined in the plan's extension declarations.Protobuf typesubstrait.Type.DateProtobuf typesubstrait.Type.DateProtobuf typesubstrait.Type.DecimalProtobuf typesubstrait.Type.DecimalProtobuf typesubstrait.Type.FixedBinaryProtobuf typesubstrait.Type.FixedBinaryStart compound types.Start compound types.Protobuf typesubstrait.Type.FP32Protobuf typesubstrait.Type.FP32Protobuf typesubstrait.Type.FP64Protobuf typesubstrait.Type.FP64A function type for higher-order functions.A function type for higher-order functions.Protobuf typesubstrait.Type.I16Protobuf typesubstrait.Type.I16Protobuf typesubstrait.Type.I32Protobuf typesubstrait.Type.I32Protobuf typesubstrait.Type.I64Protobuf typesubstrait.Type.I64Protobuf typesubstrait.Type.I8Protobuf typesubstrait.Type.I8An interval consisting of the components of both IntervalYear and IntervalDayAn interval consisting of the components of both IntervalYear and IntervalDayAn interval consisting of days, seconds, and microsecondsAn interval consisting of days, seconds, and microsecondsAn interval consisting of years and monthsAn interval consisting of years and monthsProtobuf typesubstrait.Type.ListProtobuf typesubstrait.Type.ListProtobuf typesubstrait.Type.MapProtobuf typesubstrait.Type.MapProtobuf enumsubstrait.Type.NullabilityProtobuf typesubstrait.Type.ParameterProtobuf typesubstrait.Type.ParameterProtobuf typesubstrait.Type.PrecisionTimeProtobuf typesubstrait.Type.PrecisionTimeProtobuf typesubstrait.Type.PrecisionTimestampProtobuf typesubstrait.Type.PrecisionTimestampProtobuf typesubstrait.Type.PrecisionTimestampTZProtobuf typesubstrait.Type.PrecisionTimestampTZProtobuf typesubstrait.Type.StringProtobuf typesubstrait.Type.StringProtobuf typesubstrait.Type.StructProtobuf typesubstrait.Type.StructProtobuf typesubstrait.Type.TimeProtobuf typesubstrait.Type.TimeProtobuf typesubstrait.Type.TimestampProtobuf typesubstrait.Type.TimestampProtobuf typesubstrait.Type.TimestampTZProtobuf typesubstrait.Type.TimestampTZProtobuf typesubstrait.Type.TypeAliasReferenceProtobuf typesubstrait.Type.TypeAliasReferenceProtobuf typesubstrait.Type.UserDefinedProtobuf typesubstrait.Type.UserDefinedProtobuf typesubstrait.Type.UUIDProtobuf typesubstrait.Type.UUIDProtobuf typesubstrait.Type.VarCharProtobuf typesubstrait.Type.VarCharProtobuf typesubstrait.TypeAliasProtobuf typesubstrait.TypeAliasThe operator that modifies the columns of a tableThe operator that modifies the columns of a tableProtobuf typesubstrait.UpdateRel.TransformExpressionProtobuf typesubstrait.UpdateRel.TransformExpressionProtobuf typesubstrait.VersionProtobuf typesubstrait.VersionThe 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).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).Protobuf enumsubstrait.WriteRel.CreateModeProtobuf enumsubstrait.WriteRel.OutputModeProtobuf enumsubstrait.WriteRel.WriteOp