package substrait.extensions

Get desktop application:
View/edit binary Protocol Buffers messages

A generic object that can be used to embed additional extension information into the serialized substrait plan.

Used in: AggregateRel, ConsistentPartitionWindowRel, CrossRel, DdlRel, ExchangeRel, ExtendedExpression, FetchRel, FilterRel, HashJoinRel, JoinRel, LateralJoinRel, MergeJoinRel, NamedObjectWrite, NamedTable, NestedLoopJoinRel, Plan, ProjectRel, ReadRel, ReadRel.LocalFiles, ReadRel.NamedTable, RelCommon, RelCommon.Hint, RelCommon.Hint.LoadedComputation, RelCommon.Hint.RuntimeConstraint, RelCommon.Hint.SavedComputation, RelCommon.Hint.Stats, SetRel, SortRel, TopNRel, UpdateRel, WriteRel

• repeated google.protobuf.Any optimization = 1

  An optimization is helpful information that don't influence semantics. May be ignored by a consumer.

• optional google.protobuf.Any enhancement = 2

  An enhancement alter semantics. Cannot be ignored by a consumer.

Describes a mapping between a specific extension entity and the URN where that extension can be found.

Used in: ExtendedExpression, Plan

• oneof mapping_type

  • SimpleExtensionDeclaration.ExtensionType extension_type = 1

  • SimpleExtensionDeclaration.ExtensionTypeVariation extension_type_variation = 2

  • SimpleExtensionDeclaration.ExtensionFunction extension_function = 3

Used in: SimpleExtensionDeclaration

• uint32 extension_urn_reference = 4

  references the extension_urn_anchor defined for a specific extension URN.

• uint32 function_anchor = 2

  A surrogate key used in the context of a single plan to reference a specific function. 0 is a valid anchor/reference, but prefer non-zero values for ergonomics.

• string name = 3

  A function signature

Describes a Type

Used in: SimpleExtensionDeclaration

• uint32 extension_urn_reference = 4

  references the extension_urn_anchor defined for a specific extension URN.

• uint32 type_anchor = 2

  A surrogate key used in the context of a single plan to reference a specific extension type. 0 is a valid anchor/reference, but prefer non-zero values for ergonomics.

• string name = 3

  the name of the type in the defined extension YAML.

Used in: SimpleExtensionDeclaration

• uint32 extension_urn_reference = 4

  references the extension_urn_anchor defined for a specific extension URN.

• uint32 type_variation_anchor = 2

  A surrogate key used in the context of a single plan to reference a specific type variation. Use non-zero values; 0 is reserved for the system-preferred variation.

• string name = 3

  the name of the type in the defined extension YAML.

Used in: ExtendedExpression, Plan

• uint32 extension_urn_anchor = 1

  A surrogate key used in the context of a single plan used to reference the URN associated with an extension. 0 is a valid anchor/reference, but prefer non-zero values for ergonomics.

• string urn = 2

  The extension URN that uniquely identifies this extension. This must follow the format extension:<OWNER>:<ID> and serves as the "namespace" of this extension.