Loading TOC...
XQuery admin:forest-set-failover-enable

MarkLogic Server 11.0 Product Documentation
admin.forestSetFailoverEnable

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

Summary

This function sets the forest failover enabled state for a forest configuration.

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 new failover-enable state of the forest, for example true for enabled, false for disabled.

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.forestSetFailoverEnable(config,
      admin.forestGetId(config, "Documents"),
      fn.true())
      => sets the failover state of the forest named "Documents" to
         the enabled state. 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.