Revision [570]
This is an old revision of ModuleMarkLogic made by DavidLee on 2009-05-27 09:41:38.
Mark Logic Module
Connectivity to a Mark Logic server is supported with an extension module.
Mark Logic support is via an Extension Module. It must be downloaded separately from xmlsh and added to the classpath in order to run.
Download
Mark Logic extension module is on sourceforge in the marklogic_ext package under xmlsh.Dowload the latest binary from marklogic_ext package
You also need the "xcc.jar" file from Mark Logic Developer Page (the Java XCC Distribution)
Importing
Import the marklogic extension in xmlsh with an "import module" statement.
The module can be found using the XMODPATH variable or explicitly by specifying the module.xml file
Copy the files (marklogic_ext.jar, xcc.jar, module.xml) to a directory named "marklogic" as a sub-directory of any path in the XMODPATH directory.
Then import the module using the "import module" command
Assuming you put the marklogic files in the directory /usr/local/xmlsh/ext/marklogic
XMODPATH=/usr/local/xmlsh/ext import module ml=marklogic
Configuring
To run Mark Logic commands you need to configure the connection information to access your Mark Logic server. All the Mark Logic commands require an environment variable, MLCONNECT to specify the connection. The format is the URI used by the XCC API.
xcc://user:password@host:port/Database
Note: the Port is the port number of an XDBC "Host" defined on the Mark Logic server.
Example
$ MLCONNECT=xcc://me:password@server:8003/Test
Instead of using an environment variable, you can also pass in the connection URI as a command argument using -c or -connect
Example
ml:query -c xcc://me:password@server:8003/Test -q "'Hello World'"
Running
Your now ready to run Mark Logic commands from within xmlsh.The following commands are supported
Extension Modules
