Skip to content

Dataquery🔗

Constructor🔗

Dataquery()

Methods🔗

build🔗

Builds the object.

def build() -> testdata.Dataquery

alias🔗

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

channel🔗

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

csv_content🔗

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

csv_file_name🔗

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

csv_wave🔗

def csv_wave(csv_wave: list[cogbuilder.Builder[testdata.CSVWave]]) -> 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: object) -> typing.Self

drop_percent🔗

Drop percentage (the chance we will lose a point 0-100)

def drop_percent(drop_percent: float) -> typing.Self

error_type🔗

def error_type(error_type: typing.Literal["server_panic", "frontend_exception", "frontend_observable"]) -> typing.Self

flamegraph_diff🔗

def flamegraph_diff(flamegraph_diff: bool) -> 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

labels🔗

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

level_column🔗

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

lines🔗

def lines(lines: int) -> typing.Self

nodes🔗

def nodes(nodes: cogbuilder.Builder[testdata.NodesQuery]) -> typing.Self

points🔗

def points(points: list[list[typing.Union[str, int]]]) -> typing.Self

pulse_wave🔗

def pulse_wave(pulse_wave: cogbuilder.Builder[testdata.PulseWaveQuery]) -> 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_frame_content🔗

def raw_frame_content(raw_frame_content: 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

scenario_id🔗

def scenario_id(scenario_id: testdata.TestDataQueryType) -> typing.Self

series_count🔗

def series_count(series_count: int) -> typing.Self

sim🔗

def sim(sim: cogbuilder.Builder[testdata.SimulationQuery]) -> typing.Self

span_count🔗

def span_count(span_count: int) -> typing.Self

stream🔗

def stream(stream: cogbuilder.Builder[testdata.StreamingQuery]) -> typing.Self

string_input🔗

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

usa🔗

def usa(usa: cogbuilder.Builder[testdata.USAQuery]) -> typing.Self

See also🔗