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.

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

add documentation about multi-target search #3881

Merged
merged 3 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
35 changes: 35 additions & 0 deletions docs/reference/es_compatible_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -543,3 +543,38 @@ Query matching only documents containing a non-null value for a given field.
|-------------------|------------|------------------------------------------------------------------|---------|
| `field` | String | Only documents with a value for field will be returned. | - |


## Search multiple indices

Search APIs that accept <index_id> requests path parameter also support multi-target syntax.

### Multi-target syntax

In multi-target syntax, you can use a comma or its URL encoded version '%2C' seperated list to run a request on multiple indices: test1,test2,test3. You can also sue [glob-like](https://en.wikipedia.org/wiki/Glob_(programming)) wildcard ( \* ) expressions to target indices that match a pattern: test\* or \*test or te\*t or \*test\*.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In multi-target syntax, you can use a comma or its URL encoded version '%2C' seperated list to run a request on multiple indices: test1,test2,test3. You can also sue [glob-like](https://en.wikipedia.org/wiki/Glob_(programming)) wildcard ( \* ) expressions to target indices that match a pattern: test\* or \*test or te\*t or \*test\*.
In multi-target syntax, you can use a comma or its URL encoded version '%2C' separated list to run a request on multiple indices: test1,test2,test3. You can also use [glob-like](https://en.wikipedia.org/wiki/Glob_(programming)) wildcard ( \* ) expressions to target indices that match a pattern: test\* or \*test or te\*t or \*test\*.


The multi-target expression has the following constraints:

- It must follow the regex `^[a-zA-Z\*][a-zA-Z0-9-_\.\*]{0,254}$`.
- It cannot contain consecutive asterisks (`*`).
- If it contains an asterisk (`*`), the length must be greater than or equal to 3 characters.

### Examples
```
GET api/v1/_elastic/stackoverflow-000001,stackoverflow-000002/_search
{
"query_string": {
"query": "search AND engine",
"fields": ["title", "body"]
}
}
```

```
GET api/v1/_elastic/stackoverflow*/_search
{
"query_string": {
"query": "search AND engine",
"fields": ["title", "body"]
}
}
```
28 changes: 28 additions & 0 deletions docs/reference/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,34 @@ The response is a JSON object, and the content type is `application/json; charse
| `num_hits` | Total number of matches | `number` |
| `elapsed_time_micros` | Processing time of the query | `number` |

### Search multiple indices
Search APIs that accept <index id> requests path parameter also support multi-target syntax.

#### Multi-target syntax

In multi-target syntax, you can use a comma or its URL encoded version '%2C' separated list to run a request on multiple indices: test1,test2,test3. You can also use [glob-like](https://en.wikipedia.org/wiki/Glob_(programming)) wildcard ( \* ) expressions to target indices that match a pattern: test\* or \*test or te\*t or \*test\*.

The following are some constrains about the multi-target expression.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following are some constrains about the multi-target expression.
The multi-target expression has the following constraints:


- It must follow the regex `^[a-zA-Z\*][a-zA-Z0-9-_\.\*]{0,254}$`.
- It cannot contain consecutive asterisks (`*`).
- If it contains an asterisk (`*`), the length must be greater than or equal to 3 characters.

#### Examples
```
GET api/v1/stackoverflow-000001,stackoverflow-000002/search
{
"query": "search AND engine",
}
```

```
GET api/v1/stackoverflow*/search
{
"query": "search AND engine",
}
```

### Search stream in an index

```
Expand Down