MarkLogic 10 Product Documentation

admin:database-get-field-included-elements

admin:database-get-field-included-elements(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $field-name as xs:string
) as element(db:included-element)*

Summary

This function returns the fields included elements specification for the specified database from the configuration.

Required 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-included-elements($config,
      xdmp:database("myDatabase"), "myField")
  (: returns the field settings :)