Integrating IntelliJ IDEA

From BaseX Documentation

(Difference between revisions)
Jump to: navigation, search
Line 84: Line 84:
* In the project view, create a new XQuery file, either by right-clicking on the project name and choosing ''New''→''XQuery File'' or by selecting ''New''→''XQuery File'' from the File menu. Enter a file name and click ''OK''.
* In the project view, create a new XQuery file, either by right-clicking on the project name and choosing ''New''→''XQuery File'' or by selecting ''New''→''XQuery File'' from the File menu. Enter a file name and click ''OK''.
* Type in your query.
* Type in your query.
 +
[[File:Intellij-query.png]]
* Click the green ''Run'' button below the IntelliJ IDEA menu bar.
* Click the green ''Run'' button below the IntelliJ IDEA menu bar.
* In the ''Edit Configuration'' dialog choose one of the two data source from the dropdown box, either "BaseX" or "BaseX (native embedded)". If you select "BaseX", make sure that BaseX is up and running.
* In the ''Edit Configuration'' dialog choose one of the two data source from the dropdown box, either "BaseX" or "BaseX (native embedded)". If you select "BaseX", make sure that BaseX is up and running.
Line 112: Line 113:
==Configuring The Processor==
==Configuring The Processor==
* Start IntelliJ IDEA and navigate to ''Settings/Preferences'' either using the ''Configure'' button from the start screen or the ''IntelliJ IDEA'' menu.
* Start IntelliJ IDEA and navigate to ''Settings/Preferences'' either using the ''Configure'' button from the start screen or the ''IntelliJ IDEA'' menu.
-
* In the Settings/Preferences window, expand the ''Languages & Frameworks'' item, select ''XQuery''.
+
* In the Settings/Preferences window, expand the ''Languages & Frameworks'' item and select ''XQuery''.
* Make the choices for your system from the dropdown boxes, e.g.:
* Make the choices for your system from the dropdown boxes, e.g.:
** <code>Implementation = BaseX</code>
** <code>Implementation = BaseX</code>
Line 119: Line 120:
** <code>Dialect for XQuery 3.0 = BaseX</code>
** <code>Dialect for XQuery 3.0 = BaseX</code>
** <code>Dialect for XQuery 3.1 = BaseX</code>
** <code>Dialect for XQuery 3.1 = BaseX</code>
 +
[[File:Intellij-xquery-settings-2.png‎]]
* Click ''Apply'' to store your XQuery settings and then ''OK'' to exit the dialog.
* Click ''Apply'' to store your XQuery settings and then ''OK'' to exit the dialog.
Line 126: Line 128:
* Enter a name and location for your project.
* Enter a name and location for your project.
* Click the ''Add Configuration'' button below the IntelliJ IDEA menu bar.
* Click the ''Add Configuration'' button below the IntelliJ IDEA menu bar.
-
* Expand the Templates list and choose the ''XQuery'' entry.
+
[[File:Intellij-add-configuration.png]]
-
* In the ''Run/Debug Configurations'' dialog click on the three dots {{Code|...}} next to the ''Query Processor'' dropdown box.
+
* In the ''Run/Debug Configurations'' dialog expand the Templates list and choose the ''XQuery'' entry.
 +
* Click on the three dots {{Code|...}} next to the ''Query Processor'' dropdown box.
* In the ''Manage Query Processors'' dialog click on the {{Code|+}} button.
* In the ''Manage Query Processors'' dialog click on the {{Code|+}} button.
* In the ''New Query Processor Instance" dialog, set the following preferences:
* In the ''New Query Processor Instance" dialog, set the following preferences:
Line 137: Line 140:
** <code>Username = admin</code>
** <code>Username = admin</code>
** <code>Password = admin</code>
** <code>Password = admin</code>
 +
[[File:Intellij-new-query-processor.png]]
* Click ''OK'' to exit the ''New Query Processor Instance" dialog.
* Click ''OK'' to exit the ''New Query Processor Instance" dialog.
* In the ''Manage Query Processors'' now choose the "BaseX 9.1.1 (BaseX)" entry and click ''OK''.
* In the ''Manage Query Processors'' now choose the "BaseX 9.1.1 (BaseX)" entry and click ''OK''.
Line 149: Line 153:
* The query processor should be preset to "BaseX 9.1.1 (BaseX)".
* The query processor should be preset to "BaseX 9.1.1 (BaseX)".
* In the ''Script File'' field enter the path to your query file.
* In the ''Script File'' field enter the path to your query file.
 +
[[File:Intellij-xquery-configuration.png]]
* Click ''Apply'' and then ''OK'' to close the ''Run/Debug Configurations'' dialog.
* Click ''Apply'' and then ''OK'' to close the ''Run/Debug Configurations'' dialog.
* Now, the green ''Run'' button should be available below the IntelliJ IDEA menu bar.
* Now, the green ''Run'' button should be available below the IntelliJ IDEA menu bar.
-
* Make sure that BaseX is up and running and click ''Run'' to execute your query.
+
[[File:Intellij-run-button.png]]
 +
* Make sure that BaseX is up and running and click the ''Run'' button to execute your query.

Revision as of 15:09, 24 January 2019

This article is part of the Getting Started Section. It describes how to run XPath/XQuery code from within the IntelliJ IDEA IDE. There are currently two XQuery plugins for IntelliJ IDEA on the market:

Contents

Preparations

The following steps apply to all operating systems:

XQuery Support + MarkLogic Debugger

This section focuses on Grzegorz Ligas' XQuery Support plugin.

Installation

After installing IntelliJ IDEA and BaseX, install the XQuery Support plugin by one of the following methods:

From the Start Screen

Intellij-startbildschirm.png

From the IntelliJ IDEA Menu

Setting Up

File Extensions and XQuery Flavor

Intellij-xquery-settings.png

Configuring The Processor

You can set up the plugin as a standalone processor or client.

Standalone

Client

This assumes that you already have a BaseX database named factbook.

Intellij-basex-data-source.png

Querying Your Data

Intellij-query.png

xquery-intellij-plugin

This section focuses on Reece H. Dunn's xquery-intellij-plugin.

Installation

After installing IntelliJ IDEA and BaseX, install the xquery-intellij-plugin by one of the following methods:

From the Start Screen

From the IntelliJ IDEA Menu

Configuring The Processor

Intellij-xquery-settings-2.png

Querying Your Data

Intellij-add-configuration.png

Intellij-new-query-processor.png

Intellij-xquery-configuration.png

Intellij-run-button.png

Personal tools
Namespaces
Variants
Actions
Navigation
Print/export