Saved queries docs (#43731) (#44686)

* Adds saved query docs to search section

* Adds Saved Queries docs to Discover search

* Makes changes requested by PR review

* Changes 'visualizations and dashboards' to 'Visualize and Dashboard', adds x-pack label back to Read only access section

* Changes some text

* Changes Saving searches section

* Rewords saved queries section

* Changes 'Saved search' to 'saved search', tweeks a few words

* Removes second sentence from intro to saved queries

* Changes save button text reference

* Updates screen shots

* Moves images around, adds a hover instruction to delete a query and adds a screen shot of the delete button

* Makes changes as requested
This commit is contained in:
Christiane (Tina) Heiligers 2019-09-03 11:52:25 -07:00 committed by GitHub
parent 76cb3098c3
commit 63bfbc3e0b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 76 additions and 4 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 143 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

View file

@ -55,10 +55,10 @@ query language you can also submit queries using the {ref}/query-dsl.html[Elasti
[[save-open-search]]
=== Saving and Opening Searches
Saving searches enables you to reload them into Discover and use them as the basis
for <<visualize, visualizations>>. Saving a search saves both the search query string
and the currently selected index pattern.
=== Saving searches
A saved search persists your current view of Discover for later retrieval and reuse. You can reload a saved search into Discover, add it to a dashboard, and use it as the basis for a <<visualize, visualization>>.
A saved search includes the query text, filters, and optionally, the time filter. A saved search also includes the selected columns in the document table, the sort order, and the current index pattern.
[role="xpack"]
[[discover-read-only-access]]
@ -88,6 +88,78 @@ If the saved search is associated with a different index pattern than is current
selected, opening the saved search changes the selected index pattern. The query language
used for the saved search will also be automatically selected.
[[save-load-delete-query]]
=== Saving queries
A saved query is a portable collection of query text and filters that you can reuse in <<discover, Discover>>, <<visualize, Visualize>>, and <<dashboard, Dashboard>>. Save a query when you want to:
* Retrieve results from the same query at a later time without having to reenter the query text, add the filters or set the time filter
* View the results of the same query in multiple apps
* Share your query
Saved queries don't include information specific to Discover, such as the currently selected columns in the document table, the sort order, and the index pattern. If you want to save your current view of Discover for later retrieval and reuse, create a <<save-open-search, saved search>> instead.
[role="xpack"]
==== Read only access
If you have insufficient privileges to save queries, the *Save current query* button isn't visible in the saved query management popover. For more information, see <<xpack-security-authorization, Granting access to Kibana>>
==== Saving a query
To save the current query text, filters, and time filter:
. Click *#* in the search bar, next to the query text input.
. Click *Save current query* in the popover.
+
[role="screenshot"]
image::discover/images/saved-query-management-component-all-privileges.png["Example of the saved query management popover with a list of saved queries with write access",width="80%"]
+
. Enter a name, a description, and then select the filter options that you want to include. By default, filters are automatically included, but the time filter is not.
+
[role="screenshot"]
image::discover/images/saved-query-save-form-default-filters.png["Example of the saved query management save form with the filters option included and the time filter option excluded",width="80%"]
. Click *Save*.
==== Loading a query
To load a saved query into Discover, Dashboard, or Visualize:
. Click *#* in the search bar, next to the query text input.
. Select the query you want to load. You might need to scroll down to find the query you are looking for.
==== Saving changes to a query
If you load a query and then make changes to the query text, the filters, or the time filter, you can save the changes as a new query or update the existing query.
To save the changes as a new query:
. Click *#* in the search bar, next to the query text input.
. Click *Save as new* in the popover.
. Enter a name and a description, and then select the filter options that you want to include.
. Click *Save*.
+
[role="screenshot"]
image::discover/images/saved-query-management-component-save-as-new-query.png["Example of the saved query management popover when a query is loaded and we have made changes to the query",width="80%"]
To save the changes to the current query:
. Click *#* in the search bar.
. Click *Save changes* in the popover.
. Enter a description, and then select the filter options that you want to include.
. Click *Save*.
==== Clearing a query
To clear a query that is currently loaded in an application:
. Click *#* in the search bar.
. Click *Clear* in the popover.
==== Deleting a query
To completely delete a query:
. Click *#* in the search bar, next to the query text input.
. Hover over the query you want to delete.
. Click the trash can icon.
+
[role="screenshot"]
image::discover/images/saved-query-management-component-delete-query-button.png["Example of the saved query management popover when a query is hovered over and we are about to delete a query",width="80%"]
You can import, export, and delete saved queries from <<managing-saved-objects, Saved Objects in Management>>.
[[select-pattern]]
=== Changing Which Indices You're Searching