MarkLogic 12 EA 1 Product Documentation
admin.databaseAddField

admin.databaseAddField(
   config as element(configuration),
   database-id as (Number|String),
   fields as element(db.field)[]
) as element(configuration)

Summary

This function adds the field specification to 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")` ).
fields	The field specification, typically the result of an `admin.databaseField` 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.databaseField("myField", fn.true() )
  admin.databaseAddField(config, dbid, 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 12 EA 1 Product Documentationadmin.databaseAddField

Summary

Required Privileges

Example

MarkLogic 12 EA 1 Product Documentation
admin.databaseAddField