Packages

c

org.apache.spark.sql.jdbc

JdbcSQLQueryBuilder

class JdbcSQLQueryBuilder extends AnyRef

The builder to build a single SELECT query.

Note: All the withXXX methods will be invoked at most once. The invocation order does not matter, as all these clauses follow the natural SQL order: sample the table first, then filter, then group by, then sort, then offset, then limit.

Source
JdbcSQLQueryBuilder.scala
Since

3.5.0

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

Instance Constructors

  1. new JdbcSQLQueryBuilder(dialect: JdbcDialect, options: JDBCOptions)

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 build(): String

    Build the final SQL query that following dialect's SQL syntax.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. var columnList: String

    columns, but as a String suitable for injection into a SQL query.

    columns, but as a String suitable for injection into a SQL query.

    Attributes
    protected
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. var groupByClause: String

    A GROUP BY clause representing pushed-down grouping columns.

    A GROUP BY clause representing pushed-down grouping columns.

    Attributes
    protected
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. val hintClause: String

    A hint clause representing query hints.

    A hint clause representing query hints.

    Attributes
    protected
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. var limit: Int

    A LIMIT value representing pushed-down limit.

    A LIMIT value representing pushed-down limit.

    Attributes
    protected
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. var offset: Int

    A OFFSET value representing pushed-down offset.

    A OFFSET value representing pushed-down offset.

    Attributes
    protected
  20. var orderByClause: String

    A ORDER BY clause representing pushed-down sort of top n.

    A ORDER BY clause representing pushed-down sort of top n.

    Attributes
    protected
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def tableOrQuery: String
    Attributes
    protected
  23. var tableSampleClause: String

    A table sample clause representing pushed-down table sample.

    A table sample clause representing pushed-down table sample.

    Attributes
    protected
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. var whereClause: String

    A WHERE clause representing both filters, if any, and the current partition.

    A WHERE clause representing both filters, if any, and the current partition.

    Attributes
    protected
  29. def withAliasedColumns(columns: Array[String], aliases: Array[Option[String]]): JdbcSQLQueryBuilder
  30. def withColumns(columns: Array[String]): JdbcSQLQueryBuilder

    The columns names that following dialect's SQL syntax.

    The columns names that following dialect's SQL syntax. e.g. The column name is the raw name or quoted name.

  31. def withGroupByColumns(groupByColumns: Array[String]): JdbcSQLQueryBuilder

    Constructs the GROUP BY clause that following dialect's SQL syntax.

  32. def withJoin(left: JdbcSQLQueryBuilder, right: JdbcSQLQueryBuilder, leftSideQualifier: String, rightSideQualifier: String, columns: Array[String], joinType: String, joinCondition: String): JdbcSQLQueryBuilder
  33. def withLimit(limit: Int): JdbcSQLQueryBuilder

    Saves the limit value used to construct LIMIT clause.

  34. def withOffset(offset: Int): JdbcSQLQueryBuilder

    Saves the offset value used to construct OFFSET clause.

  35. def withPredicates(predicates: Array[Predicate], part: JDBCPartition): JdbcSQLQueryBuilder

    Constructs the WHERE clause that following dialect's SQL syntax.

  36. def withSortOrders(sortOrders: Array[String]): JdbcSQLQueryBuilder

    Constructs the ORDER BY clause that following dialect's SQL syntax.

  37. def withTableSample(sample: TableSampleInfo): JdbcSQLQueryBuilder

    Constructs the table sample clause that following dialect's SQL syntax.

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 AnyRef

Inherited from Any

Ungrouped