Loading TOC...

admin.databaseGetFieldThreeCharacterSearches

admin.databaseGetFieldThreeCharacterSearches(
   config as element(configuration),
   database-id as (Number|String),
   field-name as String
) as Boolean?

Summary

This function returns true if the three character searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.

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.

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}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  admin.databaseGetFieldThreeCharacterSearches(config,
        xdmp.database("myDatabase"), "myField")

   //returns the setting 
  

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.