Packages

c

org.apache.spark.sql.catalyst.expressions

ExpressionDescription

class ExpressionDescription extends Annotation with Annotation with ClassfileAnnotation

Linear Supertypes
ClassfileAnnotation, StaticAnnotation, Annotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExpressionDescription
  2. ClassfileAnnotation
  3. StaticAnnotation
  4. Annotation
  5. Annotation
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExpressionDescription()

Abstract Value Members

  1. abstract def annotationType(): Class[_ <: Annotation]
    Definition Classes
    Annotation
  2. abstract def arguments(): String
    Annotations
    @AnnotationDefault()
  3. abstract def deprecated(): String
    Annotations
    @AnnotationDefault()
  4. abstract def examples(): String
    Annotations
    @AnnotationDefault()
  5. abstract def group(): String

    Valid group names are almost the same with one defined as groupname in sql/functions.scala.

    Valid group names are almost the same with one defined as groupname in sql/functions.scala. But, collection_funcs is split into fine-grained three groups: array_funcs, map_funcs, and json_funcs. See ExpressionInfo for the detailed group names.

    Annotations
    @AnnotationDefault()
  6. abstract def note(): String
    Annotations
    @AnnotationDefault()
  7. abstract def since(): String
    Annotations
    @AnnotationDefault()
  8. abstract def usage(): String

    ::DeveloperApi::

    ::DeveloperApi::

    A function description type which can be recognized by FunctionRegistry, and will be used to show the usage of the function in human language.

    usage() will be used for the function usage in brief way.

    These below are concatenated and used for the function usage in verbose way, suppose arguments, examples, note, group, since and deprecated will be provided.

    arguments() describes arguments for the expression.

    examples() describes examples for the expression.

    note() contains some notes for the expression optionally.

    group() describes the category that the expression belongs to. The valid value is "agg_funcs", "array_funcs", "datetime_funcs", "json_funcs", "map_funcs" and "window_funcs".

    since() contains version information for the expression. Version is specified by, for example, "2.2.0".

    deprecated() contains deprecation information for the expression optionally, for example, "Deprecated since 2.2.0. Use something else instead".

    The format, in particular for arguments(), examples(),note(), group(), since() and deprecated(), should strictly be as follows.

    @ExpressionDescription(
  ...
  arguments = """
    Arguments:
      * arg0 - ...
          ....
      * arg1 - ...
          ....
  """,
  examples = """
    Examples:
      > SELECT ...;
       ...
      > SELECT ...;
       ...
  """,
  note = """
    ...
  """,
  group = "agg_funcs",
  since = "3.0.0",
  deprecated = """
    ...
  """)

    We can refer the function name by _FUNC_, in usage(), arguments(), examples() and note() as it is registered in FunctionRegistry.

    Note that, if extended() is defined, arguments(), examples(), note(), group(), since() and deprecated() should be not defined together. extended() exists for backward compatibility.

    Note this contents are used in the SparkSQL documentation for built-in functions. The contents here are considered as a Markdown text and then rendered.

    Annotations
    @AnnotationDefault()
  9. abstract def extended(): String

    Annotations
    @AnnotationDefault()
    Deprecated

    This field is deprecated as of Spark 3.0. Use #arguments, #examples, #note, #since and #deprecated instead to document the extended usage.

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

Inherited from ClassfileAnnotation

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped