admin.databaseGetFieldIncludeDocumentRoot

admin.databaseGetFieldIncludeDocumentRoot(
   config as element(configuration),
   database-id as (Number|String),
   field-name as String
) as 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

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  admin.databaseGetFieldIncludeDocumentRoot(config,
        xdmp.database("myDatabase"), "myField")

   //returns the setting 
  
Powered by MarkLogic Server | Terms of Use | Privacy Policy