diff --git a/docs/Filter/Ids.md b/docs/Filter/Ids.md new file mode 100644 index 0000000000000000000000000000000000000000..e2bcfb6ed8e2dc51b4cb1589546ae4c6e6bb733c --- /dev/null +++ b/docs/Filter/Ids.md @@ -0,0 +1,32 @@ +# Ids Filter + +> More info about ids filter is in the [official elasticsearch docs][1] + +Filters documents that only have the provided ids. + +## Simple example + +```JSON +{ + "ids" : { + "type" : "my_type", + "values" : ["1", "4", "100"] + } +} +``` + +And now the query via DSL: + +```php +$idsFilters = new IdsFilter( + ['1', '4', '100'], + ['type' => 'my_type'] +); + +$search = new Search(); +$search->addFilter($idsFilters); + +$queryArray = $search->toArray(); +``` + +[1]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-ids-filter.html