MarkLogic Server 11.0 Product Documentation
plugin:enumerate

plugin:enumerate(
   $uri as xs:string,
   [$scope as xs:string]
) as map:map

Summary

This function enumerates functions implementing all capabilities supported by the given plugin. It returns a map, keyed on the capabilities.

Parameters
uri The unique identifier of the plugin.
scope A scope identifier. This must be a "dotted" package-style path, which will be resolved relative to the marklogic-dir/Assets/plugins directory. For example, a $scope value of my-plugin-scope is resolved to the marklogic-dir/Assets/plugins/myplugin-scope directory and a $scope value of my.plugin.scope is resolved to the marklogic-dir/Assets/plugins/my/plugin/scope directory.

Example


  xquery version "1.0-ml"; 

  import module namespace plugin = "http://marklogic.com/extension/plugin" 
      at "/MarkLogic/plugin/plugin.xqy";

  plugin:enumerate("plugin:collector-filescan.xqy")

  (: Returns the capabilities map for the filescan collector. :)
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy