Query Information
query_info
The query info object holds information related to data access within a datastore. To access, manipulate, delete, or retrieve data from a datastore, a query must be written using a specific syntax.
Contents
Attributes
Caption | Name | Type | Is Array | Default | Description |
---|---|---|---|---|---|
Total Bytes | bytes | Long | The size of the data returned from the query. | ||
Data | data | JSON | The data returned from the query execution. | ||
Name | name | String | The query name for a saved or scheduled query. | ||
Query String | query_string | String |
A string representing the query code being run. For example: SELECT * FROM my_table
|
||
Query Time | query_time | Timestamp | The time when the query was run. | ||
Raw Data | raw_data | JSON | The event data as received from the event source. | ||
Record ID | record_id | String | Unique identifier for the object | ||
Unique ID | uid | String | The unique identifier of the query. | ||
Unmapped Data | unmapped | Unmapped | The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source. |
References
Context
JSON
{
"caption": "Query Information",
"description": "The query info object holds information related to data access within a datastore. To access, manipulate, delete, or retrieve data from a datastore, a query must be written using a specific syntax.",
"extends": "_entity",
"name": "query_info",
"attributes": {
"query_time": {
"description": "The time when the query was run.",
"requirement": "optional",
"caption": "Query Time",
"type": "timestamp_t"
},
"query_string": {
"caption": "Query String",
"description": "A string representing the query code being run. For example: <code>SELECT * FROM my_table</code>",
"requirement": "required",
"type": "string_t"
},
"data": {
"description": "The data returned from the query execution.",
"requirement": "optional",
"caption": "Data",
"type": "json_t"
},
"bytes": {
"description": "The size of the data returned from the query.",
"requirement": "optional",
"caption": "Total Bytes",
"type": "long_t"
},
"name": {
"description": "The query name for a saved or scheduled query.",
"requirement": "recommended",
"caption": "Name",
"type": "string_t"
},
"uid": {
"description": "The unique identifier of the query.",
"requirement": "recommended",
"caption": "Unique ID",
"type": "string_t"
},
"raw_data": {
"group": "context",
"caption": "Raw Data",
"description": "The event data as received from the event source.",
"type": "json_t"
},
"record_id": {
"description": "Unique identifier for the object",
"group": "primary",
"requirement": "required",
"caption": "Record ID",
"type": "string_t"
},
"unmapped": {
"caption": "Unmapped Data",
"description": "The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.",
"type": "unmapped",
"is_array": true
}
},
"constraints": {
"at_least_one": [
"name",
"uid"
]
}
}