Packages

t

org.apache.spark.sql.connector.read

SupportsPushDownJoin

trait SupportsPushDownJoin extends ScanBuilder

A mix-in interface for ScanBuilder. Data sources can implement this interface to push down join operators.

Annotations
@Evolving()
Source
SupportsPushDownJoin.java
Since

4.1.0

Linear Supertypes
ScanBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SupportsPushDownJoin
  2. ScanBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def build(): Scan
    Definition Classes
    ScanBuilder
  2. abstract def isOtherSideCompatibleForJoin(other: SupportsPushDownJoin): Boolean

    Returns true if the other side of the join is compatible with the current SupportsPushDownJoin for a join push down, meaning both sides can be processed together within the same underlying data source.

    Returns true if the other side of the join is compatible with the current SupportsPushDownJoin for a join push down, meaning both sides can be processed together within the same underlying data source.

    For example, JDBC connectors are compatible if they use the same host, port, username, and password.

  3. abstract def pushDownJoin(other: SupportsPushDownJoin, joinType: JoinType, leftSideRequiredColumnsWithAliases: Array[ColumnWithAlias], rightSideRequiredColumnsWithAliases: Array[ColumnWithAlias], condition: Predicate): Boolean

    Pushes down the join of the current SupportsPushDownJoin and the other side of join SupportsPushDownJoin.

    Pushes down the join of the current SupportsPushDownJoin and the other side of join SupportsPushDownJoin.

    other

    SupportsPushDownJoin that this SupportsPushDownJoin gets joined with.

    joinType

    the type of join.

    leftSideRequiredColumnsWithAliases

    required output of the left side SupportsPushDownJoin

    rightSideRequiredColumnsWithAliases

    required output of the right side SupportsPushDownJoin

    condition

    join condition. Columns are named after the specified aliases in leftSideRequiredColumnWithAliases and rightSideRequiredColumnWithAliases

    returns

    True if join has been successfully pushed down.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from ScanBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped