MarkLogic Server 11.0 Product Documentation

admin.groupGetId

admin.groupGetId(
   config as element(configuration),
   group-name as String
) as (Number|String)

Summary

This function returns the ID of the group. The difference between this function and xdmp:group() is that the ID from this function can come from a group that has not yet been saved (that is, from a group 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 group without the need to first save the configuration.

Required Privileges

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

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

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  admin.groupGetId(config, "myGroup"))

   //returns the group ID