Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package spotify
    Definition Classes
    com
  • package scio
    Definition Classes
    spotify
  • package bigquery

    Main package for BigQuery APIs.

    Main package for BigQuery APIs. Import all.

    import com.spotify.scio.bigquery._

    There are two BigQuery dialects, legacy and standard. APIs that take a BigQuery query string as argument, e.g. com.spotify.scio.bigquery.client.BigQuery.query.rows, com.spotify.scio.bigquery.client.BigQuery.query.schema, com.spotify.scio.bigquery.client.BigQuery.getTypedRows and BigQueryType.fromQuery, automatically detects the query's dialect. To override this, start the query with either #legacysql or #standardsql comment line.

    Definition Classes
    scio
  • package types
    Definition Classes
    bigquery
  • object BigQueryType

    Macro annotations and converter generators for BigQuery types.

    Macro annotations and converter generators for BigQuery types.

    The following table lists each legacy SQL data type, its standard SQL equivalent and Scala type.

    Legacy SQL

    Standard SQL

    Scala type

    BOOLEAN

    BOOL

    Boolean

    INTEGER

    INT64

    Long, Int

    FLOAT

    FLOAT64

    Double, Float

    STRING

    STRING

    String

    NUMERIC

    NUMERIC

    BigDecimal

    BYTES

    BYTES

    com.google.protobuf.ByteString, Array[Byte]

    RECORD

    STRUCT

    Nested case class

    REPEATED

    ARRAY

    List[T]

    TIMESTAMP

    TIMESTAMP

    org.joda.time.Instant

    DATE

    DATE

    org.joda.time.LocalDate

    TIME

    TIME

    org.joda.time.LocalTime

    DATETIME

    DATETIME

    org.joda.time.LocalDateTime

    Definition Classes
    types
    Annotations
    @deprecated
    Deprecated

    (Since version 0.15.0) Use magnolify API instead.

  • HasAnnotation
  • HasQuery
  • HasSchema
  • HasStorageOptions
  • HasTable
  • HasTableDescription
  • Query
  • StorageOptions
  • Table
  • fromQuery
  • fromSchema
  • fromStorage
  • fromTable
  • toTable

macro class fromTable extends Annotation with StaticAnnotation

Macro annotation for a BigQuery table.

Generate case classes for a BigQuery table. Note that tableSpec must be a string literal in the form of project:dataset.table with optional .stripMargin at the end. For example:

@BigQueryType.fromTable("project:dataset.table") class MyRecord

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

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

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

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

Also generate a companion object with convenience methods.

Annotations
@compileTimeOnly("enable macro paradise (2.12) or -Ymacro-annotations (2.13) to expand macro annotations") @deprecated
Deprecated

(Since version 0.15.0) Use magnolify API instead.

Source
BigQueryType.scala
Linear Supertypes
StaticAnnotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. fromTable
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new fromTable(tableSpec: String, args: String*)

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]) @HotSpotIntrinsicCandidate() @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
    @HotSpotIntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. macro def macroTransform(annottees: Any*): Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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 StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Other Members