Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / 3355d4c7a24401fa5f77a4200b9787c9f7c8a61b / . / docs / 0.9.7.1 / aql / externaldata.html
blob: 54852fd62784a5e46ccf08d4b9444009e2471af7 [file] [log] [blame]
Ian Maxon3355d4c2021-12-13 12:38:15 -0800[diff] [blame^]1<!DOCTYPE html>
2<!--
3 | Generated by Apache Maven Doxia Site Renderer 1.8.1 from src/site/markdown/aql/externaldata.md at 2021-12-13
4 | Rendered using Apache Maven Fluido Skin 1.7
5-->
6<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <meta charset="UTF-8" />
9 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
10 <meta name="Date-Revision-yyyymmdd" content="20211213" />
11 <meta http-equiv="Content-Language" content="en" />
12 <title>AsterixDB &#x2013; Accessing External Data in AsterixDB</title>
13 <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" />
14 <link rel="stylesheet" href="../css/site.css" />
15 <link rel="stylesheet" href="../css/print.css" media="print" />
16 <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script>
17
18 </head>
19 <body class="topBarDisabled">
20 <div class="container-fluid">
21 <div id="banner">
22 <div class="pull-left"><a href=".././" id="bannerLeft"><img src="../images/asterixlogo.png" alt="AsterixDB"/></a></div>
23 <div class="pull-right"></div>
24 <div class="clear"><hr/></div>
25 </div>
26
27 <div id="breadcrumbs">
28 <ul class="breadcrumb">
29 <li id="publishDate">Last Published: 2021-12-13</li>
30 <li id="projectVersion" class="pull-right">Version: 0.9.7.1</li>
31 <li class="pull-right"><a href="../index.html" title="Documentation Home">Documentation Home</a></li>
32 </ul>
33 </div>
34 <div class="row-fluid">
35 <div id="leftColumn" class="span2">
36 <div class="well sidebar-nav">
37 <ul class="nav nav-list">
38 <li class="nav-header">Get Started - Installation</li>
39 <li><a href="../ncservice.html" title="Option 1: using NCService"><span class="none"></span>Option 1: using NCService</a></li>
40 <li><a href="../ansible.html" title="Option 2: using Ansible"><span class="none"></span>Option 2: using Ansible</a></li>
41 <li><a href="../aws.html" title="Option 3: using Amazon Web Services"><span class="none"></span>Option 3: using Amazon Web Services</a></li>
42 <li class="nav-header">AsterixDB Primer</li>
43 <li><a href="../sqlpp/primer-sqlpp.html" title="Using SQL++"><span class="none"></span>Using SQL++</a></li>
44 <li class="nav-header">Data Model</li>
45 <li><a href="../datamodel.html" title="The Asterix Data Model"><span class="none"></span>The Asterix Data Model</a></li>
46 <li class="nav-header">Queries</li>
47 <li><a href="../sqlpp/manual.html" title="The SQL++ Query Language"><span class="none"></span>The SQL++ Query Language</a></li>
48 <li><a href="../SQLPP.html" title="Raw SQL++ Grammar"><span class="none"></span>Raw SQL++ Grammar</a></li>
49 <li><a href="../sqlpp/builtins.html" title="Builtin Functions"><span class="none"></span>Builtin Functions</a></li>
50 <li class="nav-header">API/SDK</li>
51 <li><a href="../api.html" title="HTTP API"><span class="none"></span>HTTP API</a></li>
52 <li><a href="../csv.html" title="CSV Output"><span class="none"></span>CSV Output</a></li>
53 <li class="nav-header">Advanced Features</li>
54 <li class="active"><a href="#"><span class="none"></span>Accessing External Data</a></li>
55 <li><a href="../feeds.html" title="Data Ingestion with Feeds"><span class="none"></span>Data Ingestion with Feeds</a></li>
56 <li><a href="../udf.html" title="User Defined Functions"><span class="none"></span>User Defined Functions</a></li>
57 <li><a href="../sqlpp/filters.html" title="Filter-Based LSM Index Acceleration"><span class="none"></span>Filter-Based LSM Index Acceleration</a></li>
58 <li><a href="../sqlpp/fulltext.html" title="Support of Full-text Queries"><span class="none"></span>Support of Full-text Queries</a></li>
59 <li><a href="../sqlpp/similarity.html" title="Support of Similarity Queries"><span class="none"></span>Support of Similarity Queries</a></li>
60 <li><a href="../interval_join.html" title="Support of Interval Joins"><span class="none"></span>Support of Interval Joins</a></li>
61 <li><a href="../sqlpp/arrayindex.html" title="Support of Array Indexes"><span class="none"></span>Support of Array Indexes</a></li>
62 <li class="nav-header">Deprecated</li>
63 <li><a href="../aql/primer.html" title="AsterixDB Primer: Using AQL"><span class="none"></span>AsterixDB Primer: Using AQL</a></li>
64 <li><a href="../aql/manual.html" title="Queries: The Asterix Query Language (AQL)"><span class="none"></span>Queries: The Asterix Query Language (AQL)</a></li>
65 <li><a href="../aql/builtins.html" title="Queries: Builtin Functions (AQL)"><span class="none"></span>Queries: Builtin Functions (AQL)</a></li>
66</ul>
67 <hr />
68 <div id="poweredBy">
69 <div class="clear"></div>
70 <div class="clear"></div>
71 <div class="clear"></div>
72 <div class="clear"></div>
73<a href=".././" title="AsterixDB" class="builtBy"><img class="builtBy" alt="AsterixDB" src="../images/asterixlogo.png" /></a>
74 </div>
75 </div>
76 </div>
77 <div id="bodyColumn" class="span10" >
78<!--
79 ! Licensed to the Apache Software Foundation (ASF) under one
80 ! or more contributor license agreements. See the NOTICE file
81 ! distributed with this work for additional information
82 ! regarding copyright ownership. The ASF licenses this file
83 ! to you under the Apache License, Version 2.0 (the
84 ! "License"); you may not use this file except in compliance
85 ! with the License. You may obtain a copy of the License at
86 !
87 ! http://www.apache.org/licenses/LICENSE-2.0
88 !
89 ! Unless required by applicable law or agreed to in writing,
90 ! software distributed under the License is distributed on an
91 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
92 ! KIND, either express or implied. See the License for the
93 ! specific language governing permissions and limitations
94 ! under the License.
95 !-->
96<h1>Accessing External Data in AsterixDB</h1>
97<div class="section">
98<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
99<ul>
100
101<li><a href="#Introduction">Introduction</a></li>
102<li><a href="#IntroductionAdapterForAnExternalDataset">Adapter for an External Dataset</a></li>
103<li><a href="#BuiltinAdapters">Builtin Adapters</a></li>
104<li><a href="#IntroductionCreatingAnExternalDataset">Creating an External Dataset</a></li>
105<li><a href="#WritingQueriesAgainstAnExternalDataset">Writing Queries against an External Dataset</a></li>
106<li><a href="#BuildingIndexesOverExternalDatasets">Building Indexes over External Datasets</a></li>
107<li><a href="#ExternalDataSnapshot">External Data Snapshots</a></li>
108<li><a href="#FAQ">Frequently Asked Questions</a></li>
109</ul></div>
110<div class="section">
111<h2><a name="Introduction_.5BBack_to_TOC.5D"></a><a name="Introduction" id="Introduction">Introduction</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>
112<p>Data that needs to be processed by AsterixDB could be residing outside AsterixDB storage. Examples include data files on a distributed file system such as HDFS or on the local file system of a machine that is part of an AsterixDB cluster. For AsterixDB to process such data, an end-user may create a regular dataset in AsterixDB (a.k.a. an internal dataset) and load the dataset with the data. AsterixDB also supports &#x2018;&#x2018;external datasets&#x2019;&#x2019; so that it is not necessary to &#x201c;load&#x201d; all data prior to using it. This also avoids creating multiple copies of data and the need to keep the copies in sync.</p>
113<div class="section">
114<h3><a name="Adapter_for_an_External_Dataset_.5BBack_to_TOC.5D"></a><a name="IntroductionAdapterForAnExternalDataset" id="IntroductionAdapterForAnExternalDataset">Adapter for an External Dataset</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h3>
115<p>External data is accessed using wrappers (adapters in AsterixDB) that abstract away the mechanism of connecting with an external service, receiving its data and transforming the data into ADM objects that are understood by AsterixDB. AsterixDB comes with built-in adapters for common storage systems such as HDFS or the local file system.</p></div>
116<div class="section">
117<h3><a name="Builtin_Adapters_.5BBack_to_TOC.5D"></a><a name="BuiltinAdapters" id="BuiltinAdapters">Builtin Adapters</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h3>
118<p>AsterixDB offers a set of builtin adapters that can be used to query external data or for loading data into an internal dataset using a load statement or a data feed. Each adapter requires specifying the <tt>format</tt> of the data in order to be able to parse objects correctly. Using adapters with feeds, the parameter <tt>output-type</tt> must also be specified.</p>
119<p>Following is a listing of existing built-in adapters and their configuration parameters:</p>
120<ol style="list-style-type: decimal">
121
122<li><b><i>localfs</i></b>: used for reading data stored in a local filesystem in one or more of the node controllers
123<ul>
124
125<li><tt>path</tt>: A fully qualified path of the form <tt>host://absolute_path</tt>. Comma separated list if there are multiple directories or files</li>
126<li><tt>expression</tt>: A <a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html">regular expression</a> to match and filter against file names</li>
127</ul>
128</li>
129<li><b><i>hdfs</i></b>: used for reading data stored in an HDFS instance
130<ul>
131
132<li><tt>path</tt>: A fully qualified path of the form <tt>host://absolute_path</tt>. Comma separated list if there are multiple directories or files</li>
133<li><tt>expression</tt>: A <a class="externalLink" href="https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html">regular expression</a> to match and filter against file names</li>
134<li><tt>input-format</tt>: A fully qualified name or an alias for a class of HDFS input format</li>
135<li><tt>hdfs</tt>: The HDFS name node URL</li>
136</ul>
137</li>
138<li><b><i>socket</i></b>: used for listening to connections that sends data streams through one or more sockets
139<ul>
140
141<li><tt>sockets</tt>: comma separated list of sockets to listen to</li>
142<li><tt>address-type</tt>: either IP if the list uses IP addresses, or NC if the list uses NC names</li>
143</ul>
144</li>
145<li><b><i>socket_client</i></b>: used for connecting to one or more sockets and reading data streams
146<ul>
147
148<li><tt>sockets</tt>: comma separated list of sockets to connect to</li>
149</ul>
150</li>
151<li><b><i>twitter_push</i></b>: used for establishing a connection and subscribing to a twitter feed
152<ul>
153
154<li><tt>consumer.key</tt>: access parameter provided by twitter OAuth</li>
155<li><tt>consumer.secret</tt>: access parameter provided by twitter OAuth</li>
156<li><tt>access.token</tt>: access parameter provided by twitter OAuth</li>
157<li><tt>access.token.secret</tt>: access parameter provided by twitter OAuth</li>
158</ul>
159</li>
160<li><b><i>twitter_pull</i></b>: used for polling a twitter feed for tweets based on a configurable frequency
161<ul>
162
163<li><tt>consumer.key</tt>: access parameter provided by twitter OAuth</li>
164<li><tt>consumer.secret</tt>: access parameter provided by twitter OAuth</li>
165<li><tt>access.token</tt>: access parameter provided by twitter OAuth</li>
166<li><tt>access.token.secret</tt>: access parameter provided by twitter OAuth</li>
167<li><tt>query</tt>: twitter query string</li>
168<li><tt>interval</tt>: poll interval in seconds</li>
169</ul>
170</li>
171<li><b><i>rss</i></b>: used for reading RSS feed
172<ul>
173
174<li><tt>url</tt>: a comma separated list of RSS urls</li>
175</ul>
176</li>
177</ol></div>
178<div class="section">
179<h3><a name="Creating_an_External_Dataset_.5BBack_to_TOC.5D"></a><a name="IntroductionCreatingAnExternalDataset" id="IntroductionCreatingAnExternalDataset">Creating an External Dataset</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h3>
180<p>As an example we consider the Lineitem dataset from the <a class="externalLink" href="http://www.openlinksw.com/dataspace/doc/dav/wiki/Main/VOSTPCHLinkedData/tpch.sql">TPCH schema</a>. We assume that you have successfully created an AsterixDB instance following the instructions at <a href="../install.html">Installing AsterixDB Using Managix</a>. <i>For constructing an example, we assume a single machine setup..</i></p>
181<p>Similar to a regular dataset, an external dataset has an associated datatype. We shall first create the datatype associated with each object in Lineitem data. Paste the following in the query textbox on the webpage at <a class="externalLink" href="http://127.0.0.1:19001">http://127.0.0.1:19001</a> and hit &#x2018;Execute&#x2019;.</p>
182
183<div>
184<div>
185<pre class="source"> create dataverse ExternalFileDemo;
186 use dataverse ExternalFileDemo;
187
188 create type LineitemType as closed {
189 l_orderkey:int32,
190 l_partkey: int32,
191 l_suppkey: int32,
192 l_linenumber: int32,
193 l_quantity: double,
194 l_extendedprice: double,
195 l_discount: double,
196 l_tax: double,
197 l_returnflag: string,
198 l_linestatus: string,
199 l_shipdate: string,
200 l_commitdate: string,
201 l_receiptdate: string,
202 l_shipinstruct: string,
203 l_shipmode: string,
204 l_comment: string}
205</pre></div></div>
206
207<p>Here, we describe two scenarios.</p>
208<div class="section">
209<h4><a name="a1.29_Data_file_resides_on_the_local_file_system_of_a_host"></a>1) Data file resides on the local file system of a host</h4>
210<p>Prerequisite: The host is a part of the ASTERIX cluster.</p>
211<p>Earlier, we assumed a single machine ASTERIX setup. To satisfy the prerequisite, log-in to the machine running ASTERIX.</p>
212<ul>
213
214<li>Download the <a href="../data/lineitem.tbl">data file</a> to an appropriate location. We denote this location by SOURCE_PATH.</li>
215</ul>
216<p>ASTERIX provides a built-in adapter for data residing on the local file system. The adapter is referred by its alias- &#x2018;localfs&#x2019;. We create an external dataset named Lineitem and use the &#x2018;localfs&#x2019; adapter.</p>
217
218<div>
219<div>
220<pre class="source"> create external dataset Lineitem(LineitemType)
221 using localfs
222</pre></div></div>
223
224<p>Above, the definition is not complete as we need to provide a set of parameters that are specific to the source file.</p>
225
226<table border="0" class="table table-striped">
227
228<tr class="a">
229
230<td> Parameter </td>
231
232<td> Description </td>
233</tr>
234
235<tr class="b">
236
237<td> path </td>
238
239<td> A fully qualified path of the form <tt>host://&lt;absolute path&gt;</tt>.
240 Use a comma separated list if there are multiple files.
241 E.g. <tt>host1://&lt;absolute path&gt;</tt>, <tt>host2://&lt;absolute path&gt;</tt> and so forth. </td>
242</tr>
243
244<tr class="a">
245
246<td> format </td>
247
248<td> The format for the content. Use 'adm' for data in ADM (ASTERIX Data Model) or <a class="externalLink" href="http://www.json.org/">JSON</a> format. Use 'delimited-text' if fields are separated by a delimiting character (eg., CSV). </td></tr>
249
250<tr class="b">
251
252<td>delimiter</td>
253
254<td>The delimiting character in the source file if format is 'delimited text'</td>
255</tr>
256</table>
257
258<p>As we are using a single single machine ASTERIX instance, we use 127.0.0.1 as host in the path parameter. We <i>complete the create dataset statement</i> as follows.</p>
259
260<div>
261<div>
262<pre class="source"> use dataverse ExternalFileDemo;
263
264 create external dataset Lineitem(LineitemType)
265 using localfs
266 ((&quot;path&quot;=&quot;127.0.0.1://SOURCE_PATH&quot;),
267 (&quot;format&quot;=&quot;delimited-text&quot;),
268 (&quot;delimiter&quot;=&quot;|&quot;));
269</pre></div></div>
270
271<p>Please substitute SOURCE_PATH with the absolute path to the source file on the local file system.</p></div>
272<div class="section">
273<h4><a name="Common_source_of_error"></a>Common source of error</h4>
274<p>An incorrect value for the path parameter will give the following exception message when the dataset is used in a query.</p>
275
276<div>
277<div>
278<pre class="source"> org.apache.hyracks.algebricks.common.exceptions.AlgebricksException: org.apache.hyracks.api.exceptions.HyracksDataException: org.apache.hyracks.api.exceptions.HyracksDataException: Job failed.
279</pre></div></div>
280
281<p>Verify the correctness of the path parameter provided to the localfs adapter. Note that the path parameter must be an absolute path to the data file. For e.g. if you saved your file in your home directory (assume it to be /home/joe), then the path value should be</p>
282
283<div>
284<div>
285<pre class="source"> 127.0.0.1:///home/joe/lineitem.tbl.
286</pre></div></div>
287
288<p>In your web-browser, navigate to 127.0.0.1:19001 and paste the above to the query text box. Finally hit &#x2018;Execute&#x2019;.</p>
289<p>Next we move over to the the section <a href="#Writing_Queries_against_an_External_Dataset">Writing Queries against an External Dataset</a> and try a sample query against the external dataset.</p></div>
290<div class="section">
291<h4><a name="a2.29_Data_file_resides_on_an_HDFS_instance"></a>2) Data file resides on an HDFS instance</h4>
292<p>rerequisite: It is required that the Namenode and HDFS Datanodes are reachable from the hosts that form the AsterixDB cluster. AsterixDB provides a built-in adapter for data residing on HDFS. The HDFS adapter can be referred (in AQL) by its alias - &#x2018;hdfs&#x2019;. We can create an external dataset named Lineitem and associate the HDFS adapter with it as follows;</p>
293
294<div>
295<div>
296<pre class="source"> create external dataset Lineitem(LineitemType)
297 using hdfs((&#x201c;hdfs&#x201d;:&#x201d;hdfs://localhost:54310&#x201d;),(&#x201c;path&#x201d;:&#x201d;/asterix/Lineitem.tbl&#x201d;),...,(&#x201c;input- format&#x201d;:&#x201d;rc-format&#x201d;));
298</pre></div></div>
299
300<p>The expected parameters are described below:</p>
301
302<table border="0" class="table table-striped">
303
304<tr class="a">
305
306<td> Parameter </td>
307
308<td> Description </td>
309</tr>
310
311<tr class="b">
312
313<td> hdfs </td>
314
315<td> The HDFS URL </td>
316</tr>
317
318<tr class="a">
319
320<td> path </td>
321
322<td> The absolute path to the source HDFS file or directory. Use a comma separated list if there are multiple files or directories. </td></tr>
323
324<tr class="b">
325
326<td> input-format </td>
327
328<td> The associated input format. Use 'text-input-format' for text files , 'sequence-input-format' for hadoop sequence files, 'rc-input-format' for Hadoop Object Columnar files, or a fully qualified name of an implementation of org.apache.hadoop.mapred.InputFormat. </td>
329</tr>
330
331<tr class="a">
332
333<td> format </td>
334
335<td> The format of the input content. Use 'adm' for text data in ADM (ASTERIX Data Model) or <a class="externalLink" href="http://www.json.org/">JSON</a> format, 'delimited-text' for text delimited data that has fields separated by a delimiting character, 'binary' for other data.</td>
336</tr>
337
338<tr class="b">
339
340<td> delimiter </td>
341
342<td> The delimiting character in the source file if format is 'delimited text' </td>
343</tr>
344
345<tr class="a">
346
347<td> parser </td>
348
349<td> The parser used to parse HDFS objects if the format is 'binary'. Use 'hive- parser' for data deserialized by a Hive Serde (AsterixDB can understand deserialized Hive objects) or a fully qualified class name of user- implemented parser that implements the interface org.apache.asterix.external.input.InputParser. </td>
350</tr>
351
352<tr class="b">
353
354<td> hive-serde </td>
355
356<td> The Hive serde is used to deserialize HDFS objects if format is binary and the parser is hive-parser. Use a fully qualified name of a class implementation of org.apache.hadoop.hive.serde2.SerDe. </td>
357</tr>
358
359<tr class="a">
360
361<td> local-socket-path </td>
362
363<td> The UNIX domain socket path if local short-circuit reads are enabled in the HDFS instance</td>
364</tr>
365</table>
366
367<p><i>Difference between &#x2018;input-format&#x2019; and &#x2018;format&#x2019;</i></p>
368<p><i>input-format</i>: Files stored under HDFS have an associated storage format. For example, TextInputFormat represents plain text files. SequenceFileInputFormat indicates binary compressed files. RCFileInputFormat corresponds to objects stored in a object columnar fashion. The parameter &#x2018;input-format&#x2019; is used to distinguish between these and other HDFS input formats.</p>
369<p><i>format</i>: The parameter &#x2018;format&#x2019; refers to the type of the data contained in the file. For example, data contained in a file could be in json or ADM format, could be in delimited-text with fields separated by a delimiting character or could be in binary format.</p>
370<p>As an example. consider the <a href="../data/lineitem.tbl">data file</a>. The file is a text file with each line representing a object. The fields in each object are separated by the &#x2018;|&#x2019; character.</p>
371<p>We assume the HDFS URL to be <a class="externalLink" href="hdfs://localhost:54310">hdfs://localhost:54310</a>. We further assume that the example data file is copied to HDFS at a path denoted by &#x201c;/asterix/Lineitem.tbl&#x201d;.</p>
372<p>The complete set of parameters for our example file are as follows. ((&#x201c;hdfs&#x201d;=&#x201c;<a class="externalLink" href="hdfs://localhost:54310”,(“path”=“/asterix/Lineitem.tbl”),(“input-format”=“text-">hdfs://localhost:54310&#x201d;,(&#x201c;path&#x201d;=&#x201c;/asterix/Lineitem.tbl&#x201d;),(&#x201c;input-format&#x201d;=&#x201c;text-</a> input-format&#x201d;),(&#x201c;format&#x201d;=&#x201c;delimited-text&#x201d;),(&#x201c;delimiter&#x201d;=&#x201c;|&#x201d;))</p></div>
373<div class="section">
374<h4><a name="Using_the_Hive_Parser"></a>Using the Hive Parser</h4>
375<p>if a user wants to create an external dataset that uses hive-parser to parse HDFS objects, it is important that the datatype associated with the dataset matches the actual data in the Hive table for the correct initialization of the Hive SerDe. Here is the conversion from the supported Hive data types to AsterixDB data types:</p>
376
377<table border="0" class="table table-striped">
378
379<tr class="a">
380
381<td> Hive </td>
382
383<td> AsterixDB </td>
384</tr>
385
386<tr class="b">
387
388<td>BOOLEAN</td>
389
390<td>Boolean</td>
391</tr>
392
393<tr class="a">
394
395<td>BYTE(TINY INT)</td>
396
397<td>Int8</td>
398</tr>
399
400<tr class="b">
401
402<td>DOUBLE</td>
403
404<td>Double</td>
405</tr>
406
407<tr class="a">
408
409<td>FLOAT</td>
410
411<td>Float</td>
412</tr>
413
414<tr class="b">
415
416<td>INT</td>
417
418<td>Int32</td>
419</tr>
420
421<tr class="a">
422
423<td>LONG(BIG INT)</td>
424
425<td>Int64</td>
426</tr>
427
428<tr class="b">
429
430<td>SHORT(SMALL INT)</td>
431
432<td>Int16</td>
433</tr>
434
435<tr class="a">
436
437<td>STRING</td>
438
439<td>String</td>
440</tr>
441
442<tr class="b">
443
444<td>TIMESTAMP</td>
445
446<td>Datetime</td>
447</tr>
448
449<tr class="a">
450
451<td>DATE</td>
452
453<td>Date</td>
454</tr>
455
456<tr class="b">
457
458<td>STRUCT</td>
459
460<td>Nested Object</td>
461</tr>
462
463<tr class="a">
464
465<td>LIST</td>
466
467<td>OrderedList or UnorderedList</td>
468</tr>
469</table>
470</div>
471<div class="section">
472<h4><a name="Examples_of_dataset_definitions_for_external_datasets"></a>Examples of dataset definitions for external datasets</h4>
473<p><i>Example 1</i>: We can modify the create external dataset statement as follows:</p>
474
475<div>
476<div>
477<pre class="source"> create external dataset Lineitem('LineitemType)
478 using hdfs((&quot;hdfs&quot;=&quot;hdfs://localhost:54310&quot;),(&quot;path&quot;=&quot;/asterix/Lineitem.tbl&quot;),(&quot;input-format&quot;=&quot;text- input-format&quot;),(&quot;format&quot;=&quot;delimited-text&quot;),(&quot;delimiter&quot;=&quot;|&quot;));
479</pre></div></div>
480
481<p><i>Example 2</i>: Here, we create an external dataset of lineitem objects stored in sequence files that has content in ADM format:</p>
482
483<div>
484<div>
485<pre class="source"> create external dataset Lineitem('LineitemType)
486 using hdfs((&quot;hdfs&quot;=&quot;hdfs://localhost:54310&quot;),(&quot;path&quot;=&quot;/asterix/SequenceLineitem.tbl&quot;),(&quot;input- format&quot;=&quot;sequence-input-format&quot;),(&quot;format&quot;=&quot;adm&quot;));
487</pre></div></div>
488
489<p><i>Example 3</i>: Here, we create an external dataset of lineitem objects stored in object-columnar files that has content in binary format parsed using hive-parser with hive ColumnarSerde:</p>
490
491<div>
492<div>
493<pre class="source"> create external dataset Lineitem('LineitemType)
494 using hdfs((&quot;hdfs&quot;=&quot;hdfs://localhost:54310&quot;),(&quot;path&quot;=&quot;/asterix/RCLineitem.tbl&quot;),(&quot;input-format&quot;=&quot;rc-input-format&quot;),(&quot;format&quot;=&quot;binary&quot;),(&quot;parser&quot;=&quot;hive-parser&quot;),(&quot;hive- serde&quot;=&quot;org.apache.hadoop.hive.serde2.columnar.ColumnarSerde&quot;));
495</pre></div></div>
496</div></div></div>
497<div class="section">
498<h2><a name="Writing_Queries_against_an_External_Dataset_.5BBack_to_TOC.5D"></a><a name="WritingQueriesAgainstAnExternalDataset" id="WritingQueriesAgainstAnExternalDataset">Writing Queries against an External Dataset</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>
499<p>You may write AQL queries against an external dataset in exactly the same way that queries are written against internal datasets. The following is an example of an AQL query that applies a filter and returns an ordered result.</p>
500
501<div>
502<div>
503<pre class="source"> use dataverse ExternalFileDemo;
504
505 for $c in dataset('Lineitem')
506 where $c.l_orderkey &lt;= 3
507 order by $c.l_orderkey, $c.l_linenumber
508 return $c
509</pre></div></div>
510</div>
511<div class="section">
512<h2><a name="Building_Indexes_over_External_Datasets_.5BBack_to_TOC.5D"></a><a name="BuildingIndexesOverExternalDatasets" id="BuildingIndexesOverExternalDatasets">Building Indexes over External Datasets</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>
513<p>AsterixDB supports building B-Tree and R-Tree indexes over static data stored in the Hadoop Distributed File System. To create an index, first create an external dataset over the data as follows</p>
514
515<div>
516<div>
517<pre class="source"> create external dataset Lineitem(LineitemType)
518 using hdfs((&quot;hdfs&quot;=&quot;hdfs://localhost:54310&quot;),(&quot;path&quot;=&quot;/asterix/Lineitem.tbl&quot;),(&quot;input-format&quot;=&quot;text-input- format&quot;),(&quot;format&quot;=&quot;delimited-text&quot;),(&quot;delimiter&quot;=&quot;|&quot;));
519</pre></div></div>
520
521<p>You can then create a B-Tree index on this dataset instance as if the dataset was internally stored as follows:</p>
522
523<div>
524<div>
525<pre class="source"> create index PartkeyIdx on Lineitem(l_partkey);
526</pre></div></div>
527
528<p>You could also create an R-Tree index as follows:</p>
529
530<div>
531<div>
532<pre class="source"> &#xfffc;create index IndexName on DatasetName(attribute-name) type rtree;
533</pre></div></div>
534
535<p>After building the indexes, the AsterixDB query compiler can use them to access the dataset and answer queries in a more cost effective manner. AsterixDB can read all HDFS input formats, but indexes over external datasets can currently be built only for HDFS datasets with &#x2018;text-input-format&#x2019;, &#x2018;sequence-input-format&#x2019; or &#x2018;rc-input-format&#x2019;.</p></div>
536<div class="section">
537<h2><a name="External_Data_Snapshots_.5BBack_to_TOC.5D"></a><a name="ExternalDataSnapshots" id="ExternalDataSnapshots">External Data Snapshots</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>
538<p>An external data snapshot represents the status of a dataset&#x2019;s files in HDFS at a point in time. Upon creating the first index over an external dataset, AsterixDB captures and stores a snapshot of the dataset in HDFS. Only objects present at the snapshot capture time are indexed, and any additional indexes created afterwards will only contain data that was present at the snapshot capture time thus preserving consistency across all indexes of a dataset. To update all indexes of an external dataset and advance the snapshot time to be the present time, a user can use the refresh external dataset command as follows:</p>
539
540<div>
541<div>
542<pre class="source"> refresh external dataset DatasetName;
543</pre></div></div>
544
545<p>After a refresh operation commits, all of the dataset&#x2019;s indexes will reflect the status of the data as of the new snapshot capture time.</p></div>
546<div class="section">
547<h2><a name="Frequently_Asked_Questions_.5BBack_to_TOC.5D"></a><a name="FAQ" id="FAQ">Frequently Asked Questions</a> <font size="4"><a href="#toc">[Back to TOC]</a></font></h2>
548<p>Q. I added data to my dataset in HDFS, Will the dataset indexes in AsterixDB be updated automatically?</p>
549<p>A. No, you must use the refresh external dataset statement to make the indexes aware of any changes in the dataset files in HDFS.</p>
550<p>Q. Why doesn&#x2019;t AsterixDB update external indexes automatically?</p>
551<p>A. Since external data is managed by other users/systems with mechanisms that are system dependent, AsterixDB has no way of knowing exactly when data is added or deleted in HDFS, so the responsibility of refreshing indexes are left to the user. A user can use internal datasets for which AsterixDB manages the data and its indexes.</p>
552<p>Q. I created an index over an external dataset and then added some data to my HDFS dataset. Will a query that uses the index return different results from a query that doesn&#x2019;t use the index?</p>
553<p>A. No, queries&#x2019; results are access path independent and the stored snapshot is used to determines which data are going to be included when processing queries.</p>
554<p>Q. I created an index over an external dataset and then deleted some of my dataset&#x2019;s files in HDFS, Will indexed data access still return the objects in deleted files?</p>
555<p>A. No. When AsterixDB accesses external data, with or without the use of indexes, it only access files present in the file system at runtime.</p>
556<p>Q. I submitted a refresh command on a an external dataset and a failure occurred, What has happened to my indexes?</p>
557<p>A. External Indexes Refreshes are treated as a single transaction. In case of a failure, a rollback occurs and indexes are restored to their previous state. An error message with the cause of failure is returned to the user.</p>
558<p>Q. I was trying to refresh an external dataset while some queries were accessing the data using index access method. Will the queries be affected by the refresh operation?</p>
559<p>A. Queries have access to external dataset indexes state at the time where the queries are submitted. A query that was submitted before a refresh commits will only access data under the snapshot taken before the refresh; queries that are submitted after the refresh commits will access data under the snapshot taken after the refresh.</p>
560<p>Q. What happens when I try to create an additional index while a refresh operation is in progress or vice versa?</p>
561<p>A. The create index operation will wait until the refresh commits or aborts and then the index will be built according to the external data snapshot at the end of the refresh operation. Creating indexes and refreshing datasets are mutually exclusive operations and will not be run in parallel. Multiple indexes can be created in parallel, but not multiple refresh operations.</p></div>
562 </div>
563 </div>
564 </div>
565 <hr/>
566 <footer>
567 <div class="container-fluid">
568 <div class="row-fluid">
569<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
570 feather logo, and the Apache AsterixDB project logo are either
571 registered trademarks or trademarks of The Apache Software
572 Foundation in the United States and other countries.
573 All other marks mentioned may be trademarks or registered
574 trademarks of their respective owners.
575 </div>
576 </div>
577 </div>
578 </footer>
579 </body>
580</html>