Skip to content

DataqueryBuilder🔗

Constructor🔗

new DataqueryBuilder()

Methods🔗

build🔗

Builds the object.

build()

alias🔗

alias(alias: string)

channel🔗

channel(channel: string)

csvContent🔗

csvContent(csvContent: string)

csvFileName🔗

csvFileName(csvFileName: string)

csvWave🔗

csvWave(csvWave: cog.Builder<testdata.CSVWave>[])

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

datasource(datasource: any)

dropPercent🔗

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

dropPercent(dropPercent: number)

errorType🔗

errorType(errorType: "server_panic" | "frontend_exception" | "frontend_observable")

flamegraphDiff🔗

flamegraphDiff(flamegraphDiff: boolean)

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)

hide(hide: boolean)

labels🔗

labels(labels: string)

levelColumn🔗

levelColumn(levelColumn: boolean)

lines🔗

lines(lines: number)

nodes🔗

nodes(nodes: cog.Builder<testdata.NodesQuery>)

points🔗

points(points: (string | number)[][])

pulseWave🔗

pulseWave(pulseWave: cog.Builder<testdata.PulseWaveQuery>)

queryType🔗

Specify the query flavor

TODO make this required and give it a default

queryType(queryType: string)

rawFrameContent🔗

rawFrameContent(rawFrameContent: string)

refId🔗

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.

refId(refId: string)

scenarioId🔗

scenarioId(scenarioId: testdata.TestDataQueryType)

seriesCount🔗

seriesCount(seriesCount: number)

sim🔗

sim(sim: cog.Builder<testdata.SimulationQuery>)

spanCount🔗

spanCount(spanCount: number)

stream🔗

stream(stream: cog.Builder<testdata.StreamingQuery>)

stringInput🔗

stringInput(stringInput: string)

usa🔗

usa(usa: cog.Builder<testdata.USAQuery>)

See also🔗