MarkLogic 12 Product Documentationadmin.databaseGetIndexExcludedPaths
admin.databaseGetIndexExcludedPaths( config as element(configuration), database-id as (Number|String) ) as Sequence
Summary
This function returns all index-excluded-path specifications configured for the specified database. If no exclusions are defined, 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")).
|
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');
admin.databaseGetIndexExcludedPaths(admin.getConfiguration(),
xdmp.database("Documents"))
=>
<excluded-path xmlns="http://marklogic.com/xdmp/database">
<excluded-path-expression>/root/embeddings</excluded-path-expression>
<excluded-collections>
<excluded-collection>vector</excluded-collection>
<excluded-collection>vector-json</excluded-collection>
</excluded-collections>
<excluded-directories>
<excluded-directory>/vec/</excluded-directory>
</excluded-directories>
</excluded-path>
// Returns the excluded path specifications defined for the
// "Documents" database