Dataquery🔗
Manually converted from https://github.com/grafana/athena-datasource/blob/57ad707147b7a11e9a521a836d6bf9799877e0e3/src/types.ts
Definition🔗
class Dataquery implements \JsonSerializable, \Grafana\Foundation\Cog\Dataquery
{
public \Grafana\Foundation\Athena\FormatOptions $format;
public \Grafana\Foundation\Athena\ConnectionArgs $connectionArgs;
public ?string $table;
public ?string $column;
public ?string $queryID;
/**
* 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.
*/
public string $refId;
/**
* If hide is set to true, Grafana will filter out the response(s) associated with this query before returning it to the panel.
*/
public ?bool $hide;
/**
* Specify the query flavor
* TODO make this required and give it a default
*/
public ?string $queryType;
public string $rawSQL;
/**
* 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
*/
public ?\Grafana\Foundation\Dashboard\DataSourceRef $datasource;
}
Methods🔗
fromArray🔗
Builds this object from an array.
This function is meant to be used with the return value of json_decode($json, true).
jsonSerialize🔗
Returns the data representing this object, preparing it for JSON serialization with json_encode().
dataqueryType🔗
Returns the type of this dataquery object.