Elasticsearch Mapper Attachments 插件使用教程

1. 项目目录结构及介绍

Elasticsearch Mapper Attachments 插件的目录结构如下：

elasticsearch-mapper-attachments/
├── dev-tools/
├── licenses/
├── src/
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.md
└── build.gradle

目录介绍

• dev-tools/：开发工具目录，包含用于开发和测试的工具和脚本。
• licenses/：许可证文件目录，包含项目使用的各种许可证文件。
• src/：源代码目录，包含插件的主要代码实现。
• .gitignore：Git 忽略文件，指定哪些文件和目录不需要被 Git 管理。
• CONTRIBUTING.md：贡献指南文件，指导开发者如何为项目贡献代码。
• LICENSE.txt：项目许可证文件，说明项目的开源许可证类型。
• README.md：项目自述文件，包含项目的概述、安装和使用说明。
• build.gradle：Gradle 构建文件，用于构建和管理项目的依赖。

2. 项目的启动文件介绍

Elasticsearch Mapper Attachments 插件没有独立的启动文件，因为它是一个 Elasticsearch 插件，需要通过 Elasticsearch 的插件管理命令进行安装和启动。

安装插件

在 Elasticsearch 安装目录下运行以下命令来安装插件：

bin/plugin install elasticsearch/elasticsearch-mapper-attachments/3.1.2

启动 Elasticsearch

安装完成后，启动 Elasticsearch 服务即可使用该插件。

3. 项目的配置文件介绍

Elasticsearch Mapper Attachments 插件的配置主要通过 Elasticsearch 的索引映射（Mapping）进行。以下是一个示例配置：

创建索引映射

PUT /test
PUT /test/person/_mapping
{
  "person": {
    "properties": {
      "my_attachment": {
        "type": "attachment"
      }
    }
  }
}

索引文档

PUT /test/person/1
{
  "my_attachment": "e1xydGYxXGFuc2kNCkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0DQpccGFyIH0="
}

配置选项

• _content_type：指定附件的 MIME 类型。
• _name：指定附件的名称。
• _language：指定附件的语言。
• _content：附件内容的 base64 编码。

示例配置

PUT /test/person/1
{
  "my_attachment": {
    "_content_type": "application/pdf",
    "_name": "resource/name/of/my.pdf",
    "_language": "en",
    "_content": "e1xydGYxXGFuc2kNCkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0DQpccGFyIH0="
  }
}

通过以上配置，可以实现对附件内容的索引和查询。