Skip to content

Commit deb3df1

Browse files
authored
docs: API type in Query History (#7650)
1 parent acd6f78 commit deb3df1

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

docs/pages/product/workspace/query-history.mdx

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,12 @@ while <Btn>Top Queries</Btn> will show the most-frequently executed queries:
6767

6868
### Filtering
6969

70-
You can also use filters to find problematic queries; you can filter by query
71-
duration, cache status, whether the query was accelerated, and by failing
72-
queries:
70+
You can use filters to find queries by various criteria:
71+
- duration,
72+
- cache status,
73+
- whether the query was accelerated with pre-aggregations,
74+
- whether the query yielded an error,
75+
- API type.
7376

7477
<Screenshot
7578
highlight="inset(36% 22% 58% 7% round 10px)"
@@ -78,20 +81,24 @@ queries:
7881

7982
## Inspecting API Queries
8083

81-
To see an expanded view of a query, click on <Btn>❯</Btn> next to any query:
84+
In the table, all queries are shown in their collapsed view by default.
85+
To see an expanded view of a query, click on the&nbsp;<Btn>❯</Btn> button
86+
to the left of any query.
8287

8388
<Screenshot
84-
highlight="inset(-1% 87% -1% 9% round 10px)"
85-
src="https://ucarecdn.com/7ec40dc3-813d-4e3e-881b-dc01a6fdfb50/"
89+
src="https://ucarecdn.com/fe755749-9eff-4b58-b7b0-c79de2510499/"
90+
highlight="inset(35% 2% 0 17.5%)"
8691
/>
8792

88-
This will show us how long the query took, whether the query was accelerated,
89-
and even view the raw query by clicking <Btn>❮/❯</Btn>:
90-
91-
<Screenshot
92-
highlight="inset(1% 2% 93% 68% round 10px)"
93-
src="https://ucarecdn.com/e3c00115-49f9-48a6-8f2b-949c53523c9f/"
94-
/>
93+
Check the columns to see the details:
94+
- **Query** shows a representation of a query, similar to the REST API
95+
[query format][ref-query-format]. In case of the SQL API, if the query is
96+
not coercible to a REST API query, raw SQL is shown "as is."
97+
- **API** shows the API type that was used to run the query: REST API via
98+
HTTP transport, REST API via WebSockets, GraphQL API, or SQL API.
99+
- **Duration** shows how long the query took, and the **bolt** indicates
100+
whether the query was accelerated with pre-aggregations, in-memory cache, etc.
101+
- **Time** shows the time the query was run at.
95102

96103
To drill down on a specific query, click it to see more information.
97104

@@ -198,3 +205,4 @@ while the query is in the query execution queue:
198205
[ref-deployment-api-instance]: /product/deployment#api-instances
199206
[ref-deployment-refresh-worker]: /product/deployment#refresh-worker
200207
[ref-workspace-sqlrunner]: /product/workspace/sql-runner
208+
[ref-query-format]: /product/apis-integrations/rest-api/query-format

0 commit comments

Comments
 (0)