kibana/docs/maps/search.asciidoc
Nathan Reese fa82f630a0
[Maps] 7.11 documentation updates (#85857)
* [Maps] 7.11 documenation updates

* update search docs with time filter legend indicator

* clean up tracks description

* fix duplicate id

* Update docs/maps/search.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/maps/vector-style.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/maps/vector-style.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* review feedback

* add percentile metric aggregation

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-12-15 12:37:16 -07:00

130 lines
5.4 KiB
Plaintext

[role="xpack"]
[[maps-search]]
== Search geographic data
Use the filters, query bar, and time filter to focus in on just the data you want.
Only layers requesting data from {es} are narrowed when you submit a search request.
Layers narrowed by the filters and query bar contain the filter icon image:maps/images/filter_icon.png[] next to the layer name in the legend.
Only layers requesting data from {es} using an <<index-patterns, index pattern>> with a configured time field are narrowed by the time filter.
Layers narrowed by the time filter contain the clock icon image:maps/images/clock_icon.png[] next to the layer name in the legend.
You can create a layer that requests data from {es} from the following:
* <<vector-layer>> with:
** Documents
** Clusters and grid
** Point to point
** <<terms-join>>
** Tracks
* <<heatmap-layer>>
[role="screenshot"]
image::maps/images/global_search_bar.png[]
[role="xpack"]
[[maps-create-filter-from-map]]
=== Create filters from a map
You can create two types of filters by interacting with your map:
* <<maps-spatial-filters, Spatial filters>>
* <<maps-phrase-filter, Phrase filters>>
[role="screenshot"]
image::maps/images/create_spatial_filter.png[]
[float]
[[maps-spatial-filters]]
==== Spatial filters
A spatial filter narrows search results to documents that either intersect with, are within, or do not intersect with the specified geometry.
You can create spatial filters in two ways:
* Click the tool icon image:maps/images/tools_icon.png[], and then draw a polygon or bounding box on the map to define the spatial filter.
* Click *Filter by geometry* in a <<maps-vector-tooltip-locking, locked tooltip>>, and then use the feature's geometry for the spatial filter.
Spatial filters have the following properties:
* *Geometry label* enables you to provide a meaningful name for your spatial filter.
* *Spatial field* specifies the geo_point or geo_shape field used to determine if a document matches the spatial relation with the specified geometry.
* *Spatial relation* determines the {ref}/query-dsl-geo-shape-query.html#_spatial_relations[spatial relation operator] to use at search time. Only available when *Spatial field* is set to geo_shape.
* *Action* specifies whether to apply the filter to the current view or to a drilldown action. Only available when the map is a panel in a {kibana-ref}/dashboard.html[dashboard] with {kibana-ref}/drilldowns.html[drilldowns].
[float]
[[maps-phrase-filter]]
==== Phrase filters
A phrase filter narrows search results to documents that contain the specified text.
You can create a phrase filter by clicking the plus icon image:maps/images/gs_plus_icon.png[] in a <<maps-vector-tooltip-locking, locked tooltip>>.
If the map is a dashboard panel with drilldowns, you can apply a phrase filter to a drilldown by selecting the drilldown action.
[role="xpack"]
[[maps-layer-based-filtering]]
=== Filter a single layer
You can apply a search request to individual layers by setting `Filters` in the layer details panel.
Click the *Add filter* button to add a filter to a layer.
NOTE: Layer filters are not applied to *term joins*. You can apply a search request to *term joins* by setting the *where* clause in the join definition.
[role="screenshot"]
image::maps/images/layer_search.png[]
[role="xpack"]
[[maps-search-across-multiple-indices]]
=== Search across multiple indices
Your map might contain multiple {es} indices.
This can occur when your map contains two or more layers with {es} sources from different indices.
This can also occur with a single layer with an {es} source and a <<terms-join>>.
Searching across multiple indices might sometimes result in empty layers.
The most common cause for empty layers are searches for a field that exists in one index, but does not exist in other indices.
[float]
[[maps-disable-search-for-layer]]
==== Disable search for a layer
You can prevent the search bar from applying search context to a layer by configuring the following:
* In *Filtering*, clear the *Apply global filter to layer data* checkbox to turn off the global search context for the layer source.
* In *Term joins*, clear the *Apply global filter to join* checkbox to turn off the global search context for the <<terms-join, term join>>.
[float]
[[maps-add-index-search]]
==== Use _index in a search
Add {ref}/mapping-index-field.html[_index] to your search to include documents from indices that do not contain a search field.
For example, suppose you have a vector layer showing the `kibana_sample_data_logs` documents
and another vector layer with `kibana_sample_data_flights` documents.
(See <<add-sample-data, adding sample data>>
to install the `kibana_sample_data_logs` and `kibana_sample_data_flights` indices.)
If you query for
--------------------------------------------------
machine.os.keyword : "osx"
--------------------------------------------------
the `kibana_sample_data_flights` layer is empty because the index
`kibana_sample_data_flights` does not contain the field `machine.os.keyword` and no documents match the query.
[role="screenshot"]
image::maps/images/global_search_multiple_indices_query1.png[]
If you instead query for
--------------------------------------------------
machine.os.keyword : "osx" or _index : "kibana_sample_data_flights"
--------------------------------------------------
the `kibana_sample_data_flights` layer includes data.
[role="screenshot"]
image::maps/images/global_search_multiple_indices_query2.png[]