XQuery admin:database-set-word-query-include-document-root

MarkLogic 9 Product Documentation
admin.databaseSetWordQueryIncludeDocumentRoot

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

Summary

This function sets the word query 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")`).
value	A boolean value, `fn:true()` to enable, `fn: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');
  var config = admin.getConfiguration()
  admin.databaseSetWordQueryIncludeDocumentRoot(config,
        xdmp.database("myDatabase"), fn.false())

   //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.

MarkLogic 9 Product Documentationadmin.databaseSetWordQueryIncludeDocumentRoot

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin.databaseSetWordQueryIncludeDocumentRoot