bigquery

grafonnet.query.bigquery

Subpackages

• sql.columns
• sql.groupBy

Index

• fn withConvertToUTC(value=true)
• fn withDataset(value)
• fn withDatasource(value)
• fn withDatasourceMixin(value)
• fn withEditorMode(value)
• fn withFormat(value)
• fn withHide(value=true)
• fn withLocation(value)
• fn withPartitioned(value=true)
• fn withPartitionedField(value)
• fn withProject(value)
• fn withQueryPriority(value)
• fn withQueryType(value)
• fn withRawQuery(value=true)
• fn withRawSql(value)
• fn withRefId(value)
• fn withSharded(value=true)
• fn withSql(value)
• fn withSqlMixin(value)
• fn withTable(value)
• fn withTimeShift(value)
• obj datasource
  • fn withType(value)
  • fn withUid(value)
• obj sql
  • fn withColumns(value)
  • fn withColumnsMixin(value)
  • fn withFrom(value)
  • fn withGroupBy(value)
  • fn withGroupByMixin(value)
  • fn withLimit(value)
  • fn withOffset(value)
  • fn withOrderBy(value)
  • fn withOrderByDirection(value)
  • fn withOrderByMixin(value)
  • fn withWhereString(value)
  • obj orderBy
    • fn withProperty(value)
    • fn withPropertyMixin(value)
    • fn withType()
    • obj property
      • fn withName(value)
      • fn withType(value)

Fields

fn withConvertToUTC

withConvertToUTC(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn withDataset

withDataset(value)

PARAMETERS:

• value (string)

fn withDatasource

withDatasource(value)

PARAMETERS:

• value (object)

Ref to a DataSource instance

fn withDatasourceMixin

withDatasourceMixin(value)

PARAMETERS:

• value (object)

Ref to a DataSource instance

fn withEditorMode

withEditorMode(value)

PARAMETERS:

• value (string)
  • valid values: "code", "builder"

fn withFormat

withFormat(value)

PARAMETERS:

• value (string)
  • valid values: 0, 1

fn withHide

withHide(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.

fn withLocation

withLocation(value)

PARAMETERS:

• value (string)

fn withPartitioned

withPartitioned(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn withPartitionedField

withPartitionedField(value)

PARAMETERS:

• value (string)

fn withProject

withProject(value)

PARAMETERS:

• value (string)

fn withQueryPriority

withQueryPriority(value)

PARAMETERS:

• value (string)
  • valid values: "INTERACTIVE", "BATCH"

fn withQueryType

withQueryType(value)

PARAMETERS:

• value (string)

Specify the query flavor TODO make this required and give it a default

fn withRawQuery

withRawQuery(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn withRawSql

withRawSql(value)

PARAMETERS:

• value (string)

fn withRefId

withRefId(value)

PARAMETERS:

• value (string)

A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful.

fn withSharded

withSharded(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn withSql

withSql(value)

PARAMETERS:

• value (object)

fn withSqlMixin

withSqlMixin(value)

PARAMETERS:

• value (object)

fn withTable

withTable(value)

PARAMETERS:

• value (string)

fn withTimeShift

withTimeShift(value)

PARAMETERS:

• value (string)

obj datasource

fn datasource.withType

datasource.withType(value)

PARAMETERS:

• value (string)

The plugin type-id

fn datasource.withUid

datasource.withUid(value)

PARAMETERS:

• value (string)

Specific datasource instance

obj sql

fn sql.withColumns

sql.withColumns(value)

PARAMETERS:

• value (array)

fn sql.withColumnsMixin

sql.withColumnsMixin(value)

PARAMETERS:

• value (array)

fn sql.withFrom

sql.withFrom(value)

PARAMETERS:

• value (string)

fn sql.withGroupBy

sql.withGroupBy(value)

PARAMETERS:

• value (array)

fn sql.withGroupByMixin

sql.withGroupByMixin(value)

PARAMETERS:

• value (array)

fn sql.withLimit

sql.withLimit(value)

PARAMETERS:

• value (integer)

fn sql.withOffset

sql.withOffset(value)

PARAMETERS:

• value (integer)

fn sql.withOrderBy

sql.withOrderBy(value)

PARAMETERS:

• value (object)

fn sql.withOrderByDirection

sql.withOrderByDirection(value)

PARAMETERS:

• value (string)
  • valid values: "ASC", "DESC"

fn sql.withOrderByMixin

sql.withOrderByMixin(value)

PARAMETERS:

• value (object)

fn sql.withWhereString

sql.withWhereString(value)

PARAMETERS:

• value (string)

whereJsonTree?: _

obj sql.orderBy

fn sql.orderBy.withProperty

sql.orderBy.withProperty(value)

PARAMETERS:

• value (object)

fn sql.orderBy.withPropertyMixin

sql.orderBy.withPropertyMixin(value)

PARAMETERS:

• value (object)

fn sql.orderBy.withType

sql.orderBy.withType()

obj sql.orderBy.property

fn sql.orderBy.property.withName

sql.orderBy.property.withName(value)

PARAMETERS:

• value (string)

fn sql.orderBy.property.withType

sql.orderBy.property.withType(value)

PARAMETERS:

• value (string)
  • valid values: "string"