Blame - docs/0.8.8-incubating/csv.html - incubator-asterixdb-site

<p>AsterixDB supports the CSV format for both data input and query result output. In both cases, the structure of the CSV data must be defined using a named ADM record datatype. The CSV format, limitations, and MIME type are defined by <a class="externalLink" href="https://tools.ietf.org/html/rfc4180">RFC 4180</a>.</p>

212

<p>CSV is not as expressive as the full Asterix Data Model, meaning that not all data which can be represented in ADM can also be represented as CSV. So the form of this datatype is limited. First, obviously it may not contain any nested records or lists, as CSV has no way to represent nested data structures. All fields in the record type must be primitive. Second, the set of supported primitive types is limited to numerics (<tt>int8</tt>, <tt>int16</tt>, <tt>int32</tt>, <tt>int64</tt>, <tt>float</tt>, <tt>double</tt>) and <tt>string</tt>. On output, a few additional primitive types (<tt>boolean</tt>, datetime types) are supported and will be represented as strings.</p>

213

<p>For the purposes of this document, we will use the following dataverse and datatype definitions:</p>

<pre>drop dataverse csv if exists;

218

create dataverse csv;

219

use dataverse csv;

220

221

create type "csv_type" as closed {

"id": int32,

"money": float,

"name": string

};

create dataset "csv_set" ("csv_type") primary key "id";

228

</pre></div></div>

229

<p>Note: There is no explicit restriction against using an open datatype for CSV purposes, and you may have optional fields in the datatype (eg., <tt>id: int32?</tt>). However, the CSV format itself is rigid, so using either of these datatype features introduces possible failure modes on output which will be discussed below.</p></div>

230

231

<h2><a name="CSV_Input"></a>CSV Input</h2>

232

<p>CSV data may be loaded into a dataset using the normal “load dataset” mechanisms, utilizing the builtin “delimited-text” format. See <a href="aql/externaldata.html">Accessing External Data</a> for more details. Note that comma is the default value for the “delimiter” parameter, so it does not need to be explicitly specified.</p>

233

<p>In this case, the datatype used to interpret the CSV data is the datatype associated with the dataset being loaded. So, to load a file that we have stored locally on the NC into our example dataset:</p>

<pre>use dataverse csv;

238

239

load dataset "csv_set" using localfs

240

(("path"="127.0.0.1:///tmp/my_sample.csv"),

241

("format"="delimited-text"));

242

</pre></div></div>

243

<p>So, if the file <tt>/tmp/my_sample.csv</tt> contained</p>

<pre>1,18.50,"Peter Krabnitz"

248

2,74.50,"Jesse Stevens"

249

</pre></div></div>

250

<p>then the preceding query would load it into the dataset <tt>csv_set</tt>.</p>

251

<p>If your CSV file has a header (that is, the first line contains a set of field names, rather than actual data), you can instruct Asterix to ignore this header by adding the parameter <tt>"header"="true"</tt>, eg.</p>

<pre>load dataset "csv_set" using localfs

256

(("path"="127.0.0.1:///tmp/my_header_sample.csv"),

257

("format"="delimited-text"),

258

("header"="true"));

259

</pre></div></div>

260

<p>CSV data may also be loaded from HDFS; see <a href="aql/externaldata.html">Accessing External Data</a> for details. However please note that CSV files on HDFS cannot have headers. Attempting to specify “header”=“true” when reading from HDFS could result in non-header lines of data being skipped as well.</p></div>

261

262

<h2><a name="CSV_Output"></a>CSV Output</h2>

263

<p>Any query may be rendered as CSV when using AsterixDB’s HTTP interface. To do so, there are two steps required: specify the record type which defines the schema of your CSV, and request that Asterix use the CSV output format.</p>

264

265

266

<h4><a name="Output_Record_Type"></a>Output Record Type</h4>

267

<p>Background: The result of any AQL query is an unordered list of <i>instances</i>, where each <i>instance</i> is an instance of an AQL datatype. When requesting CSV output, there are some restrictions on the legal datatypes in this unordered list due to the limited expressability of CSV:</p>

<li>Each instance must be of a record type.</li>

272

273

<li>Each instance must be of the <i>same</i> record type.</li>

274

275

<li>The record type must conform to the content and type restrictions mentioned in the introduction.</li>

276

</ol>

277

<p>While it would be possible to structure your query to cast all result instances to a given type, it is not necessary. AQL offers a built-in feature which will automatically cast all top-level instances in the result to a specified named ADM record type. To enable this feature, use a <tt>set</tt> statement prior to the query to set the parameter <tt>output-record-type</tt> to the name of an ADM type. This type must have already been defined in the current dataverse.</p>

278

<p>For example, the following request will ensure that all result instances are cast to the <tt>csv_type</tt> type declared earlier:</p>

<pre>use dataverse csv;

283

set output-record-type "csv_type";

284

285

for $n in dataset "csv_set" return $n;

286

</pre></div></div>

287

<p>In this case the casting is redundant since by definition every value in <tt>csv_set</tt> is already of type <tt>csv_type</tt>. But consider a more complex query where the result values are created by joining fields from different underlying datasets, etc.</p>

288

<p>Two notes about <tt>output-record-type</tt>:</p>

<li>This feature is not strictly related to CSV; it may be used with any output formats (in which case, any record datatype may be specified, not subject to the limitations specified in the introduction of this page).</li>

293

294

<li>When the CSV output format is requested, <tt>output-record-type</tt> is in fact required, not optional. This is because the type is used to determine the field names for the CSV header and to ensure that the ordering of fields in the output is consistent (which is obviously vital for the CSV to make any sense).</li>

295

</ol></div>

296

297

<h4><a name="Request_the_CSV_Output_Format"></a>Request the CSV Output Format</h4>

298

<p>When sending requests to the Asterix HTTP API, Asterix decides what format to use for rendering the results in one of two ways:</p>

<ul>

<li>

<p>A HTTP query parameter named “output”, which must be set to one of the following values: <tt>JSON</tt>, <tt>CSV</tt>, or <tt>ADM</tt>.</p></li>

304

305

<li>

306

<p>Based on the <a class="externalLink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1"><tt>Accept</tt> HTTP header</a></p></li>

307

</ul>

308

<p>By default, Asterix will produce JSON output. To select CSV output, pass the parameter <tt>output=CSV</tt>, or set the <tt>Accept</tt> header on your request to the MIME type <tt>text/csv</tt>. The details of how to accomplish this will of course depend on what tools you are using to contact the HTTP API. Here is an example from a Unix shell prompt using the command-line utility “curl” and specifying the "output query parameter:</p>

<pre>curl -G "http://localhost:19002/query" \

313

--data-urlencode 'output=CSV' \

314

--data-urlencode 'query=use dataverse csv;

315

set output-record-type "csv_type";

316

for $n in dataset csv_set return $n;'

317

</pre></div></div>

318

<p>Alternately, the same query using the <tt>Accept</tt> header:</p>

<pre>curl -G -H "Accept: text/csv" "http://localhost:19002/query" \

323

--data-urlencode 'query=use dataverse csv;

324

set output-record-type "csv_type";

325

for $n in dataset csv_set return $n;'

326

</pre></div></div>

327

<p>Similarly, a trivial Java program to execute the above sample query and selecting CSV output via the <tt>Accept</tt> header would be:</p>

<pre>import java.net.HttpURLConnection;

332

import java.net.URL;

333

import java.net.URLEncoder;

334

import java.io.BufferedReader;

335

import java.io.InputStream;

336

import java.io.InputStreamReader;

337

338

public class AsterixExample {

339

public static void main(String[] args) throws Exception {

340

String query = "use dataverse csv; " +

341

"set output-record-type \"csv_type\";" +

342

"for $n in dataset csv_set return $n";

343

URL asterix = new URL("http://localhost:19002/query?query=" +

344

URLEncoder.encode(query, "UTF-8"));

345

HttpURLConnection conn = (HttpURLConnection) asterix.openConnection();

346

conn.setRequestProperty("Accept", "text/csv");

347

BufferedReader result = new BufferedReader

348

(new InputStreamReader(conn.getInputStream()));

349

String line;

350

while ((line = result.readLine()) != null) {

351

System.out.println(line);

}

result.close();

}

}

</pre></div></div>

<p>For either of the above examples, the output would be:</p>

<pre>1,18.5,"Peter Krabnitz"

362

2,74.5,"Jesse Stevens"

363

</pre></div></div>

364

<p>assuming you had already run the previous examples to create the dataverse and populate the dataset.</p></div>

365

366

<h4><a name="Outputting_CSV_with_a_Header"></a>Outputting CSV with a Header</h4>

367

<p>By default, AsterixDB will produce CSV results with no header line. If you want a header, you may explicitly request it in one of two ways:</p>

<ul>

<li>

<p>By passing the HTTP query parameter “header” with the value “present”</p></li>

373

374

<li>

375

<p>By specifying the MIME type {{text/csv; header=present}} in your HTTP Accept: header. This is consistent with RFC 4180.</p></li>

376

</ul></div>

377

378

<h4><a name="Issues_with_open_datatypes_and_optional_fields"></a>Issues with open datatypes and optional fields</h4>

379

<p>As mentioned earlier, CSV is a rigid format. It cannot express records with different numbers of fields, which ADM allows through both open datatypes and optional fields.</p>

380

<p>If your output record type contains optional fields, this will not result in any errors. If the output data of a query does not contain values for an optional field, this will be represented in CSV as <tt>null</tt>.</p>

381

<p>If your output record type is open, this will also not result in any errors. If the output data of a query contains any open fields, the corresponding rows in the resulting CSV will contain more comma-separated values than the others. On each such row, the data from the closed fields in the type will be output first in the normal order, followed by the data from the open fields in an arbitrary order.</p>

382

<p>According to RFC 4180 this is not strictly valid CSV (Section 2, rule 4, “Each line <i>should</i> contain the same number of fields throughout the file”). Hence it will likely not be handled consistently by all CSV processors. Some may throw a parsing error. If you attempt to load this data into AsterixDB later using <tt>load dataset</tt>, the extra fields will be silently ignored. For this reason it is recommended that you use only closed datatypes as output record types. AsterixDB allows to use an open record type only to support cases where the type already exists for other parts of your application.</p></div></div></div>

</div>

</div>

</div>

<hr/>