MarkLogic 12 EA 1 Product Documentation
admin.databaseAddFieldPaths

admin.databaseAddFieldPaths(
   config as element(configuration),
   database-id as (Number|String),
   field-name as String,
   field-paths as element(db.fieldPath)[]
) as element(configuration)

Summary

This function adds given paths to the field specified by field-name.

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.
field-paths The sequence of field-path elements, typically created using admin:database-field-path call.

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 db="http://marklogic.com/xdmp/database";
const p = admin.databaseFieldPath("/a/b/@c", 3.0)
const config = admin.getConfiguration()
const dbid = xdmp.database("Documents")
const fieldName = "pathAttr1"
admin.databaseAddFieldPaths(config, dbid, fieldName, p)
   => 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.
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy