MarkLogic 12 Product Documentation

admin.databaseAddIndexExcludedPath

admin.databaseAddIndexExcludedPath(
   config as element(configuration),
   database-id as (Number|String),
   index-excluded-paths as element(db.excludedPath)[]
) as element(configuration)

Summary

This function adds one or more index-excluded-path specifications to the specified database. Multiple exclusion rules can be configured with the same path but different collections and directories. When multiple exclusion rules are configured, the effective exclusion results from the union of all rules.

Required 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 excludedPath = admin.databaseIndexExcludedPath(
                         "/root/embeddings", 
                         ["vector", "vector-json"], 
                         ["/vec/"])
    admin.databaseAddIndexExcludedPath(config, dbid, excludedPath)
   //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.