Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / refs/heads/asf-site / . / content / extension.html
blob: 5b1451ed6622ba53f534cb037f71825da13f9650 [file] [log] [blame]
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
7 <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
8 <meta name="description" content="">
9 <meta name="author" content="">
10 <link rel="icon" href="favicon.ico">
Ian Maxon5be42f72024-11-14 15:54:56 -0800[diff] [blame]11 <meta http-equiv="Content-Security-Policy" content="frame-src youtube.com www.youtube.com">
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]12
13 <title>AsterixDB Extensions</title>
14
15 <!-- Bootstrap core CSS -->
16 <link href="css/bootstrap.min.css" rel="stylesheet">
17 <!-- Bootstrap theme -->
18
19 <!-- Custom styles for this template -->
20 <link href="css/theme.css" rel="stylesheet">
21
22 <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
23 <!--[if lt IE 9]>
24 <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
25 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
26 <![endif]-->
27 <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
28 </head>
29
30 <div class="container theme-showcase" role="main">
31 <div class="masthead">
32 <p class="lead">
33 <a href="index.html">
34 <img src="img/asterixdb_tm.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/>
35 </a>
36 </p>
37 </div>
38
39 <nav class="navbar navbar-default">
40 <div class="container">
41 <div class="navbar-header">
42 <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
43 <span class="sr-only">Toggle navigation</span>
44 <span class="icon-bar"></span>
45 <span class="icon-bar"></span>
46 <span class="icon-bar"></span>
47 </button>
48 <a class="navbar-brand" href="index.html">Overview</a>
49 </div>
50 <div class="navbar-collapse collapse">
51 <ul class="nav navbar-nav">
52 <li><a href="download.html">Download</a></li>
53 <li class="dropdown">
54 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a>
55 <ul class="dropdown-menu" role="menu">
56 <li class="dropdown-header">Stable release</li>
Ian Maxon1c2dec12024-04-01 16:05:43 -0700[diff] [blame]57 <li><a href="docs/0.9.9/index.html">Documentation for 0.9.9<i class="fa fa-external-link fa-sm"></i></a></li>
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]58 <li class="divider"></li>
59 <li class="dropdown-header">Snapshot release</li>
Ian Maxon1c2dec12024-04-01 16:05:43 -0700[diff] [blame]60 <li><a href="https://ci.apache.org/projects/asterixdb/index.html">Documentation for 0.9.10-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li>
Ian Maxon79af4a72018-11-02 17:06:39 -0700[diff] [blame]61 <li class="divider"></li>
62 <li class="dropdown-header">Tutorial for SQL Users</li>
63 <li><a href="files/SQL_Book.pdf">Don Chamberlin's SQL++ for SQL Users<i class="fa fa-external-link fa-sm"></i></a></li>
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]64 </ul>
65 </li>
66 <li><a href="about.html">About</a></li>
67 <li class="dropdown">
68 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Community<span class="caret"></span></a>
69 <ul class="dropdown-menu" role="menu">
70 <li><a href="community.html">Mailing Lists</a></li>
71 <li><a href="community.html#irc">IRC</a></li>
72 <li><a href="community.html#asterixdb-team">Team</a></li>
73 <li><a href="https://issues.apache.org/jira/browse/ASTERIXDB">Issue Tracker</a></li>
74 </ul>
75 </li>
76 <li class="dropdown">
77 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Development<span class="caret"></span></a>
78 <ul class="dropdown-menu" role="menu">
79 <li class="dropdown-header">For New Contributors</li>
80 <li><a href="dev-setup.html">Development Setup</a></li>
81 <li class="divider"></li>
82 <li class="dropdown-header">For Committers</li>
83 <li><a href="pushing.html">Pushing changes</a></li>
84 <li><a href="site.html">Editing this site</a></li>
85 <li class="dropdown-header">Extensions</li>
86 <li><a href="extension.html">Extending AsterixDB</a></li>
87 </ul>
88 </li>
89 </ul>
90 <ul class="nav navbar-nav navbar-right">
91 <li class="dropdown">
92 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"
93 style="padding-right: 30px">
94 <img src="img/feather.png" style="height:20px"/>Apache Software Foundation<span class="caret"/>
95 </a>
96 <ul class="dropdown-menu dropdown-menu-right" role="menu">
97 <li><a href="http://www.apache.org/"><b>ASF Homepage</b></a></li>
98 <li><a href="http://www.apache.org/licenses/">License</a></li>
99 <li><a href="http://www.apache.org/foundation/sponsorship.html">Donate</a></li>
100 <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
101 <li><a href="http://www.apache.org/security/">Security</a></li>
102 </ul>
103 </li>
104 </ul>
105 </div><!--/.nav-collapse -->
106 </div>
107 </nav>
108
109
110 <div class="row">
111<div class="col-md-8 col-centered">
112<h2>AsterixDB Extensions</h2>
113<ul id="markdown-toc">
114 <li><a href="#integrating-with-asterixdb-build" id="markdown-toc-integrating-with-asterixdb-build">Integrating with AsterixDB Build</a> <ul>
115 <li><a href="#bill-of-materials-maven-module" id="markdown-toc-bill-of-materials-maven-module">Bill of Materials Maven Module</a></li>
116 </ul>
117 </li>
118</ul>
119
120<hr />
121
122<h2 id="integrating-with-asterixdb-build">Integrating with AsterixDB Build</h2>
123
124<p>Extensions can be built as part of the AsterixDB + Hyracks build by adding a module in ‘asterixdb/asterix-opt’ The
125 presence of a pom.xml in this directory adds this to the maven reactor as a sub-module of asterixdb.</p>
126
127<h3 id="bill-of-materials-maven-module">Bill of Materials Maven Module</h3>
128
129<p>A Bill of Materials (i.e. BOM) must be provided to indicate which (if any) jars &amp; dependencies should be included in
130 the AsterixDB (e.g. asterix-server, asterix-installer, etc.) binary assemblies. Typically, the maven module defined
131 in asterixdb/asterix-opt will have a BOM project as a sub-module.</p>
132
133<p>This BOM must have the following coordinates, as this is used as the linkage into the asterix-server binary-assembly:
134<code>org.apache.asterix:asterix-opt-bom:0.8.9-SNAPSHOT:pom</code> (<em>version must match AsterixDB project version</em>)</p>
135
136<p>Any dependencies specified in the BOM (as well as transitive dependencies) will be included in the AsterixDB binary
137 assemblies. If no jars are desired to be included in the AsterixDB binary assemblies, the BOM need not specify any
138 dependencies.</p>
139
140<h4 id="example-bom">Example BOM</h4>
141
Till Westmann6d47eed2016-10-08 20:21:30 -0700[diff] [blame]142<pre><code>&lt;project
143 xmlns="http://maven.apache.org/POM/4.0.0"
144 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
145 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"&gt;
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]146
Till Westmann6d47eed2016-10-08 20:21:30 -0700[diff] [blame]147 &lt;modelVersion&gt;4.0.0&lt;/modelVersion&gt;
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]148
Till Westmann6d47eed2016-10-08 20:21:30 -0700[diff] [blame]149 &lt;!-- project coordinates --&gt;
150 &lt;groupId&gt;org.apache.asterix&lt;/groupId&gt;
151 &lt;artifactId&gt;asterix-opt-bom&lt;/artifactId&gt;
152 &lt;version&gt;0.8.9-SNAPSHOT&lt;/version&gt;
Michael Blow3bc9e1c2016-10-14 14:00:39 -0400[diff] [blame]153 &lt;packaging&gt;pom&lt;/packaging&gt;
Till Westmann6d47eed2016-10-08 20:21:30 -0700[diff] [blame]154 &lt;name&gt;psu-nittany-bom&lt;/name&gt;
155 &lt;description&gt;Penn State Nittany Lion Search Extension to AsterixDB&lt;/description&gt;
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]156
Till Westmann6d47eed2016-10-08 20:21:30 -0700[diff] [blame]157 &lt;!-- any dependencies listed here will be included in --&gt;
158 &lt;!-- asterix-server, etc. binary assemblies --&gt;
159 &lt;dependencies&gt;
160 &lt;dependency&gt;
161 &lt;groupId&gt;edu.psu.cs&lt;/groupId&gt;
162 &lt;artifactId&gt;nittany-search&lt;/artifactId&gt;
163 &lt;version&gt;0.1.0-SNAPSHOT&lt;/version&gt;
Till Westmann6d47eed2016-10-08 20:21:30 -0700[diff] [blame]164 &lt;/dependency&gt;
165 &lt;/dependencies&gt;
166&lt;/project&gt;
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]167</code></pre>
168
169</div>
170</div>
171
172
173 <hr/>
174
175 <footer>
176 <div class="row">
177 <div class="col-md-9 col-centered text-center">
178 <p/>
179 <p>&copy; Copyright 2016 The Apache Software foundation. All Rights Reserved. </p>
180 <p>Apache AsterixDB, the Apache AsterixDB logo, Apache, and the Apache feather logo are trademarks of the
181 Apache Software Foundation</p>
182 </div>
183 </div>
184 </footer>
185 </div> <!-- /container -->
186
187 <!-- Bootstrap core JavaScript
188 ================================================== -->
189 <!-- Placed at the end of the document so the pages load faster -->
190 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
191 <script src="js/bootstrap.min.js"></script>
192 </body>
193</html>