Loading TOC...
XQuery admin:database-set-field-include-document-root

MarkLogic Server 11.0 Product Documentation
admin.databaseSetFieldIncludeDocumentRoot

admin.databaseSetFieldIncludeDocumentRoot(
   config as element(configuration),
   database-id as (Number|String),
   field-name as String,
   value as Boolean
) as element(configuration)

Summary

This function sets the field include document root setting for the specified field in 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.
value A boolean value, true to enable, false to disable.

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}

http://marklogic.com/xdmp/privileges/admin/database/index

http://marklogic.com/xdmp/privileges/admin/database/index/{id}

Example

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

   //returns the new configuration element -- use admin.saveConfiguration
   //to save the changes to the configuration or pass the configuration
   //to other Admin API functions to make other changes.

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