MarkLogic 10 Product Documentationadmin.databaseAddRangePathIndex
admin.databaseAddRangePathIndex( config as element(configuration), database-id as (Number|String), range-indexes as element(db.rangePathIndex)[] ) as element(configuration)
Summary
This function adds a range path index to the specified database 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")).
|
| range-indexes | An path range index specification, typically the result of an admin:database-range-path-index call. |
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
const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const dbid = xdmp.database("Documents")
const pathspec = admin.databaseRangePathIndex(
dbid,
"string",
"/a/b/c",
"http://marklogic.com/collation/",
fn.false(),
"ignore")
admin.databaseAddRangePathIndex(config, dbid, pathspec)
//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.
Example
//This is like the previous example, but adds a pathNamespace which
//is used in the path specification.
const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration()
const dbid = xdmp.database("Documents")
const ns = admin.databasePathNamespace("foo", "foo")
const config = admin.databaseAddPathNamespace(config, dbid, ns)
const pathspec = admin.databaseRangePathIndex(
dbid,
"string",
"/a/foo.b/c",
"http://marklogic.com/collation/",
fn.false(),
"ignore")
admin.databaseAddRangePathIndex(config, dbid, pathspec)
// 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.