Loading TOC...

admin.appserverAddSchema

admin.appserverAddSchema(
   $config as element(configuration),
   $appserver-id as (Number|String),
   $schemas as element(gr.schema)[]
) as element(configuration)

Summary

This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified App Server. Schemas with a schema binding definition are automatically imported into queries run against the App Server.

Parameters
$config A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id The ID of the App Server. Typically, this is the result of an admin:appserver-get-id call.
$schemas A list of schema specification elements of the form:

<schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://marklogic.com/xdmp/group">
  <namespace-uri>foo</namespace-uri>
  <schema-location>/foo.xsd</schema-location>
</schema>
Typically the result of an admin:group-schema call.

Required Privileges

This operation requires at least one of the following 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-add-schema($config,
         admin:appserver-get-id($config, $groupid, "myAppServer"),
  <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="http://marklogic.com/xdmp/group">
     <namespace-uri>foo</namespace-uri>
     <schema-location>/foo.xsd</schema-location>
  </schema>)

  (: 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.  :)

  

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