Loading TOC...
JavaScript admin.hostGetId

MarkLogic 12 EA 1 Product Documentation
admin:host-get-id

admin:host-get-id(
   $config as element(configuration),
   $host-name as xs:string
) as xs:unsignedLong

Summary

This function return the ID for the specified host from the configuration. The difference between this function and xdmp:host() is that the ID from this function can come from a host that has not yet been saved (that is, from a host that has been created in the same query with the Admin library but has not yet been saved to the cluster configuration files). This ID enables you to completely configure a newly created host without the need to first save the configuration.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
host-name The name of the host. If the host is the current host, xdmp:host-name() returns the name.

Required Privileges

This operation requires at least one of the following privileges:

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

http://marklogic.com/xdmp/privileges/admin/host/{id}

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  return
  admin:host-get-id($config, xdmp:host-name())
  (: returns the host ID :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.