Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Renamed words in /docs/discover/* files. Elastic/elastic not changed. #112

Closed
wants to merge 1 commit into from
Closed

Renamed words in /docs/discover/* files. Elastic/elastic not changed. #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/discover/kuery.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[[kuery-query]]
=== Kibana Query Language
=== OpenSearchDashboards Query Language

The Kibana Query Language (KQL) makes it easy to find
the fields and syntax for your {es} query. If you have the
The OpenSearchDashboards Query Language (KQL) makes it easy to find
the fields and syntax for your {opensearch} query. If you have the
https://www.elastic.co/subscriptions[Basic tier] or above,
simply place your cursor in the *Search* field. As you type, you’ll get suggestions for fields,
values, and operators.

[role="screenshot"]
image::images/kql-autocomplete.png[Autocomplete in Search bar]

If you prefer to use Kibana’s legacy query language, based on the
If you prefer to use OpenSearchDashboards’s legacy query language, based on the
<<lucene-query, Lucene query syntax>>, click *KQL* next to the *Search* field, and then turn off KQL.

[discrete]
Expand Down Expand Up @@ -121,7 +121,7 @@ account_number >= 100 and items_sold <= 200
[discrete]
=== Date range queries

Typically, Kibana's <<set-time-filter,time filter>> is sufficient for setting a time range,
Typically, OpenSearchDashboards's <<set-time-filter,time filter>> is sufficient for setting a time range,
but in some cases you might need to search on dates. Include the date range in quotes.

[source,yaml]
Expand Down
28 changes: 14 additions & 14 deletions docs/discover/search.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
[[search]]
== Search data
Many Kibana apps embed a query bar for real-time search, including
Many OpenSearchDashboards apps embed a query bar for real-time search, including
*Discover* and *Dashboard*.

[float]
=== Search your data

To search the indices that match the current <<index-patterns, index pattern>>,
enter your search criteria in the query bar. By default, you'll use
{kib}'s <<kuery-query, standard query language>> (KQL), which
{osd}'s <<kuery-query, standard query language>> (KQL), which
features autocomplete and a simple, easy-to-use syntax. If you prefer to use
{kib}'s legacy query
{osd}'s legacy query
language, based on the
Lucene https://lucene.apache.org/core/2_9_4/queryparsersyntax.html[query syntax],
you can switch to it from the KQL popup in the query bar. When you enable the
legacy query language, you can use the full
JSON-based {ref}/query-dsl.html[Elasticsearch Query DSL].
JSON-based {ref}/query-dsl.html[OpenSearch Query DSL].


[float]
Expand Down Expand Up @@ -53,7 +53,7 @@ include::kuery.asciidoc[]

[[lucene-query]]
=== Lucene query syntax
Kibana's legacy query language was based on the Lucene query syntax. For the time being this syntax
OpenSearchDashboards's legacy query language was based on the Lucene query syntax. For the time being this syntax
is still available under the options menu in the Query Bar and in Advanced Settings. The following
are some tips that can help get you started.

Expand All @@ -74,15 +74,15 @@ status codes, you could enter `status:[400 TO 499]`.
codes and have an extension of `php` or `html`, you could enter `status:[400 TO
499] AND (extension:php OR extension:html)`.

IMPORTANT: When you use the Lucene Query Syntax in the *KQL* search bar, {kib} is unable to search on nested objects and perform aggregations across fields that contain nested objects.
Using `include_in_parent` or `copy_to` as a workaround can cause {kib} to fail.
IMPORTANT: When you use the Lucene Query Syntax in the *KQL* search bar, {osd} is unable to search on nested objects and perform aggregations across fields that contain nested objects.
Using `include_in_parent` or `copy_to` as a workaround can cause {osd} to fail.

For more detailed information about the Lucene query syntax, see the
{ref}/query-dsl-query-string-query.html#query-string-syntax[Query String Query]
docs.

NOTE: These examples use the Lucene query syntax. When lucene is selected as your
query language you can also submit queries using the {ref}/query-dsl.html[Elasticsearch Query DSL].
query language you can also submit queries using the {ref}/query-dsl.html[OpenSearch Query DSL].


[[save-open-search]]
Expand All @@ -94,17 +94,17 @@ A saved search includes the query text, filters, and optionally, the time filter
[role="xpack"]
[[discover-read-only-access]]
==== Read-only access
When you have insufficient privileges to save searches, the following indicator in Kibana will be
When you have insufficient privileges to save searches, the following indicator in OpenSearchDashboards will be
displayed and the *Save* button won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.
OpenSearchDashboards see <<xpack-security-authorization>>.

[role="screenshot"]
image::discover/images/read-only-badge.png[Example of Discover's read only access indicator in Kibana's header]
image::discover/images/read-only-badge.png[Example of Discover's read only access indicator in OpenSearchDashboards's header]

==== Save a search
To save the current search:

. Click *Save* in the Kibana toolbar.
. Click *Save* in the OpenSearchDashboards toolbar.
. Enter a name for the search and click *Save*.

To import, export, and delete saved searches, open the main menu,
Expand All @@ -113,7 +113,7 @@ then click *Stack Management > Saved Objects*.
==== Open a saved search
To load a saved search into Discover:

. Click *Open* in the Kibana toolbar.
. Click *Open* in the OpenSearchDashboards toolbar.
. Select the search you want to open.

If the saved search is associated with a different index pattern than is currently
Expand All @@ -132,7 +132,7 @@ Saved queries don't include information specific to Discover, such as the curren

[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>>
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 OpenSearchDashboards>>

==== Save a query
To save the current query text, filters, and time filter:
Expand Down