Plugins management

    1. Drop the plugin.
    2. Restart eKuiper.
    3. Create the plugin with the new configuration.

    The command is used for creating a plugin. The plugin’s definition is specified with JSON format.

    The plugin can be created with two ways.

    • Specify the plugin definition in command line.

    Sample:

      The command create a source plugin named random.

      • Specify the plugin definition in a file. If the plugin is complex, or the plugin is already wrote in text files with well organized formats, you can just specify the plugin definition through -f option.

      Sample:

      1. # bin/kuiper create plugin sink plugin1 -f /tmp/plugin1.txt
      1. {
      2.   "file":"http://127.0.0.1/plugins/sources/random.zip"
      3. }

      To create a function plugin with multiple exported functions, specify the exported functions list as below:

      1. # bin/kuiper create plugin function mulfuncs "{\"file\":\"file:///tmp/kuiper/plugins/functions/mulfuncs.zip\",\"functions\":[\"func1\",\"func2\"]}"}
      1. plugin_type: the type of the plugin. Available values are ["source", "sink", "function", "portable"]
      2. plugin_name: a unique name of the plugin. The name must be the same as the camel case version of the plugin with lowercase first letter. For example, if the exported plugin name is , then the name of this plugin is random.
      3. file: the url of the plugin files. It must be a zip file with: a compiled so file and the yaml file(only required for sources). The name of the files must match the name of the plugin. Please check Extension for the naming rule.
      4. functions: only apply to function plugin which exports multiple functions. The property specifies the exported function names.

      The command is used for displaying all plugins defined in the server for a plugin type.

      Sample:

      1. # bin/kuiper show plugins function
      2. function1
      3. function2

      The command is used to print out the detailed definition of a plugin.

        Sample: 

        1. # bin/kuiper describe plugin source plugin1
        2. {
        3.   "name": "plugin1",
        4.   "version": "1.0.0"
        1. drop plugin $plugin_type $plugin_name -s $stop

        In which, -s $stop is an optional boolean parameter. If it is set to true, the eKuiper server will be stopped for the delete to take effect. The user will need to restart it manually. Sample:

        Unlike source and sink plugins, function plugin can export multiple functions at once. The exported names must be unique globally across all plugins. There will be a one to many mapping between function and its container plugin. Thus, we provide show udf(user defined function) command to query all user defined functions so that users can check the name duplication. And we provide udf describe command to find out the defined plugin of a function. We also provide the function register command to register the udf list for an auto loaded plugin.

        The command will list all user defined functions. 

        1. show udfs

        The command will show the plugin which defines the udf.

        1. describe udf $udf_name

        Sample output:

        1. {
        2.   "name": "funcName",
        3.   "plugin": "pluginName"
        4. }
        1. register plugin function $pluginName "{\"functions\":[\"$funcName\",\"$anotherFuncName\"]}"

        Sample: