JavaScript admin.databaseSetFieldThreeCharacterWordPositions

MarkLogic 9 Product Documentation
admin:database-set-field-three-character-word-positions

admin:database-set-field-three-character-word-positions(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $field-name as xs:string,
   $value as xs:boolean?
) as element(configuration)

Summary

This function sets the field three character word positions setting for the specified field 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.
value	A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.

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()
  return
  admin:database-set-field-three-character-word-positions($config,
        xdmp:database("myDatabase"), "myField", fn:true())

  (: 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 9 Product Documentationadmin:database-set-field-three-character-word-positions

Summary

Required Privileges

Example

MarkLogic 9 Product Documentation
admin:database-set-field-three-character-word-positions