XQuery admin:appserver-get-modules-database

MarkLogic 10 Product Documentation
admin.appserverGetModulesDatabase

admin.appserverGetModulesDatabase(
   config as element(configuration),
   appserver-id as (Number|String)
) as (Number|String)

Summary

This function returns the ID of the database set as the modules database for the specified database.

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.

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}

Usage Notes

This function throws an exception if the specified App Server is a WebDAV server (because WebDAV servers do not use a modules database).

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const groupid = admin.groupGetId(config, "Default")
  admin.appserverGetModulesDatabase(config,
             admin.appserverGetId(config, groupid, "myAppServer"))
Powered by MarkLogic Server | Terms of Use | Privacy Policy