MarkLogic 9 Product Documentationadmin:forest-get-id
admin:forest-get-id( $config as element(configuration), $forest-name as xs:string ) as xs:unsignedLong
Summary
This function returns the ID of the forest with the specified
name, from the specified configuration. The difference
between this function and xdmp:forest() is that
the ID from this function can come from a forest that has not
yet been saved (that is, from a forest that has been created
in the same query with the Admin library but has not yet
been saved to the cluster configuration files).
| Parameters | |
|---|---|
| config | A configuration specification, typically as returned from one of the Admin module functions. |
| forest-name | The name of the forest. |
Required Privileges
This operation requires at least one of the following privileges: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"; admin:forest-get-id(admin:get-configuration(), "myForest")