Loading TOC...

admin.databaseSetJournaling

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

Summary

This function sets the journaling setting for the specified database in the configuration. When set to strict, the journal protects against MarkLogic Server process failures, host operating system kernel failures, and host hardware failures. When set to fast, the journal protects against MarkLogic Server process failures but not against host operating system kernel failures or host hardware failures. When set to off, the journal does not protect against MarkLogic Server process failures, host operating system kernel failures, or host hardware failures.

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 journaling 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');
  var config = admin.getConfiguration()
  admin.databaseSetJournaling(config, xdmp.database("myDatabase"),
        "strict")

   //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.