xdmp.gunzip(
gzipnode as binary(),
options as Object?
) as Sequence
Summary
Get a node from a gzip node. Gunzips and returns the file in
memory as a document node (for XML and JSON formats), a text node (for text formats),
or a binary node (for binary formats).
The format is determined by the format option.
Parameters
gzipnode
The gzip node.
options
The options
object
for gunzipping this gzip document.
The
xdmp.gunzip
options include:
defaultNamespace
(XML only) 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 implicitly specified by the
language of the caller. From JavaScript,
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
(XML only) 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. 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.
Usage Notes
You must tell the format of the node after gunzipping.
You need to specify a format in the optionsobject
Example
xdmp.gunzip(fn.doc("/gzip/tmp.gz"),
{
"format" : "binary"
})
=> the gunzip node from the "/gzip/tmp.gz" gzip node
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.