Loading TOC...
JavaScript admin.databaseSetShutdownOnStorageFailure

admin:database-set-shutdown-on-storage-failure

admin:database-set-shutdown-on-storage-failure(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $value as xs:boolean
) as element(configuration)

Summary

This function sets the shutdown on storage failure for the specified database in the configuration. If it is enabled, the host is shutdown automatically after storage failure is detected.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
database-id The ID of the database.
value A boolean value, fn:true() to enable shutdown on storage failure, fn:false() to disable shutdown on storage failure.

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()
  let $dbid := admin:database-get-id($config, "myDatabase")
  return
  admin:database-set-shutdown-on-storage-failure($config, $dbid, fn:true())

  (: 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.