Loading TOC...
JavaScript admin.odbcServerCreate

MarkLogic 12 EA 2 Product Documentation
admin:odbc-server-create

admin:odbc-server-create(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $appserver-name as xs:string,
   $root as xs:string,
   $port as xs:unsignedLong,
   $modules-id as item(),
   $database-id as xs:unsignedLong
) as element(configuration)

Summary

This function creates a new ODBC App Server with the specified name, root, and port in the configuration.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The ID of the group to which the App Server belongs. Typically, this is the result of an admin:group-get-id call.
appserver-name The name of the App Server. The name must be unique among the App Server names for the group.
root The root of the App Server.
port The port on which the App Server listens. The port must be available on the host.
modules-id The ID of the modules database (for example, xdmp:database("Modules") ). To specify the filesystem, use 0 or "file-system"
database-id The ID of the database (for example, xdmp:database("myDatabase") ).

Required Privileges

This operation requires at least one of the following privileges:

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

http://marklogic.com/xdmp/privileges/admin/group-security/{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, "myGroup")
  return
  admin:odbc-server-create($config, $groupid, "odbcServer",
       "/space/mycode", 5432, 0, xdmp:database("myDatabase") )

  (: Creates and new ODBC App Server and 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.