Class

com.spotify.scio.bigquery.types.BigQueryType

fromStorage

Related Doc: package BigQueryType

Permalink

macro class fromStorage extends Annotation with StaticAnnotation

Macro annotation for a BigQuery table using the storage API.

Generate case classes for BigQuery storage API, including column projection and filtering. Note that tableSpec must be a string literal in the form of project:dataset.table with optional .stripMargin at the end. For example:

@BigQueryType.fromStorage("project:dataset.table") class MyRecord
Annotations
@compileTimeOnly( ... )
Linear Supertypes
StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. fromStorage
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new fromStorage(tableSpec: String, args: List[Any] = Nil, selectedFields: List[String] = Nil, rowRestriction: String = null)

    Permalink

    selectedFields

    names of the fields in the table that should be read. If empty, all fields will be read. If the specified field is a nested field, all the sub-fields in the field will be selected.

    rowRestriction

    SQL text filtering statement, similar ti a WHERE clause in a query. Currently, we support combinations of predicates that are a comparison between a column and a constant value in SQL statement. Aggregates are not supported. For example:

    "a > DATE '2014-09-27' AND (b > 5 AND c LIKE 'date')"

    String formatting syntax can be used in tableSpec when additional args are supplied. For example:

    @BigQueryType.fromStorage("project:dataset.%s", "table")

    "$LATEST" can be used as a placeholder for table partitions. The latest partition available will be used. For example:

    @BigQueryType.fromStorage("project:dataset.table_%s", "$LATEST")

    Also generate a companion object with convenience methods.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. macro def macroTransform(annottees: Any*): Any

    Permalink

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Other Members