JavaScript admin.databaseGetFieldIncludeDocumentRoot

MarkLogic 9 Product Documentation
admin:database-get-field-include-document-root

admin:database-get-field-include-document-root(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $field-name as xs:string
) as xs:boolean

Summary

This function returns the field include document root setting for the specified field 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 (for example, `xdmp:database("myDatabase")`).
field-name	The name of the field.

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()
  return
  admin:database-get-field-include-document-root($config,
        xdmp:database("myDatabase"), "myField")
  (: returns the setting :)

MarkLogic 9 Product Documentationadmin:database-get-field-include-document-root

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin:database-get-field-include-document-root