JavaScript admin.forestSetUpdatesAllowed

MarkLogic 12 EA 1 Product Documentation
admin:forest-set-updates-allowed

admin:forest-set-updates-allowed(
   $config as element(configuration),
   $forest-id as xs:unsignedLong,
   $value as xs: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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
  admin:forest-set-updates-allowed($config,
      admin:forest-get-id($config, "Documents"),
      "delete-only")

      => sets the updates-allowed state of the forest named "Documents" to
         the true state. Use admin:save-configuration to save the changes
         to the configuration or pass the configuration to other Admin API
         functions to make other changes.

MarkLogic 12 EA 1 Product Documentationadmin:forest-set-updates-allowed

Summary

Required Privileges

Example

MarkLogic 12 EA 1 Product Documentation
admin:forest-set-updates-allowed