Loading TOC...
JavaScript admin.databaseGetRetiredForests

MarkLogic 12 EA 2 Product Documentation
admin:database-get-retired-forests

admin:database-get-retired-forests(
   $config as element(configuration),
   $database-id as xs:unsignedLong
) as xs:unsignedLong*

Summary

This function returns the list of all retired forests for the specified database from the configuration.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
database-id The ID of the database.

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}

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
        at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $dbid := admin:database-get-id($config, "myDatabase")
  return
  admin:database-get-retired-forests($config, $dbid)
  (: returns the IDs of all retired forests for the database :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.