File: filters.md

package info (click to toggle)
elasticsearch-curator 9.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,740 kB
  • sloc: python: 18,836; makefile: 159; sh: 156
file content (55 lines) | stat: -rw-r--r-- 2,042 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
---
mapped_pages:
  - https://www.elastic.co/guide/en/elasticsearch/client/curator/current/filters.html
---

# Filters [filters]

Filters are the way to select only the indices (or snapshots) you want.

::::{admonition} Filter chaining
:class: note

It is important to note that while filters can be chained, each is linked by an implied logical **AND** operation.  If you want to match from one of several different patterns, as with a logical **OR** operation, you can do so with the [pattern](/reference/filtertype_pattern.md) filtertype using *regex* as the [kind](/reference/fe_kind.md).

This example shows how to select multiple indices based on them beginning with either `alpha-`, `bravo-`, or `charlie-`:

```yaml
  filters:
  - filtertype: pattern
    kind: regex
    value: '^(alpha-|bravo-|charlie-).*$'
```

Explaining all of the different ways in which regular expressions can be used is outside the scope of this document, but hopefully this gives you some idea of how a regular expression pattern can be used when a logical **OR** is desired.

::::


The index filtertypes are:

* [age](/reference/filtertype_age.md)
* [alias](/reference/filtertype_alias.md)
* [allocated](/reference/filtertype_allocated.md)
* [closed](/reference/filtertype_closed.md)
* [count](/reference/filtertype_count.md)
* [empty](/reference/filtertype_empty.md)
* [forcemerged](/reference/filtertype_forcemerged.md)
* [kibana](/reference/filtertype_kibana.md)
* [none](/reference/filtertype_none.md)
* [opened](/reference/filtertype_opened.md)
* [pattern](/reference/filtertype_pattern.md)
* [period](/reference/filtertype_period.md)
* [space](/reference/filtertype_space.md)

The snapshot filtertypes are:

* [age](/reference/filtertype_age.md)
* [count](/reference/filtertype_count.md)
* [none](/reference/filtertype_none.md)
* [pattern](/reference/filtertype_pattern.md)
* [period](/reference/filtertype_period.md)
* [state](/reference/filtertype_state.md)

You can use [environment variables](/reference/envvars.md) in your configuration files.