Loading TOC...
JavaScript admin.databaseSetLocking

admin:database-set-locking

admin:database-set-locking(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $value as xs: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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
  admin:database-set-locking($config, xdmp:database("myDatabase"),
        "fast")

  (: returns the new configuration element -- use admin:save-configuration
     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.