Update query history README (#7164)

* Update query history README

* Fix typos
This commit is contained in:
Charles Gagnon
2019-09-11 13:57:55 -07:00
committed by GitHub
parent 4270547147
commit b68fd91a02
5 changed files with 35 additions and 0 deletions

View File

@@ -158,6 +158,7 @@ const copyrightFilter = [
'!extensions/notebook/src/prompts/**',
'!extensions/mssql/src/prompts/**',
'!extensions/notebook/resources/jupyter_config/**',
'!extensions/query-history/images/**',
'!**/*.gif',
'!**/*.xlf',
'!**/*.dacpac',

View File

@@ -2,6 +2,40 @@
Adds a Query History panel for viewing and running past executed queries.
### How do I view the history?
Query History is displayed as a tab in the tab panel, which is toggled by the *View: Toggle Panel* command.
![Query History tab](https://github.com/microsoft/azuredatastudio/tree/master/extensions/query-history/images/QueryHistoryTab.png)
Initially this view will be empty but once you execute a query editor that will be captured in the window - with a separate row displayed for every query executed.
![Query History tab with queries](https://github.com/microsoft/azuredatastudio/tree/master/extensions/query-history/images/QueryHistoryTabWithQueries.png)
Each row consists of 3 parts :
1. Status icon : This will be a ✔️ if the query executed successfully. If any errors occurred a ❌is shown.
2. Query Text : This is the text of the query that was executed
3. Connection Info : The Server and Database the query was executed against
4. Timestamp : The date and time the query was executed
### Query History row actions
Right clicking on a history row will bring up a menu with a number of actions available.
![Query History action menu](https://github.com/microsoft/azuredatastudio/tree/master/extensions/query-history/images/QueryHistoryActionMenu.png)
#### Open Query
This will open a new query editor window populated with the query text from the query executed and using the connection of that query.
#### Run Query
This will do the same thing as Open Query but will additionally run the statement immediately.
#### Delete
This will permanently delete the row from the view.
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB