MarkLogic 12 Product Documentationadmin:database-get-index-excluded-paths
admin:database-get-index-excluded-paths( $config as element(configuration), $database-id as xs:unsignedLong ) as element(db:excluded-path)*
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
xquery version "1.0-ml";
import module namespace admin = "http://marklogic.com/xdmp/admin"
at "/MarkLogic/admin.xqy";
admin:database-get-index-excluded-paths(admin:get-configuration(),
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 :)