# java-opensearch23-client

**Repository Path**: yccock/java-opensearch23-client

## Basic Information

- **Project Name**: java-opensearch23-client
- **Description**: OpenSearch 2.3.0 的 java 客户端 (基于 spring-boot)
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-07-12
- **Last Updated**: 2023-07-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 0. 写在前面

项目配置

JAVA GraalVM 17

OpenSearch 2.3.0

Spring-Boot 2.7.5

Junit5 5.8.2

# 1. 开发目的

AWS 的 OpenSearch，类似于 Elastic 的 ElasticSearch

此为 OpenSearch 的 java 客户端。

# 2. API类型

| 类型 | 用途     | 
|:---------:|:-------:| 
| [NodeApi](https://gitee.com/darkranger/java-opensearch23-client/blob/main/src/main/java/com/wujunshen/opensearch/NodeApi.java)       | 节点相关操作 | 
| [IndexApi](https://gitee.com/darkranger/java-opensearch23-client/blob/main/src/main/java/com/wujunshen/opensearch/IndexApi.java)       | 索引相关操作 | 
| [DocumentApi](https://gitee.com/darkranger/java-opensearch23-client/blob/main/src/main/java/com/wujunshen/opensearch/DocumentApi.java) | 文档相关操作 | 
| [QueryApi ](https://gitee.com/darkranger/java-opensearch23-client/blob/main/src/main/java/com/wujunshen/opensearch/QueryApi.java)    | 搜索相关操作 | 

# 3. 单元测试

见 test 下的 [opensearch](https://gitee.com/darkranger/java-opensearch23-client/tree/main/src/test/java/com/wujunshen/opensearch) 目录里的 java 测试类


# 4. 补充

由于 OpenSearch 的 knn 插件需要读取在 centos 系统上才有的 so 格式文件，导致无法在 mac 系统上安装，故目前使用了 aws 的 ec2 实例安装 OpenSearch

且由于使用了 https 协议，需要生成 SSL 证书和 truststore 文件，具体如何生成另附它文叙述，目前只要注意查看 [application.yml](https://gitee.com/darkranger/java-opensearch23-client/blob/main/src/main/resources/application.yml) 中配置。具体的 [truststore](https://gitee.com/darkranger/java-opensearch23-client/blob/main/src/main/resources/wjunshenStore) 文件也已在 [resources](https://gitee.com/darkranger/java-opensearch23-client/blob/main/src/main/resources) 目录下

OpenSearch 默认的 https 访问用户名/密码是 admin/admin