Module com.darkcollective.relix.ast
Package com.darkcollective.relix.ast

Record Class UsingJoinNode

java.lang.Object
java.lang.Record
com.darkcollective.relix.ast.UsingJoinNode
Record Components:
kind - which rows an unmatched side keeps; never null
left - the left input relation; never null
right - the right input relation; never null
columns - the shared columns to match on; at least one, no name twice
location - the source location of this node; never null
All Implemented Interfaces:
RelNode
public record UsingJoinNode(UsingJoinNode.Kind kind, RelNode left, RelNode right, List<String> columns, SourceLocation location) extends Record implements RelNode
A join on named shared columns — SQL's JOIN … USING (a, b) — in its inner, left, right and full forms.

Rows match where every named column is equal on both sides, as an equality condition on each would have it, so a NULL matches nothing. The output carries each named column once, first and in the order named: the left row's value for an inner or left join, the right row's for a right join, and whichever side is present for a full join, as SQL's COALESCE of the two. Then come the left input's other columns and the right input's other columns, a right column whose name the left already uses taking the _r suffix every join gives it.

Unlike the natural join, which matches on every column the two inputs share, only the named columns are matched; any other shared column stays twice.

Example: Orders ⟕ USING (customer_id) Customers, or in SQL's order, Orders LJOIN Customers USING (customer_id).

  • Constructor Details

  • Method Details

    • accept

      public <R> R accept(RelNodeVisitor<R> visitor)
      Specified by:
      accept in interface RelNode

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • kind

      public UsingJoinNode.Kind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • left

      public RelNode left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • right

      public RelNode right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component

    • columns

      public List<String> columns()
      Returns the value of the columns record component.
      Returns:
      the value of the columns record component

    • location

      public SourceLocation location()
      Returns the value of the location record component.
      Specified by:
      location in interface RelNode
      Returns:
      the value of the location record component