XQuery admin:database-add-field-included-element

MarkLogic Server 11.0 Product Documentation
admin.databaseAddFieldIncludedElement

admin.databaseAddFieldIncludedElement(
   config as element(configuration),
   database-id as (Number|String),
   field-name as String,
   included-elements as element(db.includedElement)[]
) as element(configuration)

Summary

This function adds the field included element specification tn the specified database 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.
included-elements	The included elements specification, typically the result of an `admin.databaseIncludedElement` 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 config = admin.getConfiguration()
  const dbid = xdmp.database("myDatabase")

  const fieldspec =   admin.databaseIncludedElement("http://myuri/namespace",
  "elementName", 1.0, "", "myAttribute", "some value")
  admin.databaseAddFieldIncludedElement(config, dbid,
       "myField", fieldspec)
   //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 Server 11.0 Product Documentationadmin.databaseAddFieldIncludedElement

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin.databaseAddFieldIncludedElement