Loading TOC...

admin.odbcServerCreate

admin.odbcServerCreate(
   $config as element(configuration),
   $group-id as (Number|String),
   $appserver-name as String,
   $root as String,
   $port as (Number|String),
   $modules-id as Item,
   $database-id as (Number|String)
) 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

  
  const admin = require('/MarkLogic/admin.xqy');
  var config = admin.getConfiguration()
  var groupid = admin.groupGetId(config, "myGroup")
  admin.odbcServerCreate(config, groupid, "odbcServer",
       "/space/mycode", 5432, 0, xdmp.database("myDatabase") )

   //Creates and new ODBC App Server and returns the new configuration element --
   //use admin.saveConfiguration 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.