Type Members

1.  trait HasAnnotation extends AnyRef

   Trait for case classes with generated companion objects.

2.  trait HasQuery extends AnyRef

   Trait for companion objects of case classes generated with SELECT query.

3.  trait HasSchema[T] extends AnyRef

   Trait for companion objects of case classes generated with schema.

4.  trait HasStorageOptions extends AnyRef

   Trait for companion objects of case classes generated with storage API.

5.  trait HasTable extends AnyRef

   Trait for companion objects of case classes generated with table.

6.  trait HasTableDescription extends AnyRef

   Trait for companion objects of case classes generated with table description.

7.  trait Query[T] extends HasQuery

   Trait for companion objects of case classes generated with query.

   Trait for companion objects of case classes generated with query. Instance of this trait are provided as implicits allowing static discovery. That trait provide evidence that a BQ query is statically known for a given type T.

8.  trait StorageOptions[T] extends HasStorageOptions

   Trait for companion objects of case classes generated with storage API.

   Trait for companion objects of case classes generated with storage API. Instance of this trait are provided as implicits allowing static discovery. That trait provide evidence that a BQ table is statically known for a given type T.

9.  trait Table[T] extends HasTable

   Trait for companion objects of case classes generated with table.

   Trait for companion objects of case classes generated with table. Instance of this trait are provided as implicits allowing static discovery. That trait provide evidence that a BQ table is statically known for a given type T.

10.  macro class fromQuery extends Annotation with StaticAnnotation

    Macro annotation for a BigQuery SELECT query.

    Macro annotation for a BigQuery SELECT query.

    Generate case classes for a BigQuery SELECT query. Note that query must be a string literal of the SELECT query with optional .stripMargin at the end. For example:

    @BigQueryType.fromQuery("SELECT field1, field2 FROM [project:dataset.table]")

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

    @BigQueryType.fromQuery("SELECT field1, field2 FROM [%s]", "table")

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

    @BigQueryType.fromQuery(
      "SELECT field1, field2 FROM [project:d1.t1_%s] JOIN [project:d2.t2_%s] USING field3",
      "$LATEST", "$LATEST")

    Also generate a companion object with convenience methods.

    Both Legacy SQL and Standard SQL dialects are supported. By default the query dialect will be automatically detected. To override this behavior, start the query string with #legacysql or #standardsql.

    Annotations

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

11.  macro class fromSchema extends Annotation with StaticAnnotation

    Macro annotation for a BigQuery schema.

    Macro annotation for a BigQuery schema.

    Generate case classes for a BigQuery schema. Note that schema must be a string literal of the JSON schema with optional .stripMargin at the end. For example:

    @BigQueryType.fromSchema(
      """
        |{
        |  "fields": [
        |    {"mode": "REQUIRED", "name": "f1", "type": "INTEGER"},
        |    {"mode": "REQUIRED", "name": "f2", "type": "FLOAT"},
        |    {"mode": "REQUIRED", "name": "f3", "type": "STRING"},
        |    {"mode": "REQUIRED", "name": "f4", "type": "TIMESTAMP"}
        |  ]
        |}
      """.stripMargin) class MyRecord

    Also generate a companion object with convenience methods.

    Annotations

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

12.  macro class fromStorage extends Annotation with StaticAnnotation

    Macro annotation for a BigQuery table using the storage API.

    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

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

13.  macro class fromTable extends Annotation with StaticAnnotation

    Macro annotation for a BigQuery table.

    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

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

14.  macro class toTable extends Annotation with StaticAnnotation

    Macro annotation for case classes to be saved to a BigQuery table.

    Macro annotation for case classes to be saved to a BigQuery table.

    Note that this annotation does not generate case classes, only a companion object with convenience methods. You need to define a complete case class for as output record. For example:

    @BigQueryType.toTable
    case class Result(name: String, score: Double)

    Annotations

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