跳转至
开发版采用单机部署，无需产品 License 文件。需要多机部署或大规模性能测试？ 了解企业版

SHOW PLUGIN / PLUGINS

SHOW PLUGINS命令列出所有已加载的插件的信息和状态。已加载的插件包括手动加载的插件和自动加载的内置插件。SHOW PLUGINS命令显示的内置插件中只包含 Graph 服务和 Storage 服务的内置插件，其在服务启动时自动加载。

SHOW PLUGIN <plugin_name>命令列出特定插件的信息和状态。

  • SHOW PLUGINS命令返回信息如下表：

    列 描述
    name 插件名称。
    plugin_type 插件的类型。
    author 插件的作者。
    description 插件的描述。
    license 插件的许可信息。
    version 插件的版本。
    api_version 插件使用的 API 版本。
    plugin_status 插件在不同服务中的状态概要。例如：Valid:3, Invalid:1, BuiltIn:[G:1,S:2]。有效值包含：
    • Valid：表示插件相应的动态库已加载到相关服务中。
    • Invalid：表示插件相应的动态库未加载到相关服务中。
    • BuiltIn（仅内置插件显示）：内置插件在不同服务中的分布情况。
    具体示例，请参见显示所有插件信息。

  • SHOW PLUGIN <plugin_name>命令返回信息如下表：

    列 描述
    service 插件适配的服务的 IP 地址和端口号。
    plugin_status 插件在每个服务中的具体状态。有效值包含：
    • Valid：表示插件相应的动态库已加载到相关服务中。
    • Invalid：表示插件相应的动态库未加载到相关服务中，且显示具体错误信息以供排查。
    具体示例，请参见显示特定插件信息。

语法

show_plugins_command
SHOW PLUGINS
show_plugin_command
SHOW PLUGIN plugin_name 

show_plugins_command ::=
    'SHOW' 'PLUGINS'
show_plugin_command ::=
    'SHOW' 'PLUGIN' plugin_name

参数

plugin_name

待查询的插件的名称。

示例

显示所有插件信息

SHOW PLUGINS

返回：

+----------------+-------------+------------+------------------------------------------+-------------+---------+-------------+---------------------------------------+
| name           | plugin_type | author     | description                              | license     | version | api_version | plugin_status                         |
+----------------+-------------+------------+------------------------------------------+-------------+---------+-------------+---------------------------------------+
| log_rotate     | LOG_ROTATE  | vesoft-inc | nebula's log rotator                     | PROPRIETARY | 5.0     | 5.0         | Valid:2, Invalid:0, BuiltIn:[G:1,S:1] |
| localfs        | UNKNOWN     |            |                                          |             |         | 0.0         | Valid:1, Invalid:0, BuiltIn:[S:1]     |
| file_audit     | AUDIT       | vesoft-inc | nebula's default file based audit plugin | PROPRIETARY | 5.0     | 5.0         | Valid:2, Invalid:0, BuiltIn:[G:1,S:1] |
| plugin_manager | PROCEDURE   | vesoft-inc | nebula's procedure manager               | PROPRIETARY | 5.0     | 5.0         | Valid:1, Invalid:0, BuiltIn:[G:1]     |
| dbms           | PROCEDURE   | vesoft-inc | nebula's default dbms procedures         | PROPRIETARY | 5.0     | 5.0         | Valid:1, Invalid:0, BuiltIn:[G:1]     |
| csv_connector  | UNKNOWN     |            |                                          |             |         | 0.0         | Valid:1, Invalid:0, BuiltIn:[S:1]     |
+----------------+-------------+------------+------------------------------------------+-------------+---------+-------------+---------------------------------------+

该命令返回结果中的plugin_status列展示某插件在不同服务中的状态概要。例如，第一行显示有 2 个服务成功加载了内置插件log_rotate，其中G:1表示 1 个 Graph 服务，S:1表示 1 个 Storage 服务。

显示特定插件信息

SHOW PLUGIN log_rotate

返回：

+--------------------+------------------+
| service            | plugin_status    |
+--------------------+------------------+
| 192.168.8.113:9669 | Valid BuiltIn[G] |
| 192.168.8.113:9779 | Valid BuiltIn[S] |
+--------------------+------------------+

该命令返回结果中的plugin_status列展示特定插件在每个服务中的具体状态。例如，第一行显示 Graph 服务192.168.8.113:9669成功加载了插件log_rotate。如果加载或卸载失败，此列将显示错误消息。