Skip to content

Commit b31a80f

Browse files
authored
Revert "Removed query instance data document"
1 parent 46486e4 commit b31a80f

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@
8181
* [Log In & Password Reset](administration/harperdb-studio/login-password-reset.md)
8282
* [Organizations](administration/harperdb-studio/organizations.md)
8383
* [Instances](administration/harperdb-studio/instances.md)
84+
* [Query Instance Data](administration/harperdb-studio/query-instance-data.md)
8485
* [Manage Databases / Browse Data](administration/harperdb-studio/manage-databases-browse-data.md)
8586
* [Manage Charts](administration/harperdb-studio/manage-charts.md)
8687
* [Manage Clustering](administration/harperdb-studio/manage-replication.md)
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Query Instance Data
2+
3+
SQL queries can be executed directly through the HarperDB Studio with the following instructions:
4+
5+
1) Navigate to the [HarperDB Studio Organizations](https://studio.harperdb.io/organizations) page.
6+
2) Click the appropriate organization that the instance belongs to.
7+
3) Select your desired instance.
8+
4) Click **query** in the instance control bar.
9+
5) Enter your SQL query in the SQL query window.
10+
6) Click **Execute**.
11+
12+
*Please note, the Studio will execute the query exactly as entered. For example, if you attempt to `SELECT *` from a table with millions of rows, you will most likely crash your browser.*
13+
14+
## Browse Query Results Set
15+
16+
#### Browse Results Set Data
17+
18+
The first page of results set data is automatically loaded on query execution. Paging controls are at the bottom of the table. Here you can:
19+
20+
* Page left and right using the arrows.
21+
* Type in the desired page.
22+
* Change the page size (the amount of records displayed in the table).
23+
24+
#### Refresh Results Set
25+
26+
Click the refresh icon at the top right of the results set table.
27+
28+
#### Automatically Refresh Results Set
29+
30+
Toggle the auto switch at the top right of the results set table. The results set will now automatically refresh every 15 seconds. Filters and pages will remain set for refreshed data.
31+
32+
## Query History
33+
34+
Query history is stored in your local browser cache. Executed queries are listed with the most recent at the top in the **query history** section.
35+
36+
37+
#### Rerun Previous Query
38+
39+
* Identify the query from the **query history** list.
40+
* Click the appropriate query. It will be loaded into the **sql query** input box.
41+
* Click **Execute**.
42+
43+
#### Clear Query History
44+
45+
Click the trash can icon at the top right of the **query history** section.
46+
47+
## Create Charts
48+
49+
The HarperDB Studio includes a charting feature where you can build charts based on your specified queries. Visit the Charts documentation for more information.

0 commit comments

Comments
 (0)