XQuery admin:database-add-field-word-lexicon

MarkLogic 10 Product Documentation
admin.databaseAddFieldWordLexicon

admin.databaseAddFieldWordLexicon(
   config as element(configuration),
   database-id as (Number|String),
   field-name as String,
   word-lexicons as element(db.wordLexicon)[]
) as element(configuration)

Summary

This function adds a word lexicon 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")` ).
field-name	The name of the field.
word-lexicons	A word lexicon specification, typically the result of an `admin.databaseWordLexicon` 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("Documents")

  const lexspec = admin.databaseWordLexicon("http://marklogic.com/collation/")
  admin.databaseAddFieldWordLexicon(config, dbid, "myField", lexspec)
   //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 10 Product Documentationadmin.databaseAddFieldWordLexicon

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin.databaseAddFieldWordLexicon