Changes

This page is part of the [[Developer Section]]. It describes how to get the BaseX sources compiled and running on your system. Another article in the documentation describes how to use BaseX as a [[Integrating Eclipse|query processor in Eclipse]]. ==InstallationPrerequisites==

BaseX is developed with the Eclipse environment (other IDEs like IntelliJ IDEA can be used as well). The [https://www.eclipse.org/downloads/ Eclipse IDE for Java Developers] includes the EGit plugin (for [[Git]]) and the m2e plugin (for [[Maven]]). Other plugins we use are: {| class="wikitable" |- valign="top"! Name! Description! Update URL! Eclipse Marketplace|-| [http://eclipse-cs.sourceforge.net eclipse-cs]| Enforces Checkstyle coding standards.| <code><nowiki>http://eclipse-cs.sf.net/update/</nowiki></code>| [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=150 install]|-| [https://spotbugs.github.io/ SpotBugs]| Analyze project at byte code level| <code><nowiki>https://spotbugs.github.io/eclipse/</nowiki></code>| [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=3519199 install]|-| [http://www.ucdetector.org/ UCDetector]| Unnecessary code detector| <code><nowiki>http://ucdetector.sourceforge.net/update</nowiki></code>| [https://marketplace.eclipse.org/marketplace-client-intro?mpc_install=661 install]|} =Eclipse Integration=Check Out==

<p>BaseX is being developed with the Eclipse environment. Some styleguidelines are integrated in the sources of BaseX;they are being embedded as soon as you open the project.</p> <p>The Our [[http://subclipse.tigris.org Subclipse PluginGit|Git Tutorial]] is neededto check explains how BaseX can be checked out the latest sources from our repository.Next, we recommend to use the[httphttps://m2eclipsegithub.sonatype.org m2eclipsecom/BaseXdb/basex GitHub Repository] pluginto add Maven support to and embedded in Eclipsewith EGit.Some additional guidelines are defined via Checkstyle and The article also demonstrates how git can beintegrated with the [http://eclipseused on command-csline.sourceforge.net eclipse-cs] plugin.</p> <p>To checkout BaseX, do The basex repository contains the followingsubdirectories:</p> #File &raquo; Import#SVN &raquo; Check out Projects from SVN#Use the repository [https://svn.uni-konstanz.de/dbis/{{Code|basex https://svn.uni-konstanz.de/dbis/basex] and click "Browse"#Choose the project you like:<br/> ##[https://svn.uni-konstanz.de/dbis/basex/trunk/basex basex] core}} is the main project##[https://svn.uni{{Code|basex-konstanz.de/dbis/basex/trunk/api api] }} contains the BaseX APIs (XQJXML:DB, XMLDB and bindings in other languages) and HTTP Services ([[REST]], [[RESTXQ]], [[WebDAV]]) ##[https://svn.uni{{Code|basex-konstanz.de/dbis/basex/trunk/examples }} includes some examples] demonstrates some use cases code for BaseX #Click Finish{{Code|basex-tests}} contains several unit and stress tests If the "Problems" View contains errors or warnings, you may need to switch to Java 11 (''Windows'' → ''Preferences'' → ''Java'' → ''Installed JREs''). ===Run BaseX with Start in Eclipse===  #Press ''Run &raquo; Run&#8230;'' → ''Run…''#Create a new "Java Application" launch configuration #Select "basex" as "Project" #Choose a "Main class" (e.g., <code>org.basex.BaseXWinBaseXGUI</code> for the graphical user interface) #Launch the project via "''Run"'' ===Compile &#38; Run BaseX=Alternative== <p>If You may as well use the standalone version of [http://maven.apache.org [Maven] is installed, you can ] to compile and run<code> mvn compile </code>in the project directory to compile BaseX.</p> <p>Type in<code> java -cp target, use other IDEs such as [https:/classes/orgwww.basexjetbrains.BaseX <com/code>to run BaseX.<idea/p> <p>You can launch the following classes, which are all placed in the <code>orgIntelliJ IDEA].basex</code> main package:</p>

;BaseX: console mode;BaseXServer: server instance, waiting for requests;BaseXClient: console mode, interacting with the server;BaseXGUI:graphical user interface <p>Moreover, try <code>-h</code> to have a look at the available command-line options. For example, you can evaluate XQuery expressions or process database commands without entering the console.</p> ==Integration== <p>As BaseX is offered in a Maven repository, you can easily embed it in your own projects.In order to use the BaseX Maven Artifacts, add the following lines to your<code>pom.xml</code> file:</p> <pre class="brush:xml">&lt;repositories&gt; &lt;repository&gt; &lt;id&gt;dbis-ukn&lt;/id&gt; &lt;name&gt;DBIS Maven Repository&lt;/name&gt; &lt;url&gt;http://www.inf.uni-konstanz.de/dbis/basex/maven&lt;/url&gt; &lt;/repository&gt;&lt;/repositories&gt;</pre> ===BaseX Artifact=== <pre class="brush:xml">&lt;dependency&gt; &lt;groupId&gt;org.basex&lt;/groupId&gt; &lt;artifactId&gt;basex&lt;/artifactId&gt; &lt;version&gt;6.2.4&lt;/version&gt;&lt;/dependency&gt;</pre> ===BaseX API Artifact=== <p>...including the [http[Category://jcp.org/en/jsr/detail?id=225 XQJDeveloper] and [http://sourceforge.net/projects/xmldb-org XML:DB] API:</p> <pre class="brush:xml">&lt;dependency&gt; &lt;groupId&gt;org.basex&lt;/groupId&gt; &lt;artifactId&gt;basex-api&lt;/artifactId&gt; &lt;version&gt;6.2.4&lt;/version&gt;&lt;/dependency&gt;</pre>