MarkLogic Server 11.0 Product Documentation

xdmp:foreign-cluster-status

xdmp:foreign-cluster-status(
   $host-id as xs:unsignedLong,
   $foreign-cluster-id as xs:unsignedLong
) as element(foreign-cluster-status)

Summary

Returns the status of a foreign cluster from a host's point of view.

Required Privileges

Usage Notes

The structure of the data returned is as follows:

foreign-cluster-id

The foreign cluster ID.

foreign-cluster-name

The foreign cluster name.

host-id

The unique key of the host

interesting

Is this interesting.

bootstrapped

Is this bootstrapped.

last-successful-bootstrap

The time of the last bootstrap.

foreign-hosts

Information about foreign hosts.

This is a complex element with the following element children:

foreign-host

This is a complex element with the following element children:

foreign-host-id

The ID of the foreign host.

foreign-host-name

The name of the foreign host.

foreign-connect-port

The connect port for the foreign host.

online

Is this online.

secure

Is SSL enabled.

last-online

The time it was last online.

last-offline

The time it was last offline.

foreign-databases

Information about foreign databases.

This is a complex element with the following element children:

foreign-database

Information about a particular foreign database.

This is a complex element with the following element children:

foreign-database-id

The ID of the foreign database.

foreign-database-name

The name of the foreign database.

enabled

Is this enabled.

foreign-forest-ids

This is a complex element with the following element children:

foreign-forest-id

The ID of the foreign forest.

foreign-forests

Information about foreign forests.

This is a complex element with the following element children:

foreign-forest

Information about a particular foreign forest.

This is a complex element with the following element children:

foreign-forest-id

The ID of the foreign forest.

foreign-forest-name

The name of the foreign forest.

foreign-host-id

The ID of the foreign host.

Example

xquery version "1.0-ml";
xdmp:foreign-cluster-status(xdmp:bootstrap-hosts()[1],xdmp:cluster("SanFrancisco"))
=>

<foreign-cluster-status
  xmlns="http://marklogic.com/xdmp/status/foreign-cluster">
</foreign-cluster-status>