xdmp.forestOnline

xdmp.forestonlinexdmpforestonline

/apidoc/8.0/xdmp:forest-online.xml

Returns true if the specified forest is online with a state of open, open replica or sync replicating if isReplica is true, or syncing replica if syncingOk is true, otherwise returns false.

ID of the forest.

forestID

String

If the forest online status is older than the specified timestamp, consider it offline.

timestamp

String

Whether the forest is a replica.

isReplica

Boolean

Whether to return true if the forest is in "syncing replica" state.

syncingOk

Boolean

Boolean http://marklogic.com/xdmp/privileges/status

  xdmp.forestOnline(xdmp.forest("Documents"));
  => true

  xdmp.forestOnline(xdmp.forest("Documents"), 
     xdmp.wallclockToTimestamp(fn.currentDateTime()), true);
  => true if a forest is in open or sync-replicating state.