MarkLogic 10 Product Documentationadmin:database-add-field-paths
admin:database-add-field-paths( $config as element(configuration), $database-id as xs:unsignedLong, $field-name as xs:string, $field-paths as element(db:field-path)* ) 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
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
declare namespace db="http://marklogic.com/xdmp/database";
let $p := admin:database-field-path("/a/b/@c", 3.0)
let $config := admin:get-configuration()
let $dbid := xdmp:database("Documents")
let $field-name := "pathAttr1"
return
admin:database-add-field-paths($config, $dbid, $field-name, $p)
=> returns the new configuration element -- use admin:save-configuration
to save the changes to the configuration or pass the configuration
to other Admin API functions to make other changes.