All Classes and Interfaces

Class
Description
Base class for DDL relations with no inputs.
DDL object kinds.
DDL operations.
Physical exchange relation with a single input and extension metadata.
Exchange target specification: partition IDs and target type.
Base expression visitor that routes all visits to a fallback handler.
 
Represents a generic function invocation, including its declaration, arguments, aggregation phase, sort fields, output type, and invocation details.
 
 
 
Represents an update operation on a table.
Represents a transformation applied to a specific column during an update.
Base class for write relations with a single input.
Behavior when the target table already exists.
Output behavior for write operations.
Logical write operation kinds.
Represents advanced extensions that can include optimizations and enhancements.
Represents an enhancement associated with an AdvancedExtension.
Represents an optimization associated with an AdvancedExtension.
 
 
 
Represents an aggregate function invocation, including its declaration, arguments, options, aggregation phase, sort fields, output type, and invocation semantics.
We don't depend on guava...
 
 
A window relation that ensures consistent partitioning and ordering across all window function invocations in a single input relation.
A single window function invocation with its arguments, options, output type, phase/invocation, and window bounds.
Provides common utilities for copy-on-write visitations
 
 
A set of utility methods to deal with convertion of decimal values.
Provides default extension catalog constants and utilities for loading built-in Substrait function definitions.
 
 
Default type to which google.protobuf.Any detail messages are converted to by the ProtoRelConverter
 
Captures the SimpleExtension.EnumArgument option value in a SimpleExtension.Function invocation.
Expands the input relation into a set of projected fields where each field is either consistent or switches among duplicate expressions.
A field whose value is defined by a single expression.
A field produced by the expand operation.
A field that may switch among duplicate expressions; nullability propagates if any duplicate is nullable.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
A nested list expression with one or more elements.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Deprecated.
User-defined literal with value encoded as Any.
Base interface for user-defined literals.
User-defined literal with value encoded as Expression.Literal.Struct.
 
 
 
 
 
 
Converts from Expression to Expression
 
Visitor for Expression nodes.
Represents an extended expression that references multiple expressions and schema details.
Represents a reference to an aggregate function measure.
Represents a reference to a single expression.
Base interface for expression references.
 
Contains tag interfaces for handling Any types within Substrait.
 
 
 
 
 
 
Maintains a mapping between function/type anchors and function/type references.
 
 
Interface with operations for resolving references to SimpleExtensionDeclarations within an individual plan to their corresponding functions or types.
 
Converter from AdvancedExtension to proto.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
FunctionArg is a marker interface that represents an argument of a SimpleExtension.Function invocation.
 
Converts from FunctionArgument to FunctionArg
 
Used to indicate the potential presence of an AdvancedExtension
 
 
 
 
 
 
 
 
Immutable implementation of AdvancedExtension.
Builds instances of type ImmutableAdvancedExtension.
Immutable implementation of Aggregate.
Builds instances of type ImmutableAggregate.
Immutable implementation of AggregateFunctionInvocation.
Builds instances of type ImmutableAggregateFunctionInvocation.
Builds instances of type ImmutableAggregateFunctionReference.
Immutable implementation of BroadcastExchange.
Builds instances of type ImmutableBroadcastExchange.
Immutable implementation of ConsistentPartitionWindow.
Builds instances of type ImmutableConsistentPartitionWindow.
Builds instances of type WindowRelFunctionInvocation.
Immutable implementation of Cross.
Builds instances of type ImmutableCross.
Immutable implementation of EnumArg.
Builds instances of type ImmutableEnumArg.
Immutable implementation of AbstractExchangeRel.ExchangeTarget.
Builds instances of type ImmutableExchangeTarget.
Immutable implementation of Expand.
Builds instances of type ImmutableExpand.
Immutable implementation of Expand.ConsistentField.
Builds instances of type ConsistentField.
Immutable implementation of Expand.SwitchingField.
Builds instances of type SwitchingField.
ImmutableExpression contains immutable implementation classes generated from abstract value types defined as nested inside Expression.
Immutable implementation of Expression.BinaryLiteral.
Builds instances of type BinaryLiteral.
Immutable implementation of Expression.BoolLiteral.
Builds instances of type BoolLiteral.
Immutable implementation of Expression.Cast.
Builds instances of type Cast.
Immutable implementation of Expression.DateLiteral.
Builds instances of type DateLiteral.
Immutable implementation of Expression.DecimalLiteral.
Builds instances of type DecimalLiteral.
Immutable implementation of Expression.EmptyListLiteral.
Builds instances of type EmptyListLiteral.
Immutable implementation of Expression.EmptyMapLiteral.
Builds instances of type EmptyMapLiteral.
Immutable implementation of Expression.FixedBinaryLiteral.
Builds instances of type FixedBinaryLiteral.
Immutable implementation of Expression.FixedCharLiteral.
Builds instances of type FixedCharLiteral.
Immutable implementation of Expression.FP32Literal.
Builds instances of type FP32Literal.
Immutable implementation of Expression.FP64Literal.
Builds instances of type FP64Literal.
Immutable implementation of Expression.I16Literal.
Builds instances of type I16Literal.
Immutable implementation of Expression.I32Literal.
Builds instances of type I32Literal.
Immutable implementation of Expression.I64Literal.
Builds instances of type I64Literal.
Immutable implementation of Expression.I8Literal.
Builds instances of type I8Literal.
Immutable implementation of Expression.IfClause.
Builds instances of type IfClause.
Immutable implementation of Expression.IfThen.
Builds instances of type IfThen.
Immutable implementation of Expression.InPredicate.
Builds instances of type InPredicate.
Immutable implementation of Expression.IntervalCompoundLiteral.
Builds instances of type IntervalCompoundLiteral.
Immutable implementation of Expression.IntervalDayLiteral.
Builds instances of type IntervalDayLiteral.
Immutable implementation of Expression.IntervalYearLiteral.
Builds instances of type IntervalYearLiteral.
Immutable implementation of Expression.Lambda.
Builds instances of type Lambda.
Immutable implementation of Expression.ListLiteral.
Builds instances of type ListLiteral.
Immutable implementation of Expression.MapLiteral.
Builds instances of type MapLiteral.
Immutable implementation of Expression.MultiOrList.
Builds instances of type MultiOrList.
Immutable implementation of Expression.MultiOrListRecord.
Builds instances of type MultiOrListRecord.
Immutable implementation of Expression.NestedList.
Builds instances of type NestedList.
Immutable implementation of Expression.NestedStruct.
Builds instances of type NestedStruct.
Immutable implementation of Expression.NullLiteral.
Builds instances of type NullLiteral.
Immutable implementation of Expression.PrecisionTimeLiteral.
Builds instances of type PrecisionTimeLiteral.
Immutable implementation of Expression.PrecisionTimestampLiteral.
Builds instances of type PrecisionTimestampLiteral.
Immutable implementation of Expression.PrecisionTimestampTZLiteral.
Builds instances of type PrecisionTimestampTZLiteral.
Immutable implementation of Expression.ScalarFunctionInvocation.
Builds instances of type ScalarFunctionInvocation.
Immutable implementation of Expression.ScalarSubquery.
Builds instances of type ScalarSubquery.
Immutable implementation of Expression.SetPredicate.
Builds instances of type SetPredicate.
Immutable implementation of Expression.SingleOrList.
Builds instances of type SingleOrList.
Immutable implementation of Expression.SortField.
Builds instances of type SortField.
Immutable implementation of Expression.StrLiteral.
Builds instances of type StrLiteral.
Immutable implementation of Expression.StructLiteral.
Builds instances of type StructLiteral.
Immutable implementation of Expression.Switch.
Builds instances of type Switch.
Immutable implementation of Expression.SwitchClause.
Builds instances of type SwitchClause.
Deprecated.
Builds instances of type TimeLiteral.
Deprecated.
Builds instances of type TimestampLiteral.
Deprecated.
Builds instances of type TimestampTZLiteral.
Immutable implementation of Expression.UserDefinedAnyLiteral.
Builds instances of type UserDefinedAnyLiteral.
Immutable implementation of Expression.UserDefinedStructLiteral.
Builds instances of type UserDefinedStructLiteral.
Immutable implementation of Expression.UUIDLiteral.
Builds instances of type UUIDLiteral.
Immutable implementation of Expression.VarCharLiteral.
Builds instances of type VarCharLiteral.
Immutable implementation of Expression.WindowFunctionInvocation.
Builds instances of type WindowFunctionInvocation.
Immutable implementation of ExtendedExpression.ExpressionReference.
Builds instances of type ImmutableExpressionReference.
Immutable implementation of ExtendedExpression.
Builds instances of type ImmutableExtendedExpression.
Immutable implementation of ExtensionDdl.
Builds instances of type ImmutableExtensionDdl.
Immutable implementation of ExtensionLeaf.
Builds instances of type ImmutableExtensionLeaf.
Maintains a mapping between function anchors and function references.
 
Immutable implementation of ExtensionMulti.
Builds instances of type ImmutableExtensionMulti.
Immutable implementation of ExtensionSingle.
Builds instances of type ImmutableExtensionSingle.
Immutable implementation of ExtensionTable.
Builds instances of type ImmutableExtensionTable.
Immutable implementation of ExtensionWrite.
Builds instances of type ImmutableExtensionWrite.
Immutable implementation of Fetch.
Builds instances of type ImmutableFetch.
Immutable implementation of FieldReference.
Builds instances of type ImmutableFieldReference.
ImmutableFileFormat contains immutable implementation classes generated from abstract value types defined as nested inside FileFormat.
Immutable implementation of FileFormat.ArrowReadOptions.
Builds instances of type ArrowReadOptions.
Builds instances of type DelimiterSeparatedTextReadOptions.
Immutable implementation of FileFormat.DwrfReadOptions.
Builds instances of type DwrfReadOptions.
Immutable implementation of FileFormat.Extension.
Builds instances of type Extension.
Immutable implementation of FileFormat.OrcReadOptions.
Builds instances of type OrcReadOptions.
Immutable implementation of FileFormat.ParquetReadOptions.
Builds instances of type ParquetReadOptions.
Immutable implementation of FileOrFiles.
Builds instances of type ImmutableFileOrFiles.
Immutable implementation of Filter.
Builds instances of type ImmutableFilter.
Immutable implementation of FunctionOption.
Builds instances of type ImmutableFunctionOption.
Immutable implementation of Aggregate.Grouping.
Builds instances of type ImmutableGrouping.
Immutable implementation of HashJoin.
Builds instances of type ImmutableHashJoin.
Immutable implementation of Hint.
Builds instances of type ImmutableHint.
Immutable implementation of Join.
Builds instances of type ImmutableJoin.
Immutable implementation of FieldReference.ListElement.
Builds instances of type ImmutableListElement.
Immutable implementation of Hint.LoadedComputation.
Builds instances of type ImmutableLoadedComputation.
Immutable implementation of LocalFiles.
Builds instances of type ImmutableLocalFiles.
Immutable implementation of FieldReference.MapKey.
Builds instances of type ImmutableMapKey.
Immutable implementation of Aggregate.Measure.
Builds instances of type ImmutableMeasure.
Immutable implementation of MergeJoin.
Builds instances of type ImmutableMergeJoin.
Immutable implementation of MultiBucketExchange.
Builds instances of type ImmutableMultiBucketExchange.
Immutable implementation of NamedDdl.
Builds instances of type ImmutableNamedDdl.
Immutable implementation of NamedScan.
Builds instances of type ImmutableNamedScan.
Immutable implementation of NamedStruct.
Builds instances of type ImmutableNamedStruct.
Immutable implementation of NamedUpdate.
Builds instances of type ImmutableNamedUpdate.
Immutable implementation of NamedWrite.
Builds instances of type ImmutableNamedWrite.
Immutable implementation of NestedLoopJoin.
Builds instances of type ImmutableNestedLoopJoin.
ImmutableParameterizedType contains immutable implementation classes generated from abstract value types defined as nested inside ParameterizedType.
Immutable implementation of ParameterizedType.Decimal.
Builds instances of type Decimal.
Immutable implementation of ParameterizedType.FixedBinary.
Builds instances of type FixedBinary.
Immutable implementation of ParameterizedType.FixedChar.
Builds instances of type FixedChar.
Immutable implementation of ParameterizedType.Func.
Builds instances of type Func.
Immutable implementation of ParameterizedType.IntervalCompound.
Builds instances of type IntervalCompound.
Immutable implementation of ParameterizedType.IntervalDay.
Builds instances of type IntervalDay.
Immutable implementation of ParameterizedType.ListType.
Builds instances of type ListType.
Immutable implementation of ParameterizedType.Map.
Builds instances of type Map.
Immutable implementation of ParameterizedType.PrecisionTime.
Builds instances of type PrecisionTime.
Immutable implementation of ParameterizedType.PrecisionTimestamp.
Builds instances of type PrecisionTimestamp.
Immutable implementation of ParameterizedType.PrecisionTimestampTZ.
Builds instances of type PrecisionTimestampTZ.
Immutable implementation of ParameterizedType.StringLiteral.
Builds instances of type StringLiteral.
Immutable implementation of ParameterizedType.Struct.
Builds instances of type Struct.
Immutable implementation of ParameterizedType.VarChar.
Builds instances of type VarChar.
Immutable implementation of Plan.
Builds instances of type ImmutablePlan.
Immutable implementation of Project.
Builds instances of type ImmutableProject.
Immutable implementation of Rel.Remap.
Builds instances of type ImmutableRemap.
Immutable implementation of Plan.Root.
Builds instances of type ImmutableRoot.
Immutable implementation of RoundRobinExchange.
Builds instances of type ImmutableRoundRobinExchange.
Immutable implementation of Hint.RuntimeConstraint.
Builds instances of type ImmutableRuntimeConstraint.
Immutable implementation of Hint.SavedComputation.
Builds instances of type ImmutableSavedComputation.
Immutable implementation of ScatterExchange.
Builds instances of type ImmutableScatterExchange.
Immutable implementation of Set.
Builds instances of type ImmutableSet.
ImmutableSimpleExtension contains immutable implementation classes generated from abstract value types defined as nested inside SimpleExtension.
Immutable implementation of SimpleExtension.AggregateFunction.
Builds instances of type AggregateFunction.
Immutable implementation of SimpleExtension.AggregateFunctionVariant.
Builds instances of type AggregateFunctionVariant.
Immutable implementation of SimpleExtension.EnumArgument.
Builds instances of type EnumArgument.
Immutable implementation of SimpleExtension.ExtensionCollection.
Builds instances of type ExtensionCollection.
Immutable implementation of SimpleExtension.ExtensionSignatures.
Builds instances of type ExtensionSignatures.
Immutable implementation of SimpleExtension.FunctionAnchor.
Builds instances of type FunctionAnchor.
Immutable implementation of SimpleExtension.Option.
Builds instances of type Option.
Immutable implementation of SimpleExtension.ScalarFunction.
Builds instances of type ScalarFunction.
Immutable implementation of SimpleExtension.ScalarFunctionVariant.
Builds instances of type ScalarFunctionVariant.
Immutable implementation of SimpleExtension.Type.
Builds instances of type Type.
Immutable implementation of SimpleExtension.TypeAnchor.
Builds instances of type TypeAnchor.
Immutable implementation of SimpleExtension.TypeArgument.
Builds instances of type TypeArgument.
Immutable implementation of SimpleExtension.ValueArgument.
Builds instances of type ValueArgument.
Immutable implementation of SimpleExtension.VariadicBehavior.
Builds instances of type VariadicBehavior.
Immutable implementation of SimpleExtension.WindowFunction.
Builds instances of type WindowFunction.
Immutable implementation of SimpleExtension.WindowFunctionVariant.
Builds instances of type WindowFunctionVariant.
Immutable implementation of SingleBucketExchange.
Builds instances of type ImmutableSingleBucketExchange.
Immutable implementation of Sort.
Builds instances of type ImmutableSort.
Immutable implementation of Hint.Stats.
Builds instances of type ImmutableStats.
Immutable implementation of FieldReference.StructField.
Builds instances of type ImmutableStructField.
ImmutableTargetType contains immutable implementation classes generated from abstract value types defined as nested inside TargetType.
Immutable implementation of TargetType.Extended.
Builds instances of type Extended.
Immutable implementation of TargetType.Uri.
Builds instances of type Uri.
Immutable implementation of AbstractUpdate.TransformExpression.
Builds instances of type ImmutableTransformExpression.
ImmutableType contains immutable implementation classes generated from abstract value types defined as nested inside Type.
Immutable implementation of Type.Binary.
Builds instances of type Binary.
Immutable implementation of Type.Bool.
Builds instances of type Bool.
Immutable implementation of Type.Date.
Builds instances of type Date.
Immutable implementation of Type.Decimal.
Builds instances of type Decimal.
Immutable implementation of Type.FixedBinary.
Builds instances of type FixedBinary.
Immutable implementation of Type.FixedChar.
Builds instances of type FixedChar.
Immutable implementation of Type.FP32.
Builds instances of type FP32.
Immutable implementation of Type.FP64.
Builds instances of type FP64.
Immutable implementation of Type.Func.
Builds instances of type Func.
Immutable implementation of Type.I16.
Builds instances of type I16.
Immutable implementation of Type.I32.
Builds instances of type I32.
Immutable implementation of Type.I64.
Builds instances of type I64.
Immutable implementation of Type.I8.
Builds instances of type I8.
Immutable implementation of Type.IntervalCompound.
Builds instances of type IntervalCompound.
Immutable implementation of Type.IntervalDay.
Builds instances of type IntervalDay.
Immutable implementation of Type.IntervalYear.
Builds instances of type IntervalYear.
Immutable implementation of Type.ListType.
Builds instances of type ListType.
Immutable implementation of Type.Map.
Builds instances of type Map.
Immutable implementation of Type.ParameterBooleanValue.
Builds instances of type ParameterBooleanValue.
Immutable implementation of Type.ParameterDataType.
Builds instances of type ParameterDataType.
Immutable implementation of Type.ParameterEnumValue.
Builds instances of type ParameterEnumValue.
Immutable implementation of Type.ParameterIntegerValue.
Builds instances of type ParameterIntegerValue.
Immutable implementation of Type.ParameterStringValue.
Builds instances of type ParameterStringValue.
Immutable implementation of Type.PrecisionTime.
Builds instances of type PrecisionTime.
Immutable implementation of Type.PrecisionTimestamp.
Builds instances of type PrecisionTimestamp.
Immutable implementation of Type.PrecisionTimestampTZ.
Builds instances of type PrecisionTimestampTZ.
Immutable implementation of Type.Str.
Builds instances of type Str.
Immutable implementation of Type.Struct.
Builds instances of type Struct.
Deprecated.
Builds instances of type Time.
Deprecated.
Builds instances of type Timestamp.
Deprecated.
Builds instances of type TimestampTZ.
Immutable implementation of Type.UserDefined.
Builds instances of type UserDefined.
Immutable implementation of Type.UUID.
Builds instances of type UUID.
Immutable implementation of Type.VarChar.
Builds instances of type VarChar.
ImmutableTypeExpression contains immutable implementation classes generated from abstract value types defined as nested inside TypeExpression.
Immutable implementation of TypeExpression.ReturnProgram.Assignment.
Builds instances of type Assignment.
Immutable implementation of TypeExpression.BinaryOperation.
Builds instances of type BinaryOperation.
Immutable implementation of TypeExpression.Decimal.
Builds instances of type Decimal.
Immutable implementation of TypeExpression.FixedBinary.
Builds instances of type FixedBinary.
Immutable implementation of TypeExpression.FixedChar.
Builds instances of type FixedChar.
Immutable implementation of TypeExpression.Func.
Builds instances of type Func.
Immutable implementation of TypeExpression.IfOperation.
Builds instances of type IfOperation.
Immutable implementation of TypeExpression.IntegerLiteral.
Builds instances of type IntegerLiteral.
Immutable implementation of TypeExpression.IntervalCompound.
Builds instances of type IntervalCompound.
Immutable implementation of TypeExpression.IntervalDay.
Builds instances of type IntervalDay.
Immutable implementation of TypeExpression.ListType.
Builds instances of type ListType.
Immutable implementation of TypeExpression.Map.
Builds instances of type Map.
Immutable implementation of TypeExpression.NotOperation.
Builds instances of type NotOperation.
Immutable implementation of TypeExpression.PrecisionTime.
Builds instances of type PrecisionTime.
Immutable implementation of TypeExpression.PrecisionTimestamp.
Builds instances of type PrecisionTimestamp.
Immutable implementation of TypeExpression.PrecisionTimestampTZ.
Builds instances of type PrecisionTimestampTZ.
Immutable implementation of TypeExpression.ReturnProgram.
Builds instances of type ReturnProgram.
Immutable implementation of TypeExpression.Struct.
Builds instances of type Struct.
Immutable implementation of TypeExpression.VarChar.
Builds instances of type VarChar.
Immutable implementation of Plan.Version.
Builds instances of type ImmutableVersion.
Immutable implementation of VirtualTableScan.
Builds instances of type ImmutableVirtualTableScan.
ImmutableWindowBound contains immutable implementation classes generated from abstract value types defined as nested inside WindowBound.
Immutable implementation of WindowBound.CurrentRow.
Builds instances of type CurrentRow.
Immutable implementation of WindowBound.Following.
Builds instances of type Following.
Immutable implementation of WindowBound.Preceding.
Builds instances of type Preceding.
Immutable implementation of WindowBound.Unbounded.
Builds instances of type Unbounded.
 
 
Builds lambda expressions with build-time validation of parameter references.
 
 
 
 
 
 
 
 
 
 
 
 
Types used in function argument declarations.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Converts from Plan to Plan
 
Converts from Expression to Expression
Converter from proto to AdvancedExtension.
Converts from Plan to Plan
Converts from Rel to Rel
Converts from Type to Type
 
 
Class used to visit all child relations from a root relation and optionally replace subtrees by overriding a visitor method.
Converts from Rel to Rel
Visitor for Rel nodes.
 
 
 
 
Classes used to deserialize YAML extension files.
 
 
 
 
 
An enum argument is required to be known within the plan (no field references can be used).
The catalog of function and type definitions loaded from YAML extension files.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
This class provides an empty implementation of SubstraitTypeListener, which can be extended to create a listener which only needs to handle a subset of the available methods.
This class provides an empty implementation of SubstraitTypeVisitor, which can be extended to create a visitor which only needs to handle a subset of the available methods.
 
This interface defines a complete listener for a parse tree produced by SubstraitTypeParser.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
This interface defines a complete generic visitor for a parse tree produced by SubstraitTypeParser.
 
 
 
 
ToProto<T extends com.google.protobuf.Message>
 
 
ToTypeString emits the string `any` for all wildcard any types, even if they have numeric suffixes (i.e.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Represents a type parameter for user-defined types.
A boolean value parameter.
A data type parameter, such as the i32 in List<i32>.
An enum value parameter (represented as a string).
An integer value parameter, such as the 10 in VARCHAR<10>.
An explicitly null/unspecified parameter, used to select the default value (if any).
A string value parameter.
 
 
 
 
 
Deprecated.
Deprecated.
Deprecated.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Convert from Type to Type