XQuery admin:database-add-field-tokenizer-override

MarkLogic 10 Product Documentation
admin.databaseAddFieldTokenizerOverride

admin.databaseAddFieldTokenizerOverride(
   config as element(configuration),
   database-id as (Number|String),
   field-name as String,
   tokenizer-overrides as element(db.tokenizerOverride)[]
) as element(configuration)

Summary

This function adds tokenizer overrides for the specified field of the specified database. For details, see Custom Tokenization in the Search Developer's Guide.

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.
tokenizer-overrides	The new tokenizer override settings to add to the field.

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 override =  admin.databaseTokenizerOverride("-","word")
  admin.databaseAddFieldTokenizerOverride(
    config, dbid, "myField", override)

 //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.databaseAddFieldTokenizerOverride

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin.databaseAddFieldTokenizerOverride