Skip to content
Developer Edition runs on one host and does not require a product license file. Need multi-host deployment or performance testing at scale? Explore Enterprise Edition

SHOW PLUGIN / PLUGINS command

The SHOW PLUGINS command lists information and status for all loaded plugins, including manually loaded plugins and automatically loaded built-in plugins. The built-in plugins displayed by the SHOW PLUGINS command include only those for the Graph service and Storage service, which are automatically loaded when the services start.

The SHOW PLUGIN <plugin_name> command lists information and status for a specific plugin.

  • The following table describes the returned information of the SHOW PLUGINS command:

    Column Description
    name The name of the plugin.
    plugin_type The type of the plugin.
    author The author of the plugin.
    description The description of the plugin.
    license The license information of the plugin.
    version The version of the plugin.
    api_version The version of the NebulaGraph Database Developer Edition plugin API used by the plugin.
    plugin_status The status of a specific plugin across all services. For example: Valid:3, Invalid:1, BuiltIn:[G:1,S:2]. Valid values are:
    • Valid: indicates the plugin's corresponding dynamic library is loaded in the specified number of services.
    • Invalid: indicates otherwise.
    • BuiltIn (only for built-in plugins): indicates the distribution of the built-in plugin across different services.
    For detailed examples, see Show all plugins.

  • The following table describes the returned information of the SHOW PLUGIN command:

    Column Description
    service The IP address and port number of the service that the plugin adapts to.
    plugin_status The status of the specified plugin in a specific service. Valid values are:
    • Valid: indicates the plugin's corresponding dynamic library is loaded in the specified service.
    • Invalid: indicates otherwise and shows detailed error messages for troubleshooting.
    For detailed examples, see Show a specific plugin.

Syntax

show_plugins_command
SHOW PLUGINS
show_plugin_command
SHOW PLUGIN plugin_name 

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

Parameters

plugin_name

The name of the plugin.

Examples

Show all plugins

SHOW PLUGINS

Return:

+----------------+-------------+------------+------------------------------------------+-------------+---------+-------------+---------------------------------------+
| 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]     |
+----------------+-------------+------------+------------------------------------------+-------------+---------+-------------+---------------------------------------+

In the preceding output, the column plugin_status displays the status of a specific plugin across all services. For example, the first line indicates that two services loaded the built-in plugin log_rotate successfully, where G:1 represents one Graph service and S:1 represents one Storage service.

Show a specific plugin

SHOW PLUGIN log_rotate

Return:

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

In the preceding output, the column plugin_status displays the status of the specified plugin in a specific service. For example, the first line indicates that the Graph service (192.168.8.113:9669) successfully loaded the plugin log_rotate. If loading or unloading fails, this column displays error messages.