Skip to content

Dataquery🔗

Constructor🔗

Dataquery()

Methods🔗

build🔗

Builds the object.

def build() -> athena.Dataquery

column🔗

def column(column: str) -> typing.Self

connection_args🔗

def connection_args(connection_args: cogbuilder.Builder[athena.ConnectionArgs]) -> typing.Self

datasource🔗

For mixed data sources the selected datasource is on the query level.

For non mixed scenarios this is undefined.

TODO find a better way to do this ^ that's friendly to schema

TODO this shouldn't be unknown but DataSourceRef | null

def datasource(datasource: dashboard.DataSourceRef) -> typing.Self

format_val🔗

def format_val(format_val: athena.FormatOptions) -> typing.Self

hide🔗

true if query is disabled (ie should not be returned to the dashboard)

Note this does not always imply that the query should not be executed since

the results from a hidden query may be used as the input to other queries (SSE etc)

def hide(hide: bool) -> typing.Self

query_id🔗

def query_id(query_id: str) -> typing.Self

query_type🔗

Specify the query flavor

TODO make this required and give it a default

def query_type(query_type: str) -> typing.Self

raw_sql🔗

def raw_sql(raw_sql: str) -> typing.Self

ref_id🔗

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.

def ref_id(ref_id: str) -> typing.Self

table🔗

def table(table: str) -> typing.Self

See also🔗