MarkLogic 10 Product Documentation
admin:foreign-cluster-set-name

admin:foreign-cluster-set-name(
   $config as element(configuration),
   $cluster-id as xs:unsignedLong,
   $cluster-name as xs:string
) as element(configuration)

Summary

This function sets the name of a foreign cluster.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
cluster-id	The ID of the foreign cluster.
cluster-name	The name to be set for the foreign cluster. Name will be cast to the `xs:token` type.

Required Privileges

http://marklogic.com/xdmp/privileges/admin/cluster

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $cfg := admin:get-configuration()
  let $fcl := admin:cluster-get-foreign-cluster-id($cfg, "ClusterA")

  return  admin:foreign-cluster-set-name($cfg, $fcl, "replica")

  (: Sets the name of the 'ClusterA' foreign cluster to 'replica'.  Use
     admin:save-configuration to save the changes to the configuration or
     pass the configuration to other Admin API functions to make other changes. :)

MarkLogic 10 Product Documentationadmin:foreign-cluster-set-name

Summary

Required Privileges

Example

MarkLogic 10 Product Documentation
admin:foreign-cluster-set-name