Difference between revisions of "Serialization"

From BaseX Documentation
Jump to navigation Jump to search
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This page is part of the [[XQuery|XQuery Portal]].
 
This page is part of the [[XQuery|XQuery Portal]].
  
Serialization parameters define how XQuery items and XML nodes will be ''serialized'' (i.e., returned to the client or an API, usually in textual form). The official parameters are defined in the [https://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document. In BaseX, they can be specified by:
+
Serialization parameters define how XQuery items and XML nodes will be ''serialized'' (i.e., returned to the client or an API, usually in textual form). The official parameters are defined in the [https://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document. In BaseX, they can be:
  
* including them in the [[XQuery_3.0#Serialization|prolog of the XQuery expression]];
+
* included in the [[XQuery_3.0#Serialization|prolog of the XQuery expression]];
* specifying them in the XQuery functions [[File_Module#file:write|file:write()]] or [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()]. The serialization parameters are specified as
+
* specified in XQuery functions ({{Function|File|file:write}}, {{Function|Database|db:export}}, [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()]);
** children of an {{Code|<output:serialization-parameters/>}} element, or as
+
* specified in [[REST#Parameters|REST query parameters]];
** map, which contains all key/value pairs: <code>map { "method": "xml", "cdata-section-elements": "div", ... }</code>;
+
* specified in [[RESTXQ#Output|RESTXQ output annotations]];
* using the {{Code|-s}} flag of the BaseX [[Command-Line Options#BaseX Standalone|command-line]] clients;
+
* set via the {{Option|SERIALIZER}} option before running a query;
* setting the {{Option|SERIALIZER}} option before running a query;
+
* set via the {{Option|EXPORTER}} option before exporting a database; or
* setting the {{Option|EXPORTER}} option before exporting a database; or
+
* supplied with the {{Code|-s}} flag of the BaseX [[Command-Line Options#BaseX Standalone|command-line]] clients.
* setting them as [[REST#Parameters|REST]] query parameters.
 
  
 
The namespace for serialization parameters is statically bound to the {{Code|output}} prefix. This means that it need not (but may) be declared in the query prolog:
 
The namespace for serialization parameters is statically bound to the {{Code|output}} prefix. This means that it need not (but may) be declared in the query prolog:
Line 50: Line 49:
 
| {{Code|item-separator}}
 
| {{Code|item-separator}}
 
| Determines a string to be used as item separator. If a separator is specified, the default separation of atomic values with single whitespaces will be skipped.
 
| Determines a string to be used as item separator. If a separator is specified, the default separation of atomic values with single whitespaces will be skipped.
| ''arbitrary strings''
+
| ''string''
| ''empty''
+
|
 
|- valign="top"
 
|- valign="top"
 
| {{Code|encoding}}
 
| {{Code|encoding}}
Line 59: Line 58:
 
|- valign="top"
 
|- valign="top"
 
| {{Code|indent}}
 
| {{Code|indent}}
| Adjusts whitespaces to make the output better readable.
+
| Adds leading whitespaces to make the output more readable.
 
| {{Code|yes}}, {{Code|no}}
 
| {{Code|yes}}, {{Code|no}}
| {{Code|yes}}
+
| {{Code|no}} {{Announce|Default changed with Version 10}}
 
|- valign="top"
 
|- valign="top"
 
| {{Code|cdata-section-elements}}
 
| {{Code|cdata-section-elements}}
 
| List of elements to be output as CDATA, separated by whitespaces.<br />Example: {{Code|&lt;text&gt;&lt;![CDATA[ &lt;&gt; ]]&gt;&lt;/text&gt;}}
 
| List of elements to be output as CDATA, separated by whitespaces.<br />Example: {{Code|&lt;text&gt;&lt;![CDATA[ &lt;&gt; ]]&gt;&lt;/text&gt;}}
|  
+
| ''string''
 
|  
 
|  
 
|- valign="top"
 
|- valign="top"
Line 74: Line 73:
 
|- valign="top"
 
|- valign="top"
 
| {{Code|standalone}}
 
| {{Code|standalone}}
| Prints or omits the "standalone" attribute in the XML declaration.
+
| Prints or omits the {{Code|standalone}} attribute in the XML declaration.
 
| {{Code|yes}}, {{Code|no}}, {{Code|omit}}
 
| {{Code|yes}}, {{Code|no}}, {{Code|omit}}
 
| {{Code|omit}}
 
| {{Code|omit}}
Line 80: Line 79:
 
| {{Code|doctype-system}}
 
| {{Code|doctype-system}}
 
| Introduces the output with a document type declaration and the given system identifier.<br />Example: {{Code|&lt;!DOCTYPE x SYSTEM "entities.dtd"&gt;}}
 
| Introduces the output with a document type declaration and the given system identifier.<br />Example: {{Code|&lt;!DOCTYPE x SYSTEM "entities.dtd"&gt;}}
|
+
| ''string''
 
|
 
|
 
|- valign="top"
 
|- valign="top"
 
| {{Code|doctype-public}}
 
| {{Code|doctype-public}}
 
| If {{Code|doctype-system}} is specified, adds a public identifier.<br />Example: {{Code|&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "<nowiki>http://www.w3.org/TR/html4/strict.dtd</nowiki>"&gt;}}
 
| If {{Code|doctype-system}} is specified, adds a public identifier.<br />Example: {{Code|&lt;!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "<nowiki>http://www.w3.org/TR/html4/strict.dtd</nowiki>"&gt;}}
|  
+
| ''string''
 
|
 
|
 
|- valign="top"
 
|- valign="top"
Line 100: Line 99:
 
| {{Code|media-type}}
 
| {{Code|media-type}}
 
| Specifies the media type.
 
| Specifies the media type.
|  
+
| ''string''
 
| {{Code|application/xml}}
 
| {{Code|application/xml}}
 
|- valign="top"
 
|- valign="top"
 
| {{Code|parameter-document}}
 
| {{Code|parameter-document}}
| Parses the value as XML document with additional serialization parameters (see the [https://www.w3.org/TR/xslt-xquery-serialization-31/#serparams-in-xdm-instance Serialization Specification] for more details).
+
| Parses the value as XML document with additional serialization parameters (see the [https://www.w3.org/TR/xslt-xquery-serialization-31/#serparams-in-xdm-instance Specification] for more details and examples).
|  
+
| ''string''
 
|  
 
|  
 
|- valign="top"
 
|- valign="top"
 
| {{Code|use-character-maps}}
 
| {{Code|use-character-maps}}
| Defines character mappings. May only occur in documents parsed with {{Code|parameter-document}}.
+
| Defines character mappings. If mappings are supplied as single string, keys and values are separated by the equal sign, and multiple pairs are separated by commas. Separators that are to be defined as keys or values can be encoded as entities.<br />Example: <code>A=alpha,B=beta</code>
|  
+
| ''string''
 
|  
 
|  
 
|- valign="top"
 
|- valign="top"
Line 221: Line 220:
 
=Character mappings=
 
=Character mappings=
  
Character maps allow a specific character in the instance of the data model to be replaced with a specified string of characters during serialization. The string that is substituted is output "as is," and the serializer performs no checks that the resulting document is well-formed. This may only occur in documents parsed with {{Code|parameter-document}}. If a character is mapped, then it is not subjected to XML or HTML escaping. For details refer to section [https://www.w3.org/TR/2015/CR-xslt-xquery-serialization-31-20151217/#character-maps 11 Character maps] in the [https://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document
+
Character maps allow a specific character in the instance of the data model to be replaced with a specified string of characters during serialization. The string that is substituted is output “as is,and the serializer performs no checks that the resulting document is well-formed. This may only occur in documents parsed with {{Code|parameter-document}}. If a character is mapped, then it is not subjected to XML or HTML escaping. For details, refer to section [https://www.w3.org/TR/2015/CR-xslt-xquery-serialization-31-20151217/#character-maps 11 Character maps] in the [https://www.w3.org/TR/xslt-xquery-serialization-31 W3C XQuery Serialization 3.1] document.
  
 
This example maps the Unicode U+00A0 NO-BREAK SPACE as &amp;#160; (without the serialization parameter, the Unicode character would be output):
 
This example maps the Unicode U+00A0 NO-BREAK SPACE as &amp;#160; (without the serialization parameter, the Unicode character would be output):
Line 242: Line 241:
  
 
=Changelog=
 
=Changelog=
 +
 +
;Version 10.0
 +
* Updated: {{Code|indent}}: Default changed from {{Code|yes}} to {{Code|no}}.
  
 
;Version 9.2
 
;Version 9.2
 
 
* Updated: New default value for {{Code|include-content-type}} is {{Code|yes}}.
 
* Updated: New default value for {{Code|include-content-type}} is {{Code|yes}}.
  
 
;Version 8.4
 
;Version 8.4
 
 
* Added: Serialization parameter {{Code|binary}}.
 
* Added: Serialization parameter {{Code|binary}}.
 
* Updated: New serialization method <code>basex</code>. By default, items of binary type are now output in their native byte representation. The method <code>raw</code> was removed.
 
* Updated: New serialization method <code>basex</code>. By default, items of binary type are now output in their native byte representation. The method <code>raw</code> was removed.
  
 
;Version 8.0
 
;Version 8.0
 
 
* Added: Support for {{Code|use-character-maps}} and {{Code|parameter-document}}.
 
* Added: Support for {{Code|use-character-maps}} and {{Code|parameter-document}}.
 
* Added: Serialization method {{Code|adaptive}}.
 
* Added: Serialization method {{Code|adaptive}}.
Line 260: Line 259:
  
 
;Version 7.8.2
 
;Version 7.8.2
 
 
* Added: {{Code|limit}}: Stops serialization after the specified number of bytes has been serialized.
 
* Added: {{Code|limit}}: Stops serialization after the specified number of bytes has been serialized.
  
 
;Version 7.8
 
;Version 7.8
 
 
* Added: {{Code|csv}} and {{Code|json}} serialization parameters.
 
* Added: {{Code|csv}} and {{Code|json}} serialization parameters.
 
* Removed: {{Code|separator}} option (use {{Code|item-separator}} instead).
 
* Removed: {{Code|separator}} option (use {{Code|item-separator}} instead).
  
 
;Version 7.7.2
 
;Version 7.7.2
 
 
* Added: {{Code|csv}} serialization method.
 
* Added: {{Code|csv}} serialization method.
 
* Added: temporary serialization methods {{Code|csv-header}}, {{Code|csv-separator}}, {{Code|json-unescape}}, {{Code|json-spec}}, {{Code|json-format}}.
 
* Added: temporary serialization methods {{Code|csv-header}}, {{Code|csv-separator}}, {{Code|json-unescape}}, {{Code|json-spec}}, {{Code|json-format}}.
  
 
;Version 7.5
 
;Version 7.5
 
 
* Added: official {{Code|item-separator}} and {{Code|html-version}} parameter.
 
* Added: official {{Code|item-separator}} and {{Code|html-version}} parameter.
 
* Updated: <code>method=html5</code> removed; serializers updated with the [https://www.w3.org/TR/2013/WD-xslt-xquery-serialization-30-20130108/ latest version of the specification], using <code>method=html</code> and <code>version=5.0</code>.
 
* Updated: <code>method=html5</code> removed; serializers updated with the [https://www.w3.org/TR/2013/WD-xslt-xquery-serialization-30-20130108/ latest version of the specification], using <code>method=html</code> and <code>version=5.0</code>.
  
 
;Version 7.2
 
;Version 7.2
 
 
* Added: {{Code|separator}} parameter.
 
* Added: {{Code|separator}} parameter.
  
 
;Version 7.1
 
;Version 7.1
 
 
* Added: {{Code|newline}} parameter.
 
* Added: {{Code|newline}} parameter.
  
 
;Version 7.0
 
;Version 7.0
 
 
* Added: Serialization parameters added to [[REST API]]; JSON/JsonML/raw methods.
 
* Added: Serialization parameters added to [[REST API]]; JSON/JsonML/raw methods.

Revision as of 11:06, 1 August 2022

This page is part of the XQuery Portal.

Serialization parameters define how XQuery items and XML nodes will be serialized (i.e., returned to the client or an API, usually in textual form). The official parameters are defined in the W3C XQuery Serialization 3.1 document. In BaseX, they can be:

The namespace for serialization parameters is statically bound to the output prefix. This means that it need not (but may) be declared in the query prolog:

<syntaxhighlight lang="xquery"> declare namespace output = 'http://www.w3.org/2010/xslt-xquery-serialization'; declare option output:method 'text'; <xml>Hi there</xml> </syntaxhighlight>

Due to the wide range of ways how parameters can be supplied, we deliberately ignored one rule of the specification, which requires non-official features to be defined in a non-null namespace URI. In the following, we will indicate which features are specific to our implementation.

Parameters

The following serialization parameters are supported by BaseX (further details can be looked up in the official specification):

Parameter Description Allowed Default
method Specifies the serialization method. xml, xhtml, html, text and adaptive are part of the official specification. For more details on basex, csv and json, see XQuery Extensions. xml, xhtml, html, text, json, adaptive, csv, basex basex
version Specifies the version of the serialization method. xml/xhtml: 1.0, 1.1
html: 4.0, 4.01, 5.0
1.0
html-version Specifies the version of the HTML serialization method. 4.0, 4.01, 5.0 4.0
item-separator Determines a string to be used as item separator. If a separator is specified, the default separation of atomic values with single whitespaces will be skipped. string
encoding Encoding to be used for outputting the data. all encodings supported by Java UTF-8
indent Adds leading whitespaces to make the output more readable. yes, no no Default changed with Version 10
cdata-section-elements List of elements to be output as CDATA, separated by whitespaces.
Example: <text><![CDATA[ <> ]]></text>
string
omit-xml-declaration Omits the XML declaration, which is serialized before the actual query result
Example: <?xml version="1.0" encoding="UTF-8"?>
yes, no yes
standalone Prints or omits the standalone attribute in the XML declaration. yes, no, omit omit
doctype-system Introduces the output with a document type declaration and the given system identifier.
Example: <!DOCTYPE x SYSTEM "entities.dtd">
string
doctype-public If doctype-system is specified, adds a public identifier.
Example: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
string
undeclare-prefixes Undeclares prefixes in XML 1.1. yes, no no
normalization-form Specifies a normalization form. BaseX supports Form C (NFC). NFC, none NFC
media-type Specifies the media type. string application/xml
parameter-document Parses the value as XML document with additional serialization parameters (see the Specification for more details and examples). string
use-character-maps Defines character mappings. If mappings are supplied as single string, keys and values are separated by the equal sign, and multiple pairs are separated by commas. Separators that are to be defined as keys or values can be encoded as entities.
Example: A=alpha,B=beta
string
byte-order-mark Prints a byte-order-mark before starting serialization. yes, no no
escape-uri-attributes Escapes URI information in certain HTML attributes
Example: <a href="%C3%A4%C3%B6%C3%BC">äöü<a>
yes, no no
include-content-type Inserts a meta content-type element into the head element if the result is output as HTML
Example: <head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head>. The head element must already exist or nothing will be added. Any existing meta content-type elements will be removed.
yes, no yes

BaseX provides some additional serialization parameters:

Parameter Description Allowed Default
csv Defines the way how data is serialized as CSV. see CSV Module
json Defines the way how data is serialized as JSON. see JSON Module
tabulator Uses tab characters (\t) instead of spaces for indenting elements. yes, no no
indents Specifies the number of characters to be indented. positive number 2
newline Specifies the type of newline to be used as end-of-line marker. \n, \r\n, \r system dependent
limit Stops serialization after the specified number of bytes has been serialized. If a negative number is specified, everything will be output. positive number -1
binary Indicates if items of binary type are output in their native byte representation. Only applicable to the base serialization method. yes, no yes

The csv and json parameters are supplied with a list of options. Option names and values are combined with =, several options are separated by ,:

<syntaxhighlight lang="xquery"> declare option output:method "csv"; declare option output:csv "header=yes, separator=semicolon"; <csv>

 <record>
   <Name>John</Name>
   <City>Newton</City>
 </record>
 <record>
   <Name>Jack</Name>
   <City>Oldtown</City>
 </record>

</csv> </syntaxhighlight>

If fn:serialize is called, output-specific parameters can be supplied via nested options:

<syntaxhighlight lang="xquery"> serialize(

 <csv>
   <record>
     <Name>John</Name>
     <City>Newton</City>
   </record>
   <record>
     <Name>Jack</Name>
     <City>Oldtown</City>
   </record>
 </csv>,
 map {
   'method': 'csv',
   'csv': map { 'header': 'yes', 'separator': ';' }
 }

) </syntaxhighlight>

Result: <syntaxhighlight lang="xml"> Name;City John;Newton Jack;Oldtown </syntaxhighlight>

Character mappings

Character maps allow a specific character in the instance of the data model to be replaced with a specified string of characters during serialization. The string that is substituted is output “as is,” and the serializer performs no checks that the resulting document is well-formed. This may only occur in documents parsed with parameter-document. If a character is mapped, then it is not subjected to XML or HTML escaping. For details, refer to section 11 Character maps in the W3C XQuery Serialization 3.1 document.

This example maps the Unicode U+00A0 NO-BREAK SPACE as &#160; (without the serialization parameter, the Unicode character would be output):

Example query: <syntaxhighlight lang="xquery"> declare option output:parameter-document "map.xml"; <x>&#xA0;</x> </syntaxhighlight>

Example parameter-document: <syntaxhighlight lang="xml"> <serialization-parameters

  xmlns="http://www.w3.org/2010/xslt-xquery-serialization">
  <use-character-maps>
    <character-map character="&#160;" map-string="&amp;#160;"/>
  </use-character-maps>

</serialization-parameters> </syntaxhighlight>

Changelog

Version 10.0
  • Updated: indent: Default changed from yes to no.
Version 9.2
  • Updated: New default value for include-content-type is yes.
Version 8.4
  • Added: Serialization parameter binary.
  • Updated: New serialization method basex. By default, items of binary type are now output in their native byte representation. The method raw was removed.
Version 8.0
  • Added: Support for use-character-maps and parameter-document.
  • Added: Serialization method adaptive.
  • Updated: adaptive is new default method (before: xml).
  • Removed: format, wrap-prefix, wrap-uri.
Version 7.8.2
  • Added: limit: Stops serialization after the specified number of bytes has been serialized.
Version 7.8
  • Added: csv and json serialization parameters.
  • Removed: separator option (use item-separator instead).
Version 7.7.2
  • Added: csv serialization method.
  • Added: temporary serialization methods csv-header, csv-separator, json-unescape, json-spec, json-format.
Version 7.5
  • Added: official item-separator and html-version parameter.
  • Updated: method=html5 removed; serializers updated with the latest version of the specification, using method=html and version=5.0.
Version 7.2
  • Added: separator parameter.
Version 7.1
  • Added: newline parameter.
Version 7.0
  • Added: Serialization parameters added to REST API; JSON/JsonML/raw methods.