Loading TOC...

MarkLogic 10 Product Documentation
configdsl and configast functions (Config Scripting)

This is the Config AST module, which is used to parse and process the Config AST JSON representation of a configuration specified using the functions of the Admin API.

Where the Config DSL provides a declaration of configuration for editing by people, the Config AST provides a declaration for generation and manipulation by scripts, tools, and APIs.

To use this module in your XQuery code, include an import statement similar to following line in your code:

                   import module namespace configast = "http://marklogic.com/config-ast-json"
                       at "/MarkLogic/builder/config-ast-json.xqy";
        

This is the Config DSL module, which is used to parse and process the Config DSL representation of a configuration specified using the functions of the Admin API. The Config DSL representation uses a narrow subset of JavaScript syntax consisting of the JavaScript statements that build the configuration changes.

Where the Config AST provides a declaration of configuration for generation and manipulation by scripts, tools, and APIs, the Config DSL provides a declaration for editing by people.

To use this module in your Server-Side JavaScript code, include an import statement similar to following line in your code:

                   import configDSL from '/MarkLogic/builder/config-dsl-js.mjs';
        
2 functions
Function name Description
configast.apply This function takes the Config AST representation of a server configuration for parsing and processing as a JSON object or XQuery map and applies the configuration using the functions of the Admin API.
configdsl.apply This function takes the Config DSL representation of a server configuration for parsing and processing as a string or text and applies the configuration using the functions of the Admin API.