CSV Module - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:39:53Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to "

2023-12-01T16:35:02Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

2023-12-01T16:34:23Z

Text replacement - "</syntaxhighlight>" to "</pre>"

2023-06-20T16:35:04Z

2023-04-26T14:48:41Z

Options

2023-04-26T14:47:30Z

2023-03-31T08:31:07Z

2023-03-31T08:27:19Z

2023-03-31T08:26:06Z

2023-03-09T14:47:31Z

csv:serialize

@@ Line 176: / Line 176: @@
 '''Input''' {{Code|addressbook.csv}}:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 Name,First Name,Address,City
 Huber,Sepp,Hauptstraße 13,93547 Hintertupfing
@@ Line 188: / Line 188: @@
 '''Result:'''
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <csv>
    <record>

@@ Line 34: / Line 34: @@
 * <code>$csv?names?*</code> returns the names of all fields (if available)
 * Return enumerated strings for all records:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 for $record at $pos in $csv?records
 return $pos || ". " || string-join($record?*, ', ')
@@ Line 182: / Line 182: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $text := file:read-text('addressbook.csv')
 return csv:parse($text, map { 'header': true() })
@@ Line 203: / Line 203: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $options := map { 'lax': false() }
 let $input := file:read-text('some-data.csv')
@@ Line 213: / Line 213: @@
 '''Query:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $text := ``[Name,City
 Jack,Chicago
@@ Line 233: / Line 233: @@
 '''Result:'''
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 Distinct values:
 * Name: Jack, John

@@ Line 37: / Line 37: @@
 for $record at $pos in $csv?records
 return $pos || ". " || string-join($record?*, ', ')
-</syntaxhighlight>
+</pre>
 The resulting representation consumes less memory than XML-based formats, and values can be directly accessed without conversion. Thus, it is recommendable for very large inputs and for efficient ad-hoc processing.
@@ Line 179: / Line 179: @@
 Name,First Name,Address,City
 Huber,Sepp,Hauptstraße 13,93547 Hintertupfing
-</syntaxhighlight>
+</pre>
 '''Query:'''
@@ Line 185: / Line 185: @@
 let $text := file:read-text('addressbook.csv')
 return csv:parse($text, map { 'header': true() })
-</syntaxhighlight>
+</pre>
 '''Result:'''
@@ Line 197: / Line 197: @@
    </record>
 </csv>
-</syntaxhighlight>
+</pre>
 '''
@@ Line 208: / Line 208: @@
 let $output := $input => csv:parse($options) => csv:serialize($options)
 return $input eq $output
-</syntaxhighlight>
+</pre>
 '''Example 3:''' Converts CSV data to XQuery and returns distinct column values:
@@ Line 230: / Line 230: @@
+   )
+)
-</syntaxhighlight>
+</pre>
 '''Result:'''
@@ Line 237: / Line 237: @@
 * Name: Jack, John
 * City: Chicago, Washington, New York
-</syntaxhighlight>
+</pre>
 =Errors=

@@ Line 76: / Line 76: @@
 |- valign="top"
 | {{Code|lax}}
-| Specifies if a lax approach is used to convert QNames to JSON names.
+| Specifies if [[Conversion Module#Keys|lax conversion rules]] are used to convert QNames to JSON names.
 | {{Code|yes}}, {{Code|no}}
 | {{Code|yes}}

@@ Line 101: / Line 101: @@
 |- valign="top"
 | {{Code|skip-empty}}
-| {{Announce|Version 11:}} Indicates if empty fields are included in the result. Only gets effective for the formats {{Code|direct}} or {{Code|attribute}}, and if the {{Code|header}} option is enabled. If this option is enabled and if the parsed data is serialized again, please note that the resulting CSV header may be incomplete.
+| {{Announce|Version 11:}} Indicates if empty fields are included in the result. Only gets effective for the formats {{Code|direct}} or {{Code|attribute}}, and if the {{Code|header}} option is enabled. Please note that if this option is used and the data is serialized again, the resulting CSV header may be incomplete.
 | {{Code|yes}}, {{Code|no}}
 | {{Code|no}}

@@ Line 98: / Line 98: @@
 | {{Code|no}}
 | ''parse'', ''serialize''
 | {{Code|no}}
 |- valign="top"
@@ Line 246: / Line 253: @@
 =Changelog=
 ;Version 9.7

@@ Line 5: / Line 5: @@
 All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/csv</nowiki></code> namespace, which is statically bound to the {{Code|csv}} prefix.<br/>
-==Conversion==
+==Conversion Formats==
 ===XML: Direct, Attributes===
@@ Line 69: / Line 69: @@
 |- valign="top"
 | {{Code|format}}
-| Specifies the format of the XML data (see above):<br/>
+| Specifies the format for converting CSV data ([[#Conversion Formats|see above]]).
 | {{Code|direct}}, {{Code|attributes}}, {{Code|xquery}}
 | {{Code|direct}}

@@ Line 26: / Line 26: @@
 * The resulting value will be a map with a {{Code|records}} entry and an optional {{Code|names}} entry.
 * Records are organized as a sequence of arrays. An array contains the entries of a single record.
-* If {{Code|header}} option is set to {{Code|true}}, a {{Code|names}} entry is generated, which contains an array with the column names.
+* The {{Code|names}} entry contains an array with the column names. It is generated if the {{Code|header}} option is set to {{Code|true}}.
 The CSV map can e.g. be accessed as follows:
@@ Line 69: / Line 69: @@
 |- valign="top"
 | {{Code|format}}
-| Specifies the format of the XML data:<br/>
+| Specifies the format of the XML data (see above):<br/>
 * With {{Code|direct}} conversion, field names are represented as element names
 * With {{Code|attributes}} conversion, field names are stored in {{Code|name}} attributes

@@ Line 24: / Line 24: @@
 With the {{Code|xquery}} format, CSV records are converted to a sequence of arrays:
-* The resulting value will be a map with a {{Code|records}} and an optional {{Code|names}} key.
+* The resulting value will be a map with a {{Code|records}} entry and an optional {{Code|names}} entry.
-* Records are organized as a sequence of arrays. A single array contains the entries of a single record.
+* Records are organized as a sequence of arrays. An array contains the entries of a single record.
-* The column names will be available if {{Code|header}} option is set to {{Code|true}}.
+* If {{Code|header}} option is set to {{Code|true}}, a {{Code|names}} entry is generated, which contains an array with the column names.
 The CSV map can e.g. be accessed as follows:

@@ Line 154: / Line 154: @@
 |<pre>csv:serialize(
    $input    as item()?,
-   $options  as map(*)?  := ()
+   $options  as map(*)?  := map { }
 ) as xs:string</pre>
 |- valign="top"