XQuery xdmp:document-get

MarkLogic 12 EA 1 Product Documentation
xdmp.documentGet

xdmp.documentGet(
   location as String,
   [options as Object?]
) as Sequence

Summary

Returns the document in the file specified by $location.

Parameters
location The location of the input document. If the scheme of the location is HTTP (that is, if the string starts with "http://"), then the document is requested over HTTP. If the scheme is file (that is, if the string starts with "file://"), then the document is requested over file protocol from the local filesystem. Otherwise, the document is fetched from the local filesystem. On the filesystem, the path can be fully qualified or relative. Relative pathnames are resolved from the directory in which MarkLogic Server is installed.
options Options with which to customize this operation. This function supports the following options, as well as options from xdmp.httpGet when retrieving content via an HTTP request.

defaultNamespace

The namespace to use if there is no namespace at the root node of the document. The default value is "".

repair

A value of full specifies that malformed XML content be repaired. A value of none specifies that malformed XML content is rejected.

If no repair option is explicitly specified, the default is none.

This option has no effect on binary, text or JSON documents.

format

A value of text specifies to get the document as a text document, regardless of the URI specified. A value of binary specifies to get the document as a binary document, regardless of the URI specified. A value of xml specifies to get the document as an XML document, regardless of the URI specified. A value of json specifies to get the document as a JSON document, regardless of the URI specified.

defaultLanguage

The language to specify in an xml:lang attribute on the root element node if the root element node does not already have an xml:lang attribute. This option applies only to XML documents. If this option is not specified, then nothing is added to the root element node.

encoding

Specifies the encoding to use when reading the document into MarkLogic Server. The value must either be "auto" or match an encoding name according to the Unicode Charset Alias Matching rules (http://www.unicode.org/reports/tr22/#Charset_Alias_Matching). When the value is "auto", MarkLogic guesses the encoding from the document content. For a list of character set encodings by language, see Collations and Character Sets By Language in the Search Developer's Guide. If you do not set this option, MarkLogic uses the encoding specified in the HTTP headers, if present. If you do not set this option and no encoding is available from HTTP headers, the encoding defaults to UTF-8. For more details, see Character Encoding in the Search Developer's Guide.

Required Privileges

http://marklogic.com/xdmp/privileges/xdmp-document-get

Usage Notes

If no format is specified in $options, and the document is from an HTTP server, the format is specified by the document content type from the HTTP response. If no format is specified in $options, and the document is from the filesystem, the format is specified by the document content type from the filename extension. The mimetype extensions and corresponding content types are set in the Admin Interface.

When the document is from an HTTP server, xdmp.documentGet will always return the response from the HTTP server, even if it is an error response such as 404 or 500. If you want to be able to examine the response header in your application, use the xdmp.httpGet instead, which returns both the response header and the response.

Example

  xdmp.documentGet("myDocument.json")
  => A Sequence containing the JSON document 
        in myDocument.json, for example, {"foo" : "bar"};

Example

  fn.head(xdmp.documentGet("http://myCompany.com/file.json",
       {
         "format" : "json",
         "authentication" : {
           "username" : "user",
           "password" : "pass"
         }
       })).root;
  => gets a JSON document named file.json, sending the
     authentication credentials user/pass to the
     http://myCompany.com server.  Note the fn.head 
     gets you to the first item in the Sequence, and the 
     .root gets you past the document node into the json object.
Powered by MarkLogic Server | Terms of Use | Privacy Policy