Skip to content

Commit

Permalink
Revert "Remove dynamic templates from a mapping example (#3698)"
Browse files Browse the repository at this point in the history
This reverts commit d8c83f4.
  • Loading branch information
vagimeli committed May 4, 2023
1 parent 057db61 commit 897e317
Showing 1 changed file with 17 additions and 53 deletions.
70 changes: 17 additions & 53 deletions _field-types/mappings.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,77 +87,41 @@ You cannot change the mapping of an existing field, you can only modify the fiel
---
## Mapping example usage

The following example shows how to create a mapping to specify that OpenSearch should ignore any documents with malformed IP addresses that do not conform to the [`ip`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/ip/) data type. You accomplish this by setting the `ignore_malformed` parameter to `true`.
The following example shows how to create a mapping to specify that OpenSearch should ignore any documents with malformed ip addresses that do not conform to the `ip_range` data type. You accomplish this by setting the `ignore_malformed` parameter to `true`.

### Create an index with an `ip` mapping
### Create an index with an ip_range mapping

To create an index, use a PUT request:

```json
PUT /test-index
PUT _index_ip
{
"mappings" : {
"properties" : {
"ip_address" : {
"type" : "ip",
"ignore_malformed": true
"mappings": {
"dynamic_templates": [
{
"ip_range": {
"match": "*ip_range",
"mapping": {
"type": "ip_range",
"ignore_malformed": true
}
}
}
]
}
}
```

You can add a document that has a malformed IP address to your index:
You can add a document to your index that has an IP range specified:

```json
PUT /test-index/_doc/1
PUT _index_ip/_doc/<id>
{
"ip_address" : "malformed ip address"
"source_ip_range": "192.168.1.1/32"
}
```

This indexed IP address does not throw an error because `ignore_malformed` is set to true.

You can query the index using the following request:

```json
GET /test-index/_search
```

The response shows that the `ip_address` field is ignored in the indexed document:

```json
{
"took": 14,
"timed_out": false,
"_shards": {
"total": 1,
"successful": 1,
"skipped": 0,
"failed": 0
},
"hits": {
"total": {
"value": 1,
"relation": "eq"
},
"max_score": 1,
"hits": [
{
"_index": "test-index",
"_id": "1",
"_score": 1,
"_ignored": [
"ip_address"
],
"_source": {
"ip_address": "malformed ip address"
}
}
]
}
}
```
This indexed ip_range does not throw an error because `ignore_malformed` is set to true.

## Get a mapping

Expand Down

0 comments on commit 897e317

Please sign in to comment.