MarkLogic 9 Product Documentation
admin.forestSetUpdatesAllowed

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

Summary

This function sets the updates-allowed 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 updates-allowed state of the forest. Must be one of `all` for all updates allowed, `delete-only` for only deletes allowed, `read-only` for no updates allowed and to cause updating transactions to abort immediately, `flash-backup` for no updates allowed and to make updating transactions retry for a time period specified in the group's retry timeout.

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');
  var config = admin.getConfiguration()
  admin.forestSetUpdatesAllowed(config,
      admin.forestGetId(config, "Documents"),
      "deleteOnly")
      => sets the updatesAllowed state of the forest named "Documents" to
         the true state. Use admin.saveConfiguration to save the changes
         to the configuration or pass the configuration to other Admin API
         functions to make other changes.

MarkLogic 9 Product Documentationadmin.forestSetUpdatesAllowed

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.forestSetUpdatesAllowed