MarkLogic 9 Product Documentation

admin:appserver-set-default-query-time-limit

admin:appserver-set-default-query-time-limit(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong,
   $value as xs:unsignedInt
) as element(configuration)

Summary

This function sets the default SQL query time limit (the maximum total amount of time to service a SQL query before the App Server throws a timeout exception) in the configuration for the specified App Server; the value applies only to an ODBC server.

Required Privileges

http://marklogic.com/xdmp/privileges/admin/app-server

http://marklogic.com/xdmp/privileges/admin/app-server/{id}

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

http://marklogic.com/xdmp/privileges/admin/group/{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()
  let $groupid := admin:group-get-id($config, "Default")
  return
  admin:appserver-set-default-query-time-limit($config,
         admin:appserver-get-id($config, $groupid, "myAppServer"),
         10000)

  (: returns the new configuration element -- use admin:save-configuration
     to save the changes to the configuration or pass the configuration
     to other Admin API functions to make other changes.  :)