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