opensearch-project/opensearch-js
GitHub: opensearch-project/opensearch-js
OpenSearch Node.js 客户端,简化与 OpenSearch 集群的交互。
Stars: 232 | Forks: 138
[](https://github.com/opensearch-project/opensearch-js/actions/workflows/nodejs.yml)
[](https://github.com/opensearch-project/opensearch-js/actions/workflows/integration.yml)
[](https://github.com/opensearch-project/opensearch-js/actions/workflows/bundler.yml)
[](https://codecov.io/gh/opensearch-project/opensearch-js)
[](https://discuss.opendistrocommunity.dev/c/clients/)


OpenSearch Node.js 客户端
- [欢迎!](#welcome)
- [示例用法](#example-use)
- [设置](#setup)
- [示例代码](#sample-code)
- [项目资源](#project-resources)
- [行为准则](#code-of-conduct)
- [许可证](#license)
- [版权](#copyright)
## 欢迎!
**[opensearch-js](https://www.npmjs.com/package/@opensearch-project/opensearch)** 是基于 [Apache v2.0 许可证](LICENSE.txt) 下的 [由社区驱动的开源分支](https://aws.amazon.com/blogs/opensource/introducing-opensearch/),elasticsearch-js。更多信息请参阅 [opensearch.org](https://opensearch.org/).
## 示例用法
OpenSearch JavaScript 客户端提供了一种更安全、更简单的方式与您的 OpenSearch 集群交互。您不必从浏览器中使用 OpenSearch,从而可能将您的数据暴露给公众,而是可以构建一个 OpenSearch 客户端,该客户端负责向您的集群发送请求。
客户端包含一个 API 库,允许您在集群上执行不同的操作并返回标准响应体。以下示例演示了一些基本操作,如创建索引、添加文档和搜索数据。
### 设置
要将客户端添加到您的项目中,使用 npm 安装它:
```
npm i @opensearch-project/opensearch
```
如果您更喜欢手动添加客户端或只是想查看源代码,请参阅 GitHub 上的 [opensearch-js](https://github.com/opensearch-project/opensearch-js)。
然后引入客户端:
```
const { Client } = require('@opensearch-project/opensearch');
```
## 示例代码
请参阅 [USER_GUIDE](USER_GUIDE.md) 以获取代码片段。
## 项目资源
- [项目网站](https://opensearch.org/)
- [下载](https://opensearch.org/downloads.html).
- [文档](https://opensearch.org/docs/)
- 需要帮助?尝试 [论坛](https://discuss.opendistrocommunity.dev/)
- [项目原则](https://opensearch.org/#principles)
- [为 OpenSearch 贡献](CONTRIBUTING.md)
- [维护者责任](MAINTAINERS.md)
- [发布管理](RELEASING.md)
- [管理员责任](ADMINS.md)
- [安全](SECURITY.md)
- [NPM 页面](https://www.npmjs.com/package/@opensearch-project/opensearch)
## 行为准则
本项目采用了 [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md)。更多信息请参阅 [行为准则 FAQ](
标签:Apache License, API, CMS安全, GNU通用公共许可证, JavaScript, MITM代理, Node.js, npm 包, 代码覆盖率, 代码贡献, 安全可观测性, 客户端库, 开源框架, 持续集成, 搜索引擎, 数据检索, 版本控制, 社区驱动, 自定义脚本, 论坛支持, 软件开发, 集成测试