Loading TOC...
XQuery admin:forest-set-host

MarkLogic 12 Product Documentation
admin.forestSetHost

admin.forestSetHost(
   config as element(configuration),
   forest-id as (Number|String),
   value as (Number|String)
) as element(configuration)

Summary

This function sets a forest configuration to a new host.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
forest-id The ID of the forest. For example, xdmp.forest("myForest") specifies the ID for a forest named "myForest".
value The host ID of the new host.

Required Privileges

This operation requires at least one of the following privileges:

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

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

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

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  admin.forestSetHost(config, admin.forestGetId(config, "Documents"),
              xdmp.host("myNewHost"))
   => 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.