Package io.substrait.proto

Interface HashJoinRelOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HashJoinRel, HashJoinRel.Builder
public interface HashJoinRelOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCommon

      boolean hasCommon()
      .substrait.RelCommon common = 1;
      Returns:
      Whether the common field is set.

    • getCommon

      RelCommon getCommon()
      .substrait.RelCommon common = 1;
      Returns:
      The common.

    • getCommonOrBuilder

      RelCommonOrBuilder getCommonOrBuilder()
      .substrait.RelCommon common = 1;

    • hasLeft

      boolean hasLeft()
      .substrait.Rel left = 2;
      Returns:
      Whether the left field is set.

    • getLeft

      Rel getLeft()
      .substrait.Rel left = 2;
      Returns:
      The left.

    • getLeftOrBuilder

      RelOrBuilder getLeftOrBuilder()
      .substrait.Rel left = 2;

    • hasRight

      boolean hasRight()
      .substrait.Rel right = 3;
      Returns:
      Whether the right field is set.

    • getRight

      Rel getRight()
      .substrait.Rel right = 3;
      Returns:
      The right.

    • getRightOrBuilder

      RelOrBuilder getRightOrBuilder()
      .substrait.Rel right = 3;

    • getLeftKeysList

      @Deprecated List<Expression.FieldReference> getLeftKeysList()
      Deprecated.
       These fields are deprecated in favor of `keys`.  If they are set then
 the two lists (left_keys and right_keys) must have the same length and
 the comparion function is considered to be SimpleEqualityType::EQ
      repeated .substrait.Expression.FieldReference left_keys = 4 [deprecated = true];

    • getLeftKeys

      @Deprecated Expression.FieldReference getLeftKeys(int index)
      Deprecated.
       These fields are deprecated in favor of `keys`.  If they are set then
 the two lists (left_keys and right_keys) must have the same length and
 the comparion function is considered to be SimpleEqualityType::EQ
      repeated .substrait.Expression.FieldReference left_keys = 4 [deprecated = true];

    • getLeftKeysCount

      @Deprecated int getLeftKeysCount()
      Deprecated.
       These fields are deprecated in favor of `keys`.  If they are set then
 the two lists (left_keys and right_keys) must have the same length and
 the comparion function is considered to be SimpleEqualityType::EQ
      repeated .substrait.Expression.FieldReference left_keys = 4 [deprecated = true];

    • getLeftKeysOrBuilderList

      @Deprecated List<? extends Expression.FieldReferenceOrBuilder> getLeftKeysOrBuilderList()
      Deprecated.
       These fields are deprecated in favor of `keys`.  If they are set then
 the two lists (left_keys and right_keys) must have the same length and
 the comparion function is considered to be SimpleEqualityType::EQ
      repeated .substrait.Expression.FieldReference left_keys = 4 [deprecated = true];

    • getLeftKeysOrBuilder

      @Deprecated Expression.FieldReferenceOrBuilder getLeftKeysOrBuilder(int index)
      Deprecated.
       These fields are deprecated in favor of `keys`.  If they are set then
 the two lists (left_keys and right_keys) must have the same length and
 the comparion function is considered to be SimpleEqualityType::EQ
      repeated .substrait.Expression.FieldReference left_keys = 4 [deprecated = true];

    • getRightKeysList

      @Deprecated List<Expression.FieldReference> getRightKeysList()
      Deprecated.
      repeated .substrait.Expression.FieldReference right_keys = 5 [deprecated = true];

    • getRightKeys

      @Deprecated Expression.FieldReference getRightKeys(int index)
      Deprecated.
      repeated .substrait.Expression.FieldReference right_keys = 5 [deprecated = true];

    • getRightKeysCount

      @Deprecated int getRightKeysCount()
      Deprecated.
      repeated .substrait.Expression.FieldReference right_keys = 5 [deprecated = true];

    • getRightKeysOrBuilderList

      @Deprecated List<? extends Expression.FieldReferenceOrBuilder> getRightKeysOrBuilderList()
      Deprecated.
      repeated .substrait.Expression.FieldReference right_keys = 5 [deprecated = true];

    • getRightKeysOrBuilder

      @Deprecated Expression.FieldReferenceOrBuilder getRightKeysOrBuilder(int index)
      Deprecated.
      repeated .substrait.Expression.FieldReference right_keys = 5 [deprecated = true];

    • getKeysList

      List<ComparisonJoinKey> getKeysList()
       One or more keys to join on.  The relation is invalid if this is empty
 (unless the deprecated left_keys/right_keys fields are being used).

 If a custom comparison function is used then it must be consistent with
 the hash function used for the keys.

 In other words, the hash function must return the same hash code when the
 comparison returns true.  For example, if the comparison function is
 "equals ignoring case" then the hash function must return the same hash
 code for strings that differ only by case.  Note: the hash function is not
 specified here.  It is the responsibility of the consumer to find an appropriate
 hash function for a given comparsion function or to reject the plan if it cannot
 do so.
      repeated .substrait.ComparisonJoinKey keys = 8;

    • getKeys

      ComparisonJoinKey getKeys(int index)
       One or more keys to join on.  The relation is invalid if this is empty
 (unless the deprecated left_keys/right_keys fields are being used).

 If a custom comparison function is used then it must be consistent with
 the hash function used for the keys.

 In other words, the hash function must return the same hash code when the
 comparison returns true.  For example, if the comparison function is
 "equals ignoring case" then the hash function must return the same hash
 code for strings that differ only by case.  Note: the hash function is not
 specified here.  It is the responsibility of the consumer to find an appropriate
 hash function for a given comparsion function or to reject the plan if it cannot
 do so.
      repeated .substrait.ComparisonJoinKey keys = 8;

    • getKeysCount

      int getKeysCount()
       One or more keys to join on.  The relation is invalid if this is empty
 (unless the deprecated left_keys/right_keys fields are being used).

 If a custom comparison function is used then it must be consistent with
 the hash function used for the keys.

 In other words, the hash function must return the same hash code when the
 comparison returns true.  For example, if the comparison function is
 "equals ignoring case" then the hash function must return the same hash
 code for strings that differ only by case.  Note: the hash function is not
 specified here.  It is the responsibility of the consumer to find an appropriate
 hash function for a given comparsion function or to reject the plan if it cannot
 do so.
      repeated .substrait.ComparisonJoinKey keys = 8;

    • getKeysOrBuilderList

      List<? extends ComparisonJoinKeyOrBuilder> getKeysOrBuilderList()
       One or more keys to join on.  The relation is invalid if this is empty
 (unless the deprecated left_keys/right_keys fields are being used).

 If a custom comparison function is used then it must be consistent with
 the hash function used for the keys.

 In other words, the hash function must return the same hash code when the
 comparison returns true.  For example, if the comparison function is
 "equals ignoring case" then the hash function must return the same hash
 code for strings that differ only by case.  Note: the hash function is not
 specified here.  It is the responsibility of the consumer to find an appropriate
 hash function for a given comparsion function or to reject the plan if it cannot
 do so.
      repeated .substrait.ComparisonJoinKey keys = 8;

    • getKeysOrBuilder

      ComparisonJoinKeyOrBuilder getKeysOrBuilder(int index)
       One or more keys to join on.  The relation is invalid if this is empty
 (unless the deprecated left_keys/right_keys fields are being used).

 If a custom comparison function is used then it must be consistent with
 the hash function used for the keys.

 In other words, the hash function must return the same hash code when the
 comparison returns true.  For example, if the comparison function is
 "equals ignoring case" then the hash function must return the same hash
 code for strings that differ only by case.  Note: the hash function is not
 specified here.  It is the responsibility of the consumer to find an appropriate
 hash function for a given comparsion function or to reject the plan if it cannot
 do so.
      repeated .substrait.ComparisonJoinKey keys = 8;

    • hasPostJoinFilter

      boolean hasPostJoinFilter()
      .substrait.Expression post_join_filter = 6;
      Returns:
      Whether the postJoinFilter field is set.

    • getPostJoinFilter

      Expression getPostJoinFilter()
      .substrait.Expression post_join_filter = 6;
      Returns:
      The postJoinFilter.

    • getPostJoinFilterOrBuilder

      ExpressionOrBuilder getPostJoinFilterOrBuilder()
      .substrait.Expression post_join_filter = 6;

    • getTypeValue

      int getTypeValue()
      .substrait.HashJoinRel.JoinType type = 7;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      HashJoinRel.JoinType getType()
      .substrait.HashJoinRel.JoinType type = 7;
      Returns:
      The type.

    • getBuildInputValue

      int getBuildInputValue()
       Specifies which side of input to build the hash table for this hash join. Default is `BUILD_INPUT_RIGHT`.
      .substrait.HashJoinRel.BuildInput build_input = 9;
      Returns:
      The enum numeric value on the wire for buildInput.

    • getBuildInput

      HashJoinRel.BuildInput getBuildInput()
       Specifies which side of input to build the hash table for this hash join. Default is `BUILD_INPUT_RIGHT`.
      .substrait.HashJoinRel.BuildInput build_input = 9;
      Returns:
      The buildInput.

    • hasAdvancedExtension

      boolean hasAdvancedExtension()
      .substrait.extensions.AdvancedExtension advanced_extension = 10;
      Returns:
      Whether the advancedExtension field is set.

    • getAdvancedExtension

      AdvancedExtension getAdvancedExtension()
      .substrait.extensions.AdvancedExtension advanced_extension = 10;
      Returns:
      The advancedExtension.

    • getAdvancedExtensionOrBuilder

      AdvancedExtensionOrBuilder getAdvancedExtensionOrBuilder()
      .substrait.extensions.AdvancedExtension advanced_extension = 10;