Loading TOC...

admin.databaseAddDefaultRuleset

admin.databaseAddDefaultRuleset(
   $config as element(configuration),
   $database-id as (Number|String),
   $rulesets as element(db.defaultRuleset)[]
) as element(configuration)

Summary

This function adds a ruleset (db:ruleset) to be used for inference on a database. One or more rulesets can be used for inference. By default, no ruleset is configured.

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"))
$rulesets The name of one or more rulesets to be used with this database for inference.

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');
  var config = admin.getConfiguration()
  var dbid = admin.databaseGetId(config, "myDatabase")
  var rules = admin.databaseRuleset("subClassOf.rules")
  var c = admin.databaseAddDefaultRuleset(config, dbid, rules)
  admin.saveConfiguration(c)

   //Adds the subClassOf.rules ruleset to "myDatabase" 
   // 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.  
    

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