Loading TOC...
JavaScript admin.databaseDetachForest

MarkLogic Server 11.0 Product Documentation
admin:database-detach-forest

admin:database-detach-forest(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $forest-id as xs:unsignedLong
) as element(configuration)

Summary

This function detaches the specified forest from the specified database.

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

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/database/forests

http://marklogic.com/xdmp/privileges/admin/database/forests/{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:
  database-detach-forest($config, xdmp:database("myDatabase"),
        xdmp:forest("myForest") )

   => returns the new configuration element -- use admin:save-configuration
      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.