JavaScript admin.databaseAddFieldIncludedElement

MarkLogic Server 11.0 Product Documentation
admin:database-add-field-included-element

admin:database-add-field-included-element(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $field-name as xs:string,
   $included-elements as element(db:included-element)*
) 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:database-included-element` 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";

  let $config := admin:get-configuration()
  let $dbid := xdmp:database("myDatabase")
  let $fieldspec :=   admin:database-included-element("http://myuri/namespace",
  "element-name", 1.0, "", "myAttribute", "some value")
  return
  admin:database-add-field-included-element($config, $dbid,
       "myField", $fieldspec)

  (: 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.  :)

MarkLogic Server 11.0 Product Documentationadmin:database-add-field-included-element

Summary

Required Privileges

Example

MarkLogic Server 11.0 Product Documentation
admin:database-add-field-included-element