MarkLogic 10 Product Documentation
admin.databaseGetBackupEncryption

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

Summary

This function returns the backup encryption key used for encryption of backup for the database identified by the database-id.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
database-id The ID of the database to get (for example, xdmp.database("myDatabase")).

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.databaseGetBackupEncryptionKey(config, xdmp.database('myDatabase'));

// returns which key is used for encryption of backup
   
Powered by MarkLogic Server | Terms of Use | Privacy Policy