IndexTank Engine 技术文档

1. 安装指南

环境准备

在安装 IndexTank Engine 前，请确保您的系统已安装以下环境：

• Java Development Kit (JDK) 1.6 或更高版本
• Maven 3.0.4 或更高版本

安装步骤

1. 克隆项目仓库到本地：

   git clone https://github.com/flaptor/indextank-engine.git
   

2. 在项目根目录下执行 Maven 编译命令，构建项目：

   mvn compile
   

3. 打包项目，生成包含所有依赖的单一 JAR 文件：

   mvn package assembly:single
   

   执行上述命令后，会在 target 目录下生成 indextank-engine-1.0.0-jar-with-dependencies.jar 文件。

2. 项目的使用说明

快速开始

运行以下命令启动 API 服务器：

java -cp target/indextank-engine-1.0.0-jar-with-dependencies.jar com.flaptor.indextank.api.Launcher

启动成功后，API 服务器将在端口 20220 上监听请求。

索引和搜索

使用 curl 命令进行索引和搜索操作：

curl -d "{\"docid\":\"post1\", \"fields\":{\"text\":\"I love Fallout\"}}" -v -X PUT http://localhost:20220/v1/indexes/idx/docs

curl -d "{\"docid\":\"post2\", \"fields\":{\"text\":\"I love Planescape\"}}" -v -X PUT http://localhost:20220/v1/indexes/idx/docs

curl http://localhost:20220/v1/indexes/idx/search?q=love

3. 项目API使用文档

IndexTank Engine 提供了以下 API 接口：

• PUT /v1/indexes/{index_name}/docs：索引文档
• GET /v1/indexes/{index_name}/search：搜索文档

具体使用方法如下：

索引文档

PUT /v1/indexes/{index_name}/docs
Content-Type: application/json

{
  "docid": "unique_document_id",
  "fields": {
    "field_name_1": "field_value_1",
    "field_name_2": "field_value_2",
    ...
  }
}

搜索文档

GET /v1/indexes/{index_name}/search?q={query_string}

其中，{index_name} 为索引名称，{query_string} 为搜索关键词。

4. 项目安装方式

IndexTank Engine 可以通过以下方式安装：

• 使用 Maven 直接依赖 indextank-engine 项目，确保 pom.xml 文件中包含以下依赖：

  <dependency>
    <groupId>com.flaptor.indextank</groupId>
    <artifactId>indextank-engine</artifactId>
    <version>1.0.0</version>
  </dependency>
  

• 手动下载 indextank-engine-1.0.0-jar-with-dependencies.jar 文件，并将其添加到项目类路径中。

以上为 IndexTank Engine 的技术文档，希望对您有所帮助。