admin.databaseSetLocking

admin.databaseSetLocking(
   config as element(configuration),
   database-id as (Number|String),
   value as String
) as element(configuration)

Summary

This function sets the locking setting for the specified database in the configuration. When set to strict, locking enforces mutual exclusion on existing documents and on new documents. When set to fast, locking enforces mutual exclusion on existing documents but not on new documents. When set to off, locking does not enforce mutual exclusion on existing documents or on new documents.

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")` ).
value	The new locking value. Must be one of `strict`, `fast`, or `off`.

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');
  const config = admin.getConfiguration()
  admin.databaseSetLocking(config, xdmp.database("myDatabase"),
        "fast")

   //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.