configdsl.apply

configdsl.apply(
   source as String
) as the output, if any, from the functions of the Admin API

Summary

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.

Usage Notes

The Conig DSL builds the configurations with the same functions used in the Admin API. Namespaces are all predefined including the admin namespace for the Admin API functions. The final operation in the DSL returns the output.

the Config DSL is similar to theQuery DSL for Optic API in the Application Developer's Guide

The same JavaScript syntax is the same in the Config DSL as in the Query DSL.

The vocabulary (including expression functions) is the same in the Config DSL and Query DSL with the following exceptions:

• The functions of the Admin API are supported only in the Config DSL.
• xdmp administrative functions that look up identifiers for named server resources are supported only in the Config DSL.
• From the op namespace, only the operator functions are supported in the Config DSL. Accessor and helper functions of the op namespace are not supported in the Config DSL.

The conveniences are the same in the Config DSL and Query DSL with the following exceptions:

• the $a convenience can be used instead of the admin namespace to omit the initial configuration parameter on a call and to chain calls that return a modified configuration.
• The $c convenience for specifying columns is not supported because the Config DSL has no columns.

The Config DSL supports the two functions provided by the Admin API to apply configuration changes: saveConfiguration() and saveConfigurationWithoutRestart().

Thus, a single DSL can save configuration to create the precondition for a subsequent configuration. For instance, a single Config DSL can save a series of configurations that create forests, create databases that use the forests, and then create appservers that use the databases.

In this respect, the Config DSL differs from the Query DSL, which builds a query for execution or other processing in the Optic API.

The apply() function throws an error if the Config DSL contains:

• Unsupported JavaScript syntax - such as JavaScript variable or function definitions.
• Calls to native JavaScript functions - such as the eval() or require() functions.
• An unsupported namespace - such as search.
• An unsupported namespaced function - such as the xdmp.eval() function.

Example

import configDSL from '/MarkLogic/builder/config-dsl-js.mjs';

configDSL.apply(`

const db = xdmp.database('Documents');
$a.databaseSetFastCaseSensitiveSearches(db, true)
  .databaseSetFastDiacriticSensitiveSearches(db, true)
  .databaseSetFastPhraseSearches(db, false)
  .saveConfiguration();

`);