output/current/compiler.html - gora-site - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!--
 Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing,
 software distributed under the License is distributed on an
 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
 <html>
   <head>
     <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta name="author" content="dev@gora.apache.org" />

     <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
     <meta name="Description" content="Apache Gora -- Gora Compiler Overview" />
     <meta name="Keywords" content="Apache Gora NoSQL Framework" />
     <meta name="Owner" content="dev@gora.apache.org" />
     <meta name="Robots" content="index, follow" />
     <meta name="Security" content="Public" />
     <meta name="Source" content="wiki template" />
     <meta
       name="DC.Rights"
       content="Copyright 2010-2024, The Apache Software Foundation"
     />
     <link href="/resources/css/bootstrap.min.css" rel="stylesheet" />
     <!-- Fav and touch icons -->
     <link
       rel="apple-touch-icon-precomposed"
       sizes="144x144"
       href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-144-precomposed.png"
     />
     <link
       rel="apple-touch-icon-precomposed"
       sizes="114x114"
       href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-114-precomposed.png"
     />
     <link
       rel="apple-touch-icon-precomposed"
       sizes="72x72"
       href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-72-precomposed.png"
     />
     <link
       rel="apple-touch-icon-precomposed"
       href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-57-precomposed.png"
     />
     <link rel="shortcut icon" href="/resources/img/feather-small.png" />

     <title>Apache Gora&trade; - Gora Compiler Overview</title>
   </head>

   <body style="padding-top: 100px">
     <nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top shadow-lg">
       <div class="container-fluid">
         <a class="navbar-brand" href="/index.html"
           ><img
             src="/resources/img/gora-logo.png"
             alt="Apache Gora"
             title="Apache Gora"
             height="50px"
         /></a>
         <button
           class="navbar-toggler"
           type="button"
           data-bs-toggle="collapse"
           data-bs-target="#navbarNav"
           aria-controls="navbarNav"
           aria-expanded="false"
           aria-label="Toggle navigation"
         >
           <span class="navbar-toggler-icon"></span>
         </button>
         <div class="collapse navbar-collapse" id="navbarNav">
           <ul class="navbar-nav me-auto">
             <li class="nav-item">
               <a class="nav-link" href="/downloads.html">Downloads</a>
             </li>
             <li class="nav-item dropdown">
               <a
                 class="nav-link dropdown-toggle"
                 href="#"
                 id="navbarDropdown1"
                 role="button"
                 data-bs-toggle="dropdown"
                 aria-expanded="false"
                 >Community</a
               >
               <ul class="dropdown-menu" aria-labelledby="navbarDropdown1">
                 <li>
                   <a
                     class="dropdown-item"
                     href="https://whimsy.apache.org/board/minutes/Gora.html"
                     >Board Reporting</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/contribute.html"
                     >Contribute</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/mailing_lists.html"
                     >Mailing Lists</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/credits.html">People</a>
                 </li>
                 <li>
                   <a class="dropdown-item" href="/related.html"
                     >Related Projects</a
                   >
                 </li>
               </ul>
             </li>
             <li class="nav-item dropdown">
               <a
                 class="nav-link dropdown-toggle"
                 href="#"
                 id="navbarDropdown2"
                 role="button"
                 data-bs-toggle="dropdown"
                 aria-expanded="false"
                 >Documentation</a
               >
               <ul class="dropdown-menu" aria-labelledby="navbarDropdown2">
                 <li><a class="dropdown-item" href="/about.html">About</a></li>
                 <li>
                   <a class="dropdown-item" href="/current/index.html"
                     >Current Documentation</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/current/api/javadoc.html"
                     >JavaDoc Documentation</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/current/tutorial.html"
                     >Gora Tutorial</a
                   >
                 </li>
                 <li>
                   <a
                     class="dropdown-item"
                     href="https://cwiki.apache.org/confluence/display/GORA/"
                     >Gora Wiki</a
                   >
                 </li>
               </ul>
             </li>
             <li class="nav-item dropdown">
               <a
                 class="nav-link dropdown-toggle"
                 href="#"
                 id="navbarDropdown3"
                 role="button"
                 data-bs-toggle="dropdown"
                 aria-expanded="false"
                 >Development</a
               >
               <ul class="dropdown-menu" aria-labelledby="navbarDropdown3">
                 <li>
                   <a
                     class="dropdown-item"
                     href="https://issues.apache.org/jira/browse/GORA"
                     >Issue Tracking</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/mailing_lists.html"
                     >Mailing Lists</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/version_control.html"
                     >Version Control</a
                   >
                 </li>
                 <li>
                   <a class="dropdown-item" href="/roadmap.html">Roadmap</a>
                 </li>
               </ul>
             </li>
             <li class="nav-item dropdown">
               <a
                 class="nav-link dropdown-toggle"
                 href="#"
                 id="navbarDropdown4"
                 role="button"
                 data-bs-toggle="dropdown"
                 aria-expanded="false"
               >
                 <img
                   src="/resources/img/feather-small.png"
                   alt="Apache"
                   title="Apache"
                 />
               </a>
               <ul class="dropdown-menu" aria-labelledby="navbarDropdown4">
                 <li>
                   <a class="dropdown-item" href="http://www.apache.org"
                     >Apache Home</a
                   >
                 </li>
                 <li>
                   <a
                     class="dropdown-item"
                     href="http://www.apache.org/licenses/"
                     >Apache License</a
                   >
                 </li>
                 <li>
                   <a
                     class="dropdown-item"
                     href="http://www.apache.org/security/"
                     >Security</a
                   >
                 </li>
                 <li>
                   <a
                     class="dropdown-item"
                     href="http://www.apache.org/foundation/sponsorship.html"
                     >Support</a
                   >
                 </li>
                 <li>
                   <a
                     class="dropdown-item"
                     href="http://www.apache.org/foundation/thanks.html"
                     >Thanks</a
                   >
                 </li>
               </ul>
             </li>
           </ul>
         </div>
       </div>
     </nav>

     <div class="container top-buffer" id="Gora_Gora Compiler Overview">
     <h1 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permalink">&para;</a></h1>
 <p>The Gora compiler converts JSON files (the schema(s)) into persistent Java classes/data beans.
 You can then use those classes to interact with a variety of data storage software e.g. the Gora datastore implementations.</p>
 <p>The compiler is very simple to run. But first you should add the Gora installation directory to your path.</p>
 <h1 id="usage">Usage<a class="headerlink" href="#usage" title="Permalink">&para;</a></h1>
 <pre><code> $ bin/gora goracompiler
 </code></pre>
 <p>results in:</p>
 <pre><code> $ Usage: GoraCompiler &lt;schema file&gt; &lt;output dir&gt; [-license &lt;id&gt;]
    &lt;schema file&gt;     - individual avsc file to be compiled or a directory path containing avsc files
    &lt;output dir&gt;      - output directory for generated Java files
    [-license &lt;id&gt;]   - the preferred license header to add to the
            generated Java file. Current options include;
     ASLv2   (Apache Software License v2.0)
     AGPLv3  (GNU Affero General Public License)
     CDDLv1  (Common Development and Distribution License v1.0)
     FDLv13  (GNU Free Documentation License v1.3)
     GPLv1   (GNU General Public License v1.0)
     GPLv2   (GNU General Public License v2.0)
     GPLv3   (GNU General Public License v3.0)
     LGPLv21 (GNU Lesser General Public License v2.1)
     LGPLv3  (GNU Lesser General Public License v2.1)
 </code></pre>
 <p>so for example, one would typically enter:</p>
 <pre><code> $ bin/gora goracompiler gora-tutorial/src/main/avro/pageview.json gora-tutorial/src/main/java/
 </code></pre>
 <p>The schema file is a single JSON file or a directory containing JSON files.</p>
 <p>The output directory is the destination for the generated Java source files. For example, if you specific src/main/java then the
 generate source is placed into src/main/java/generated. It's generally a good idea to ignore the generate directory in whatever
 version control software you're using. You are using version control, right?</p>
 <p>Finally, the license parameter tells the compile to add a license header to each generated file. Current header options include:</p>
 <ul>
 <li>ASLv2   (<a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache Software License v2.0</a>)</li>
 <li>AGPLv3  (<a href="http://www.gnu.org/licenses/agpl.html">GNU Affero General Public License</a>)</li>
 <li>CDDLv1  (<a href="http://opensource.org/licenses/CDDL-1.0">Common Development and Distribution License v1.0</a>)</li>
 <li>FDLv13  (&lt;a href-"<a href="http://www.gnu.org/copyleft/fdl.html%22%3EGNU">http://www.gnu.org/copyleft/fdl.html"&gt;GNU</a> Free Documentation License v1.3)</li>
 <li>GPLv1   (<a href="http://www.gnu.org/licenses/gpl-1.0.html">GNU General Public License v1.0</a>)</li>
 <li>GPLv2   (<a href="http://www.gnu.org/licenses/gpl-2.0.html">GNU General Public License v2.0</a>)</li>
 <li>GPLv3   (<a href="http://www.gnu.org/licenses/gpl-3.0.html">GNU General Public License v3.0</a>)</li>
 <li>LGPLv21 (<a href="http://www.gnu.org/licenses/lgpl-2.1.html">GNU Lesser General Public License v2.1</a>)</li>
 <li>LGPLv3  (<a href="http://www.gnu.org/licenses/lgpl-3.0.html">GNU Lesser General Public License v3</a>)</li>
 </ul>
 <p>It should be noted that if no license header argument is passed, by default the ASLv2 license profile is selected.</p>

     </div>
     <!-- /container (main block) -->

     <hr />

     <div class="container">
       <footer>
         <p>
           Copyright © 2010-2024 The Apache Software Foundation.
           Licensed under
           <a href="http://www.apache.org/licenses/LICENSE-2.0"
             >Apache License 2.0</a
           >.
         </p>
         <p>
           Apache Gora, Gora, Apache, the Apache feather logo, and the Apache
           Gora project logo are trademarks of The Apache Software Foundation.
         </p>
       </footer>
     </div>
     <!-- /container -->

     <script src="/resources/js/bootstrap.bundle.min.js"></script>
     <script type="text/javascript">
       stLight.options({
         publisher: "4059fafd-3891-49f9-8c96-e4100290d8e6",
         doNotHash: false,
         doNotCopy: false,
         hashAddressBar: false,
       });
     </script>
     <script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.0.1/build/highlight.min.js"></script>
     <script>
       hljs.highlightAll();
     </script>
   </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<html>
	<head>
	<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
	<meta charset="utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1.0" />
	<meta name="author" content="dev@gora.apache.org" />

	<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
	<meta name="Description" content="Apache Gora -- Gora Compiler Overview" />
	<meta name="Keywords" content="Apache Gora NoSQL Framework" />
	<meta name="Owner" content="dev@gora.apache.org" />
	<meta name="Robots" content="index, follow" />
	<meta name="Security" content="Public" />
	<meta name="Source" content="wiki template" />
	<meta
	name="DC.Rights"
	content="Copyright 2010-2024, The Apache Software Foundation"
	/>
	<link href="/resources/css/bootstrap.min.css" rel="stylesheet" />
	<!-- Fav and touch icons -->
	<link
	rel="apple-touch-icon-precomposed"
	sizes="144x144"
	href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-144-precomposed.png"
	/>
	<link
	rel="apple-touch-icon-precomposed"
	sizes="114x114"
	href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-114-precomposed.png"
	/>
	<link
	rel="apple-touch-icon-precomposed"
	sizes="72x72"
	href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-72-precomposed.png"
	/>
	<link
	rel="apple-touch-icon-precomposed"
	href="http://twitter.github.com/bootstrap/assets/ico/apple-touch-icon-57-precomposed.png"
	/>
	<link rel="shortcut icon" href="/resources/img/feather-small.png" />

	<title>Apache Gora™ - Gora Compiler Overview</title>
	</head>

	<body style="padding-top: 100px">
	<nav class="navbar navbar-expand-lg navbar-dark bg-dark fixed-top shadow-lg">
	<div class="container-fluid">
	<a class="navbar-brand" href="/index.html"
	><img
	src="/resources/img/gora-logo.png"
	alt="Apache Gora"
	title="Apache Gora"
	height="50px"
	/></a>
	<button
	class="navbar-toggler"
	type="button"
	data-bs-toggle="collapse"
	data-bs-target="#navbarNav"
	aria-controls="navbarNav"
	aria-expanded="false"
	aria-label="Toggle navigation"
	>
	<span class="navbar-toggler-icon"></span>
	</button>
	<div class="collapse navbar-collapse" id="navbarNav">
	<ul class="navbar-nav me-auto">
	<li class="nav-item">
	<a class="nav-link" href="/downloads.html">Downloads</a>
	</li>
	<li class="nav-item dropdown">
	<a
	class="nav-link dropdown-toggle"
	href="#"
	id="navbarDropdown1"
	role="button"
	data-bs-toggle="dropdown"
	aria-expanded="false"
	>Community</a
	>
	<ul class="dropdown-menu" aria-labelledby="navbarDropdown1">
	<li>
	<a
	class="dropdown-item"
	href="https://whimsy.apache.org/board/minutes/Gora.html"
	>Board Reporting</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/contribute.html"
	>Contribute</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/mailing_lists.html"
	>Mailing Lists</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/credits.html">People</a>
	</li>
	<li>
	<a class="dropdown-item" href="/related.html"
	>Related Projects</a
	>
	</li>
	</ul>
	</li>
	<li class="nav-item dropdown">
	<a
	class="nav-link dropdown-toggle"
	href="#"
	id="navbarDropdown2"
	role="button"
	data-bs-toggle="dropdown"
	aria-expanded="false"
	>Documentation</a
	>
	<ul class="dropdown-menu" aria-labelledby="navbarDropdown2">
	<li><a class="dropdown-item" href="/about.html">About</a></li>
	<li>
	<a class="dropdown-item" href="/current/index.html"
	>Current Documentation</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/current/api/javadoc.html"
	>JavaDoc Documentation</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/current/tutorial.html"
	>Gora Tutorial</a
	>
	</li>
	<li>
	<a
	class="dropdown-item"
	href="https://cwiki.apache.org/confluence/display/GORA/"
	>Gora Wiki</a
	>
	</li>
	</ul>
	</li>
	<li class="nav-item dropdown">
	<a
	class="nav-link dropdown-toggle"
	href="#"
	id="navbarDropdown3"
	role="button"
	data-bs-toggle="dropdown"
	aria-expanded="false"
	>Development</a
	>
	<ul class="dropdown-menu" aria-labelledby="navbarDropdown3">
	<li>
	<a
	class="dropdown-item"
	href="https://issues.apache.org/jira/browse/GORA"
	>Issue Tracking</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/mailing_lists.html"
	>Mailing Lists</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/version_control.html"
	>Version Control</a
	>
	</li>
	<li>
	<a class="dropdown-item" href="/roadmap.html">Roadmap</a>
	</li>
	</ul>
	</li>
	<li class="nav-item dropdown">
	<a
	class="nav-link dropdown-toggle"
	href="#"
	id="navbarDropdown4"
	role="button"
	data-bs-toggle="dropdown"
	aria-expanded="false"
	>
	<img
	src="/resources/img/feather-small.png"
	alt="Apache"
	title="Apache"
	/>
	</a>
	<ul class="dropdown-menu" aria-labelledby="navbarDropdown4">
	<li>
	<a class="dropdown-item" href="http://www.apache.org"
	>Apache Home</a
	>
	</li>
	<li>
	<a
	class="dropdown-item"
	href="http://www.apache.org/licenses/"
	>Apache License</a
	>
	</li>
	<li>
	<a
	class="dropdown-item"
	href="http://www.apache.org/security/"
	>Security</a
	>
	</li>
	<li>
	<a
	class="dropdown-item"
	href="http://www.apache.org/foundation/sponsorship.html"
	>Support</a
	>
	</li>
	<li>
	<a
	class="dropdown-item"
	href="http://www.apache.org/foundation/thanks.html"
	>Thanks</a
	>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	</div>
	</nav>

	<div class="container top-buffer" id="Gora_Gora Compiler Overview">
	<h1 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permalink">¶</a></h1>
	<p>The Gora compiler converts JSON files (the schema(s)) into persistent Java classes/data beans.
	You can then use those classes to interact with a variety of data storage software e.g. the Gora datastore implementations.</p>
	<p>The compiler is very simple to run. But first you should add the Gora installation directory to your path.</p>
	<h1 id="usage">Usage<a class="headerlink" href="#usage" title="Permalink">¶</a></h1>
	<pre><code> $ bin/gora goracompiler
	</code></pre>
	<p>results in:</p>
	<pre><code> $ Usage: GoraCompiler <schema file> <output dir> [-license <id>]
	<schema file> - individual avsc file to be compiled or a directory path containing avsc files
	<output dir> - output directory for generated Java files
	[-license <id>] - the preferred license header to add to the
	generated Java file. Current options include;
	ASLv2 (Apache Software License v2.0)
	AGPLv3 (GNU Affero General Public License)
	CDDLv1 (Common Development and Distribution License v1.0)
	FDLv13 (GNU Free Documentation License v1.3)
	GPLv1 (GNU General Public License v1.0)
	GPLv2 (GNU General Public License v2.0)
	GPLv3 (GNU General Public License v3.0)
	LGPLv21 (GNU Lesser General Public License v2.1)
	LGPLv3 (GNU Lesser General Public License v2.1)
	</code></pre>
	<p>so for example, one would typically enter:</p>
	<pre><code> $ bin/gora goracompiler gora-tutorial/src/main/avro/pageview.json gora-tutorial/src/main/java/
	</code></pre>
	<p>The schema file is a single JSON file or a directory containing JSON files.</p>
	<p>The output directory is the destination for the generated Java source files. For example, if you specific src/main/java then the
	generate source is placed into src/main/java/generated. It's generally a good idea to ignore the generate directory in whatever
	version control software you're using. You are using version control, right?</p>
	<p>Finally, the license parameter tells the compile to add a license header to each generated file. Current header options include:</p>
	<ul>
	<li>ASLv2 (<a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache Software License v2.0</a>)</li>
	<li>AGPLv3 (<a href="http://www.gnu.org/licenses/agpl.html">GNU Affero General Public License</a>)</li>
	<li>CDDLv1 (<a href="http://opensource.org/licenses/CDDL-1.0">Common Development and Distribution License v1.0</a>)</li>
	<li>FDLv13 (<a href-"<a href="http://www.gnu.org/copyleft/fdl.html%22%3EGNU">http://www.gnu.org/copyleft/fdl.html">GNU</a> Free Documentation License v1.3)</li>
	<li>GPLv1 (<a href="http://www.gnu.org/licenses/gpl-1.0.html">GNU General Public License v1.0</a>)</li>
	<li>GPLv2 (<a href="http://www.gnu.org/licenses/gpl-2.0.html">GNU General Public License v2.0</a>)</li>
	<li>GPLv3 (<a href="http://www.gnu.org/licenses/gpl-3.0.html">GNU General Public License v3.0</a>)</li>
	<li>LGPLv21 (<a href="http://www.gnu.org/licenses/lgpl-2.1.html">GNU Lesser General Public License v2.1</a>)</li>
	<li>LGPLv3 (<a href="http://www.gnu.org/licenses/lgpl-3.0.html">GNU Lesser General Public License v3</a>)</li>
	</ul>
	<p>It should be noted that if no license header argument is passed, by default the ASLv2 license profile is selected.</p>

	</div>
	<!-- /container (main block) -->

	<hr />

	<div class="container">
	<footer>
	<p>
	Copyright © 2010-2024 The Apache Software Foundation.
	Licensed under
	<a href="http://www.apache.org/licenses/LICENSE-2.0"
	>Apache License 2.0</a
	>.
	</p>
	<p>
	Apache Gora, Gora, Apache, the Apache feather logo, and the Apache
	Gora project logo are trademarks of The Apache Software Foundation.
	</p>
	</footer>
	</div>
	<!-- /container -->

	<script src="/resources/js/bootstrap.bundle.min.js"></script>
	<script type="text/javascript">
	stLight.options({
	publisher: "4059fafd-3891-49f9-8c96-e4100290d8e6",
	doNotHash: false,
	doNotCopy: false,
	hashAddressBar: false,
	});
	</script>
	<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.0.1/build/highlight.min.js"></script>
	<script>
	hljs.highlightAll();
	</script>
	</body>
	</html>