Packages

c

scalaql.syntax

DescribeSyntax

final class DescribeSyntax[In, Out] extends Serializable

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

Instance Constructors

  1. new DescribeSyntax(self: Query[In, Out])(implicit arg0: Describe[Out])

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]) @native()
  6. def describe(precision: MathContext = MathContext.DECIMAL32, unique: Boolean = false): Query[In, RowDescription]

    Describes the given query output by providing useful statistics, such as average values, means, percentiles for each column.

    Describes the given query output by providing useful statistics, such as average values, means, percentiles for each column.

    Example:

    select[Student]
      .describe()
      .show(truncate=false)
      .run(
        from(students)
      )
    
    // +--------------+-----+-----+---------+----------+------------+------------+------------+----------+------+
    // |field         |count|mean |std      |min       |percentile25|percentile75|percentile90|max       |unique|
    // +--------------+-----+-----+---------+----------+------------+------------+------------+----------+------+
    // |birthDay      |5    |null |null     |1977-10-01|null        |null        |null        |1980-07-31|[]    |
    // |grade         |5    |85.22|10.88474 |66.2      |85.1        |90.1        |99.6        |99.6      |[]    |
    // |name          |5    |null |null     |null      |null        |null        |null        |null      |[]    |
    // |specialization|5    |null |null     |null      |null        |null        |null        |null      |[]    |
    // |age           |5    |18.0 |0.6324555|17.0      |18.0        |18.0        |19.0        |19.0      |[]    |
    // |faculty       |5    |null |null     |null      |null        |null        |null        |null      |[]    |
    // +--------------+-----+-----+---------+----------+------------+------------+------------+----------+------+
    //

    Based on original idea of Pandas authors.

    precision

    decimal precision to use for computing statistics

    unique

    collect unique values or not

    returns

    a Query producing statistics of each output value of this query.

    See also

    DataFrame.describe

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped