Changes

{{Mark|Updated with Version 9.0:}} 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/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.

If the {{Code|direct}} or {{Code|attributes}} format is chosen, a CSV string is converted to XML as follows:

If {{Code|format}} is set to {{Code|map}}, the CSV data will be converted to an ===XQuery map:===

* All records are enumerated This format has been introduced with positive integers.* By default, all entries of a records are represented in a sequence.* If the {{CodeVersion|header9.0}} option . It is set to more flexible and light-weight than the old, discarded {{Code|truemap}}, a map is created, which contains all field names and its valuesformat.

'''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.* Records are organized as a sequence of arrays. A little advice'''single array contains the entries of a single record.* The column names will be available if {{Code|header}} option is set to {{Code|true}}. The CSV map can e.g. be accessed as follows: in  * <code>$csv?records[5]</code> returns all entries of the Database Creation dialog 5th record (row)* <code>$csv?records(2)</code> returns all entries of the GUI2nd field (column)* <code>$csv?names?*</code> returns the names of all fields (if available)* Return enumerated strings for all records:<pre class="brush:xquery">for $record at $pos in $csv?recordsreturn $pos || ". " || string-join($record?*, if you select CSV Parsing and switch to the ', 'Parsing'' tab)</pre> The resulting representation consumes less memory than XML-based formats, you and values can see the effects of some of the be directly accessed without conversion options. Thus, it is recommendable for very large inputs and for efficient ad-hoc processing.

{{Mark|Updated with Version 8In the following table, all available options are listed.6}}: improved The Excel compatibility The following column indicates what are the preferred options are available:for data that is to be imported, or has been exported from Excel.

| Defines the character which separates the entries values of a single record in a single line.

| Specifies the format of the XML data. The format is only relevant if the {{Code|header}} option is activated:<br/>

* With {{Code|mapxquery}} conversion, the input is converted to an XQuery map

* Serialization: If the option is enabled, the value will be wrapped with quotes. Quote characters A quote character in the value will be encoded according to the rules of the {{Code|backslashes}} option.

* Parsing: If the option is enabled, {{Code|\r}}, {{Code|n}} and {{Code|\t}} will be replaced with the corresponding control characters. All other escaped characters will be adopted as literals (e.g.: {{Code|\"}} → {{Code|"}}). If the option is disabled, two consecutive quotes will be replaced with a single quote (see the unless {{Code|quotes}} option for exceptionsis enabled and the quote is the first or last character of a value).* Serialization: If the option is enabled, {{Code|\r}}, {{Code|n}}, {{Code|\t}}, {{Code|\"}} and the separator character will be escaped encoded with a backslash. If the option is disabled, quotes will be duplicated.

|{{Func|csv:parse|$input as xs:string|document-node(element(csv))}}<br/>{{Func|csv:parse|$input as xs:string, $options as map(xs:string, item()*)?|item()}}

|{{Error|BXCS0001parse|#Errors}} the input cannot be parsed.

|{{Func|csv:serialize|$input as nodeitem()?|xs:string}}<br/>{{Func|csv:serialize|$input as nodeitem()?, $options as map(xs:string, item()*)?|xs:string}}

|Serializes the node specified by {{Code|$input}} as CSV data, and returns using the result as specified {{Code|xs:string$options}}, and returns the result as string. Items Values can also be serialized as JSON if CSV with the standard [[Serialization|Serialization Parameter]] feature of XQuery:* The parameter {{Code|method}} is needs to be set to {{Code|csv}}.<br/>The , and* the options presented in this article need to be assigned to the {{Code|$optionscsv}} argument can be used to control the way the input is serializedparameter.

|{{Error|BXCS0002serialize|#Errors}} the input cannot be serialized.

let $xml input := csvfile:parseread-text($text, $options'some-data.csv')let $output := $input => csv :parse($options) = > csv:serialize($xml, $options)return $text input eq $csvoutput

'''Example 3:''' Converts CSV data to an XQuery map item and serializes its contentsreturns distinct column values:

let $text := "``[Name;,City" || outJack,ChicagoJack,WashingtonJohn,New York]``let $options := map { 'format':nl() || "John;Newton" || out'xquery', 'header':nltrue() || "Jack;Oldtown"}let $options csv := <csv:parse($text, $options>)return ( <csv 'Distinct values:separator value=';'/>, <csv let $records :format value=$csv('maprecords'/>) < for $name at $pos in $csv:header value=('yesnames'/>)?* </csvlet $values :options>= $records($pos) return csv( '* ' || $name || ':parse' || string-join(distinct-values($textvalues), ', $options') ))

<pre class="brush:xmlxquery">{ 1Distinct values: { "City"* Name: "Newton"Jack, "Name": "John" }, 2: { "* City": "Oldtown"Chicago, Washington, "Name": "Jack" }}New York

|{{Code|BXCS0001parse}}

|{{Code|BXCS0002serialize}}