athena

grafonnet.query.athena

Index

• fn withColumn(value)
• fn withConnectionArgs(value)
• fn withConnectionArgsMixin(value)
• fn withDatasource(value)
• fn withDatasourceMixin(value)
• fn withFormat(value)
• fn withHide(value=true)
• fn withQueryID(value)
• fn withQueryType(value)
• fn withRawSQL(value="")
• fn withRefId(value)
• fn withTable(value)
• obj connectionArgs
  • fn withCatalog(value="__default")
  • fn withDatabase(value="__default")
  • fn withRegion(value="__default")
  • fn withResultReuseEnabled(value=true)
  • fn withResultReuseMaxAgeInMinutes(value=60)
• obj datasource
  • fn withType(value)
  • fn withUid(value)

Fields

fn withColumn

withColumn(value)

PARAMETERS:

• value (string)

fn withConnectionArgs

withConnectionArgs(value)

PARAMETERS:

• value (object)

fn withConnectionArgsMixin

withConnectionArgsMixin(value)

PARAMETERS:

• value (object)

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 withFormat

withFormat(value)

PARAMETERS:

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

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 withQueryID

withQueryID(value)

PARAMETERS:

• value (string)

fn withQueryType

withQueryType(value)

PARAMETERS:

• value (string)

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

fn withRawSQL

withRawSQL(value="")

PARAMETERS:

• value (string)
  • default value: ""

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 withTable

withTable(value)

PARAMETERS:

• value (string)

obj connectionArgs

fn connectionArgs.withCatalog

connectionArgs.withCatalog(value="__default")

PARAMETERS:

• value (string)
  • default value: "__default"

fn connectionArgs.withDatabase

connectionArgs.withDatabase(value="__default")

PARAMETERS:

• value (string)
  • default value: "__default"

fn connectionArgs.withRegion

connectionArgs.withRegion(value="__default")

PARAMETERS:

• value (string)
  • default value: "__default"

fn connectionArgs.withResultReuseEnabled

connectionArgs.withResultReuseEnabled(value=true)

PARAMETERS:

• value (boolean)
  • default value: true

fn connectionArgs.withResultReuseMaxAgeInMinutes

connectionArgs.withResultReuseMaxAgeInMinutes(value=60)

PARAMETERS:

• value (number)
  • default value: 60

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