npm 包 node-es-local 使用教程

阅读时长 4 分钟读完

什么是 node-es-local?

node-es-local 是一个通过 Node.js 实现 Elasticsearch 本地化的 npm 包。它可以让我们在开发过程中省略 Elasticsearch 启动和关闭的步骤,并且支持多个 Elasticsearch 版本(例如 6.x、7.x 等)。

安装与使用

安装 node-es-local

使用:

-- -------------------- ---- -------
----- ----------- - -------------------------
----- ----------- - --- ---------------------- ---------

---- ------------- ----
--------------------------- -- -
  -------------------- ------ ----------
---

---- ------------- ----
-------------------------- -- -
  -------------------- ------ ----------
---

其中,esVersion 参数是 Elasticsearch 版本,options 参数是启动 Elasticsearch 本地实例的配置项对象。start() 方法返回一个 Promise 对象,当 Elasticsearch 本地实例启动成功后,该 Promise 对象 resolve。

配置项

下面是 options 参数的详细配置项说明:

-- -------------------- ---- -------
-
  -- ------------- -------
  ------- -------------------------

  -- ------------- -------------
  ------- -
    ------------ ------------------
    --------------- ---------------------
  --

  -- ------------- ------- ------------- ---------
  -------------------- -----

  -- ----- --------
  ----- -----

  -- ---- ---
  ---- ------

  -- --- ------
  ------------ ------------------------

  -- --- ------
  ----------- -----------------------

  -- ------------- -----
  ------- ------------

  -- --------
  -------- -----
  -------- -----
-

示例代码

以下是一个使用 node-es-local 查询 Elasticsearch 索引的样例代码:

-- -------------------- ---- -------
----- ----------- - -------------------------
----- - ------ - - ----------------------------------
----- ----------- - --- ---------------------
----- ------ - --- -------- ----- ----------------------- ---

------ -- -- -
  --- -
    ----- --------------------
    ----- - ---- - - ----- ---------------
      ------ -----------
      ----- -
        ------ -
          ------ - ------ ------- -
        -
      -
    ---
    ----------------------------
  - ----- ----- -
    -------------------
  - ------- -
    ----- -------------------
  -
-----

该代码会输出 Elasticsearch 中名为 my_index 的索引中 title 包含 'apple' 的所有文档的内容。

总结

node-es-local 在前端开发过程中可以方便地使用 Elasticsearch,而无需启动和关闭 Elasticsearch 服务,降低了开发调试的成本。本文提供了该库的简要介绍、安装、使用方法,并给出了一个简单的示例代码。希望对使用 node-es-local 的开发者有帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055eb781e8991b448dc661

纠错
反馈