MarkLogic Server 11.0 Product Documentationadmin.databaseSetEncryptionKeyId
admin.databaseSetEncryptionKeyId( config as element(configuration), database-id as (Number|String), encryption-key-id as String ) as element(configuration)
Summary
This function sets the encryption key ID to use for encryption of data
for the database identified by 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 copy (for example,
xdmp.database("myDatabase")).
|
| encryption-key-id | An string identifying the encryption key at the KMS that should be use to encrypt user data. The string must be a URN representation of a UUID as defined by RFC4122: http://www.ietf.org/rfc/rfc4122.txt Example URN: 06ea22c9-b972-4652-8d0f-9e58c62e0f7f |
Example
const admin = require('/MarkLogic/admin.xqy');
const config = admin.getConfiguration();
admin.databaseSetEncryptionKeyId(config, xdmp.database('myDatabase'), 'c5c37ee2-31f4-4bba-ab8e-98352f900a17');
// 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.