JavaScript admin.databaseSetFieldStemmedSearches

MarkLogic 12 EA 1 Product Documentation
admin:database-set-field-stemmed-searches

admin:database-set-field-stemmed-searches(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $field-name as xs:string,
   $value as xs:string?
) as element(configuration)

Summary

This function sets the field stemmed searches 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	The new stemmed search value. Must be one of `basic`, `advanced`, `decompounding`, or `off`. It must be equal to or greater than the database setting. The empty sequence turns this setting off for 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


  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-stemmed-searches($config,
        xdmp:database("myDatabase"), "myField", "decompounding")

  (: 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 12 EA 1 Product Documentationadmin:database-set-field-stemmed-searches

Summary

Required Privileges

Example

MarkLogic 12 EA 1 Product Documentation
admin:database-set-field-stemmed-searches