MarkLogic 12 Product Documentation

tieredstorage.partitionSetAvailability

tieredstorage.partitionSetAvailability(
   database-id as (Number|String),
   partition-name as String,
   value as String
) as null

Summary

This function sets the availability of the partition to either online or offline. An online partition is fully accessable through queries when its forests are attached to a database. The forests in an offline partition, as well as any replica forests, cannot be accessed.

Example

// Takes the 2017-October partition in the Documents database offline.

const ts = require('/MarkLogic/tieredstorage');

declareUpdate();
ts.partitionSetAvailability(xdmp.database('Documents'), '2017-April', 'offline');