Loading TOC...
XQuery admin:appserver-set-modules-database

MarkLogic 10 Product Documentation
admin.appserverSetModulesDatabase

admin.appserverSetModulesDatabase(
   config as element(configuration),
   appserver-id as (Number|String),
   value as Item
) as element(configuration)

Summary

This function sets the value in the configuration of modules database for the specified App Server to the specified database ID.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
appserver-id The ID of the App Server. Typically, this is the result of an admin.appserverGetId call.
value The database ID for the database to set as the modules database. To specify the filesystem, use 0 or "file-system"

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server

http://marklogic.com/xdmp/privileges/admin/app-server/{id}

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Usage Notes

Any database whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the database, do so in a separate transaction before using them in in this function.

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.appserverSetModulesDatabase(config,
         admin.appserverGetId(config, groupid, "myAppServer"),
         xdmp.database("Modules"))

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.