Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / 1c2dec1b731f72f4ec7e89a08597d2f55edf6b91 / . / content / docs / 0.9.6 / aql / externaldata.html
blob: db15dc01110c5f1b221989587b2a0c640ce24d85 [file] [log] [blame]
Ian Maxon49d15b22020-12-06 16:23:00 -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 2020-12-06
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="20201206" />
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: 2020-12-06</li>
30 <li id="projectVersion" class="pull-right">Version: 0.9.6-SNAPSHOT</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 class="nav-header">Deprecated</li>
62 <li><a href="../aql/primer.html" title="AsterixDB Primer: Using AQL"><span class="none"></span>AsterixDB Primer: Using AQL</a></li>
63 <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>
64 <li><a href="../aql/builtins.html" title="Queries: Builtin Functions (AQL)"><span class="none"></span>Queries: Builtin Functions (AQL)</a></li>
65</ul>
66 <hr />
67 <div id="poweredBy">
68 <div class="clear"></div>
69 <div class="clear"></div>
70 <div class="clear"></div>
71 <div class="clear"></div>
72<a href=".././" title="AsterixDB" class="builtBy"><img class="builtBy" alt="AsterixDB" src="../images/asterixlogo.png" /></a>
73 </div>
74 </div>
75 </div>
76 <div id="bodyColumn" class="span10" >
77<!--
78 ! Licensed to the Apache Software Foundation (ASF) under one
79 ! or more contributor license agreements. See the NOTICE file
80 ! distributed with this work for additional information
81 ! regarding copyright ownership. The ASF licenses this file
82 ! to you under the Apache License, Version 2.0 (the
83 ! "License"); you may not use this file except in compliance
84 ! with the License. You may obtain a copy of the License at
85 !
86 ! http://www.apache.org/licenses/LICENSE-2.0
87 !
88 ! Unless required by applicable law or agreed to in writing,
89 ! software distributed under the License is distributed on an
90 ! "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
91 ! KIND, either express or implied. See the License for the
92 ! specific language governing permissions and limitations
93 ! under the License.
94 !-->
95<h1>Accessing External Data in AsterixDB</h1>
96<div class="section">
97<h2><a name="Table_of_Contents"></a><a name="toc" id="toc">Table of Contents</a></h2>
98<ul>
99
100<li><a href="#Introduction">Introduction</a></li>
101<li><a href="#IntroductionAdapterForAnExternalDataset">Adapter for an External Dataset</a></li>
102<li><a href="#BuiltinAdapters">Builtin Adapters</a></li>
103<li><a href="#IntroductionCreatingAnExternalDataset">Creating an External Dataset</a></li>
104<li><a href="#WritingQueriesAgainstAnExternalDataset">Writing Queries against an External Dataset</a></li>
105<li><a href="#BuildingIndexesOverExternalDatasets">Building Indexes over External Datasets</a></li>
106<li><a href="#ExternalDataSnapshot">External Data Snapshots</a></li>
107<li><a href="#FAQ">Frequently Asked Questions</a></li>
108</ul></div>
109<div class="section">
110<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>
111<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>
112<div class="section">
113<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>
114<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>
115<div class="section">
116<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>
117<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>
118<p>Following is a listing of existing built-in adapters and their configuration parameters:</p>
119<ol style="list-style-type: decimal">
120
121<li><b><i>localfs</i></b>: used for reading data stored in a local filesystem in one or more of the node controllers
122<ul>
123
124<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>
125<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>
126</ul>
127</li>
128<li><b><i>hdfs</i></b>: used for reading data stored in an HDFS instance
129<ul>
130
131<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>
132<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>
133<li><tt>input-format</tt>: A fully qualified name or an alias for a class of HDFS input format</li>
134<li><tt>hdfs</tt>: The HDFS name node URL</li>
135</ul>
136</li>
137<li><b><i>socket</i></b>: used for listening to connections that sends data streams through one or more sockets
138<ul>
139
140<li><tt>sockets</tt>: comma separated list of sockets to listen to</li>
141<li><tt>address-type</tt>: either IP if the list uses IP addresses, or NC if the list uses NC names</li>
142</ul>
143</li>
144<li><b><i>socket_client</i></b>: used for connecting to one or more sockets and reading data streams
145<ul>
146
147<li><tt>sockets</tt>: comma separated list of sockets to connect to</li>
148</ul>
149</li>
150<li><b><i>twitter_push</i></b>: used for establishing a connection and subscribing to a twitter feed
151<ul>
152
153<li><tt>consumer.key</tt>: access parameter provided by twitter OAuth</li>
154<li><tt>consumer.secret</tt>: access parameter provided by twitter OAuth</li>
155<li><tt>access.token</tt>: access parameter provided by twitter OAuth</li>
156<li><tt>access.token.secret</tt>: access parameter provided by twitter OAuth</li>
157</ul>
158</li>
159<li><b><i>twitter_pull</i></b>: used for polling a twitter feed for tweets based on a configurable frequency
160<ul>
161
162<li><tt>consumer.key</tt>: access parameter provided by twitter OAuth</li>
163<li><tt>consumer.secret</tt>: access parameter provided by twitter OAuth</li>
164<li><tt>access.token</tt>: access parameter provided by twitter OAuth</li>
165<li><tt>access.token.secret</tt>: access parameter provided by twitter OAuth</li>
166<li><tt>query</tt>: twitter query string</li>
167<li><tt>interval</tt>: poll interval in seconds</li>
168</ul>
169</li>
170<li><b><i>rss</i></b>: used for reading RSS feed
171<ul>
172
173<li><tt>url</tt>: a comma separated list of RSS urls</li>
174</ul>
175</li>
176</ol></div>
177<div class="section">
178<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>
179<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>
180<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>
181
182<div>
183<div>
184<pre class="source"> create dataverse ExternalFileDemo;
185 use dataverse ExternalFileDemo;
186
187 create type LineitemType as closed {
188 l_orderkey:int32,
189 l_partkey: int32,
190 l_suppkey: int32,
191 l_linenumber: int32,
192 l_quantity: double,
193 l_extendedprice: double,
194 l_discount: double,
195 l_tax: double,
196 l_returnflag: string,
197 l_linestatus: string,
198 l_shipdate: string,
199 l_commitdate: string,
200 l_receiptdate: string,
201 l_shipinstruct: string,
202 l_shipmode: string,
203 l_comment: string}
204</pre></div></div>
205
206<p>Here, we describe two scenarios.</p>
207<div class="section">
208<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>
209<p>Prerequisite: The host is a part of the ASTERIX cluster.</p>
210<p>Earlier, we assumed a single machine ASTERIX setup. To satisfy the prerequisite, log-in to the machine running ASTERIX.</p>
211<ul>
212
213<li>Download the <a href="../data/lineitem.tbl">data file</a> to an appropriate location. We denote this location by SOURCE_PATH.</li>
214</ul>
215<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>
216
217<div>
218<div>
219<pre class="source"> create external dataset Lineitem(LineitemType)
220 using localfs
221</pre></div></div>
222
223<p>Above, the definition is not complete as we need to provide a set of parameters that are specific to the source file.</p>
224
225<table border="0" class="table table-striped">
226
227<tr class="a">
228
229<td> Parameter </td>
230
231<td> Description </td>
232</tr>
233
234<tr class="b">
235
236<td> path </td>
237
238<td> A fully qualified path of the form <tt>host://&lt;absolute path&gt;</tt>.
239 Use a comma separated list if there are multiple files.
240 E.g. <tt>host1://&lt;absolute path&gt;</tt>, <tt>host2://&lt;absolute path&gt;</tt> and so forth. </td>
241</tr>
242
243<tr class="a">
244
245<td> format </td>
246
247<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>
248
249<tr class="b">
250
251<td>delimiter</td>
252
253<td>The delimiting character in the source file if format is 'delimited text'</td>
254</tr>
255</table>
256
257<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>
258
259<div>
260<div>
261<pre class="source"> use dataverse ExternalFileDemo;
262
263 create external dataset Lineitem(LineitemType)
264 using localfs
265 ((&quot;path&quot;=&quot;127.0.0.1://SOURCE_PATH&quot;),
266 (&quot;format&quot;=&quot;delimited-text&quot;),
267 (&quot;delimiter&quot;=&quot;|&quot;));
268</pre></div></div>
269
270<p>Please substitute SOURCE_PATH with the absolute path to the source file on the local file system.</p></div>
271<div class="section">
272<h4><a name="Common_source_of_error"></a>Common source of error</h4>
273<p>An incorrect value for the path parameter will give the following exception message when the dataset is used in a query.</p>
274
275<div>
276<div>
277<pre class="source"> org.apache.hyracks.algebricks.common.exceptions.AlgebricksException: org.apache.hyracks.api.exceptions.HyracksDataException: org.apache.hyracks.api.exceptions.HyracksDataException: Job failed.
278</pre></div></div>
279
280<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>
281
282<div>
283<div>
284<pre class="source"> 127.0.0.1:///home/joe/lineitem.tbl.
285</pre></div></div>
286
287<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>
288<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>
289<div class="section">
290<h4><a name="a2.29_Data_file_resides_on_an_HDFS_instance"></a>2) Data file resides on an HDFS instance</h4>
291<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>
292
293<div>
294<div>
295<pre class="source"> create external dataset Lineitem(LineitemType)
296 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;));
297</pre></div></div>
298
299<p>The expected parameters are described below:</p>
300
301<table border="0" class="table table-striped">
302
303<tr class="a">
304
305<td> Parameter </td>
306
307<td> Description </td>
308</tr>
309
310<tr class="b">
311
312<td> hdfs </td>
313
314<td> The HDFS URL </td>
315</tr>
316
317<tr class="a">
318
319<td> path </td>
320
321<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>
322
323<tr class="b">
324
325<td> input-format </td>
326
327<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>
328</tr>
329
330<tr class="a">
331
332<td> format </td>
333
334<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>
335</tr>
336
337<tr class="b">
338
339<td> delimiter </td>
340
341<td> The delimiting character in the source file if format is 'delimited text' </td>
342</tr>
343
344<tr class="a">
345
346<td> parser </td>
347
348<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>
349</tr>
350
351<tr class="b">
352
353<td> hive-serde </td>
354
355<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>
356</tr>
357
358<tr class="a">
359
360<td> local-socket-path </td>
361
362<td> The UNIX domain socket path if local short-circuit reads are enabled in the HDFS instance</td>
363</tr>
364</table>
365
366<p><i>Difference between &#x2018;input-format&#x2019; and &#x2018;format&#x2019;</i></p>
367<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>
368<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>
369<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>
370<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>
371<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>
372<div class="section">
373<h4><a name="Using_the_Hive_Parser"></a>Using the Hive Parser</h4>
374<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>
375
376<table border="0" class="table table-striped">
377
378<tr class="a">
379
380<td> Hive </td>
381
382<td> AsterixDB </td>
383</tr>
384
385<tr class="b">
386
387<td>BOOLEAN</td>
388
389<td>Boolean</td>
390</tr>
391
392<tr class="a">
393
394<td>BYTE(TINY INT)</td>
395
396<td>Int8</td>
397</tr>
398
399<tr class="b">
400
401<td>DOUBLE</td>
402
403<td>Double</td>
404</tr>
405
406<tr class="a">
407
408<td>FLOAT</td>
409
410<td>Float</td>
411</tr>
412
413<tr class="b">
414
415<td>INT</td>
416
417<td>Int32</td>
418</tr>
419
420<tr class="a">
421
422<td>LONG(BIG INT)</td>
423
424<td>Int64</td>
425</tr>
426
427<tr class="b">
428
429<td>SHORT(SMALL INT)</td>
430
431<td>Int16</td>
432</tr>
433
434<tr class="a">
435
436<td>STRING</td>
437
438<td>String</td>
439</tr>
440
441<tr class="b">
442
443<td>TIMESTAMP</td>
444
445<td>Datetime</td>
446</tr>
447
448<tr class="a">
449
450<td>DATE</td>
451
452<td>Date</td>
453</tr>
454
455<tr class="b">
456
457<td>STRUCT</td>
458
459<td>Nested Object</td>
460</tr>
461
462<tr class="a">
463
464<td>LIST</td>
465
466<td>OrderedList or UnorderedList</td>
467</tr>
468</table>
469</div>
470<div class="section">
471<h4><a name="Examples_of_dataset_definitions_for_external_datasets"></a>Examples of dataset definitions for external datasets</h4>
472<p><i>Example 1</i>: We can modify the create external dataset statement as follows:</p>
473
474<div>
475<div>
476<pre class="source"> create external dataset Lineitem('LineitemType)
477 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;));
478</pre></div></div>
479
480<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>
481
482<div>
483<div>
484<pre class="source"> create external dataset Lineitem('LineitemType)
485 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;));
486</pre></div></div>
487
488<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>
489
490<div>
491<div>
492<pre class="source"> create external dataset Lineitem('LineitemType)
493 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;));
494</pre></div></div>
495</div></div></div>
496<div class="section">
497<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>
498<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>
499
500<div>
501<div>
502<pre class="source"> use dataverse ExternalFileDemo;
503
504 for $c in dataset('Lineitem')
505 where $c.l_orderkey &lt;= 3
506 order by $c.l_orderkey, $c.l_linenumber
507 return $c
508</pre></div></div>
509</div>
510<div class="section">
511<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>
512<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>
513
514<div>
515<div>
516<pre class="source"> create external dataset Lineitem(LineitemType)
517 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;));
518</pre></div></div>
519
520<p>You can then create a B-Tree index on this dataset instance as if the dataset was internally stored as follows:</p>
521
522<div>
523<div>
524<pre class="source"> create index PartkeyIdx on Lineitem(l_partkey);
525</pre></div></div>
526
527<p>You could also create an R-Tree index as follows:</p>
528
529<div>
530<div>
531<pre class="source"> &#xfffc;create index IndexName on DatasetName(attribute-name) type rtree;
532</pre></div></div>
533
534<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>
535<div class="section">
536<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>
537<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>
538
539<div>
540<div>
541<pre class="source"> refresh external dataset DatasetName;
542</pre></div></div>
543
544<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>
545<div class="section">
546<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>
547<p>Q. I added data to my dataset in HDFS, Will the dataset indexes in AsterixDB be updated automatically?</p>
548<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>
549<p>Q. Why doesn&#x2019;t AsterixDB update external indexes automatically?</p>
550<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>
551<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>
552<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>
553<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>
554<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>
555<p>Q. I submitted a refresh command on a an external dataset and a failure occurred, What has happened to my indexes?</p>
556<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>
557<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>
558<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>
559<p>Q. What happens when I try to create an additional index while a refresh operation is in progress or vice versa?</p>
560<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>
561 </div>
562 </div>
563 </div>
564 <hr/>
565 <footer>
566 <div class="container-fluid">
567 <div class="row-fluid">
568<div class="row-fluid">Apache AsterixDB, AsterixDB, Apache, the Apache
569 feather logo, and the Apache AsterixDB project logo are either
570 registered trademarks or trademarks of The Apache Software
571 Foundation in the United States and other countries.
572 All other marks mentioned may be trademarks or registered
573 trademarks of their respective owners.
574 </div>
575 </div>
576 </div>
577 </footer>
578 </body>
579</html>