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

MarkLogic 12 Product Documentation
admin.databaseSetShutdownOnStorageFailure

admin.databaseSetShutdownOnStorageFailure(
   config as element(configuration),
   database-id as (Number|String),
   value as 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, `true` to enable shutdown on storage failure, `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


  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const dbid = admin.databaseGetId(config, "myDatabase")
  admin.databaseSetShutdownOnStorageFailure(config, dbid, fn.true())

   //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.

MarkLogic 12 Product Documentationadmin.databaseSetShutdownOnStorageFailure

Summary

Required Privileges

Example

MarkLogic 12 Product Documentation
admin.databaseSetShutdownOnStorageFailure