honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/plugins/ingest-attachment.asciidoc

39 lines
1.6 KiB
Plaintext
Raw Normal View History

Ingest: Add attachment processor This is a simple port of the mapper attachment plugin to the ingest functionality, no new features. The only option is to limit the number of chars to prevent indexing of huge documents. Fields can be selected in the processor as well. Close #16303
2016-02-09 08:57:05 -05:00
[[ingest-attachment]]
Add ingest plugins to Elasticsearch plugin docs
2016-02-11 20:40:32 -05:00
=== Ingest Attachment Processor Plugin
Ingest: Add attachment processor This is a simple port of the mapper attachment plugin to the ingest functionality, no new features. The only option is to limit the number of chars to prevent indexing of huge documents. Fields can be selected in the processor as well. Close #16303
2016-02-09 08:57:05 -05:00
Edits to ingest plugin docs
2016-03-04 01:49:31 -05:00
The ingest attachment plugin lets Elasticsearch extract file attachments in common formats (such as PPT, XLS, and PDF) by
Ingest: Add attachment processor This is a simple port of the mapper attachment plugin to the ingest functionality, no new features. The only option is to limit the number of chars to prevent indexing of huge documents. Fields can be selected in the processor as well. Close #16303
2016-02-09 08:57:05 -05:00
using the Apache text extraction library http://lucene.apache.org/tika/[Tika].
Edits to ingest plugin docs
2016-03-04 01:49:31 -05:00
You can use the ingest attachment plugin as a replacement for the mapper attachment plugin.
Ingest: Add attachment processor This is a simple port of the mapper attachment plugin to the ingest functionality, no new features. The only option is to limit the number of chars to prevent indexing of huge documents. Fields can be selected in the processor as well. Close #16303
2016-02-09 08:57:05 -05:00
The source field must be a base64 encoded binary.
[[ingest-attachment-options]]
.Attachment options
[options="header"]
|======
| Name | Required | Default | Description
| `source_field` | yes | - | The field to get the base64 encoded field from
| `target_field` | no | attachment | The field that will hold the attachment information
| `indexed_chars` | no | 100000 | The number of chars being used for extraction to prevent huge fields. Use `-1` for no limit.
Edits to ingest plugin docs
2016-03-04 01:49:31 -05:00
| `fields` | no | all | Properties to select to be stored. Can be `content`, `title`, `name`, `author`, `keywords`, `date`, `content_type`, `content_length`, `language`
Ingest: Add attachment processor This is a simple port of the mapper attachment plugin to the ingest functionality, no new features. The only option is to limit the number of chars to prevent indexing of huge documents. Fields can be selected in the processor as well. Close #16303
2016-02-09 08:57:05 -05:00
|======
[source,js]
--------------------------------------------------
{
"description" : "...",
"processors" : [
{
"attachment" : {
"source_field" : "data"
}
}
]
}
--------------------------------------------------
NOTE: Extracting contents from binary data is a resource intensive operation and
consumes a lot of resources. It is highly recommended to run pipelines
using this processor in a dedicated ingest node.