Integrating IntelliJ IDEA

From BaseX Documentation

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
This article is part of the [[Getting Started]] Section. It describes how to run XPath/XQuery code from within the [https://www.jetbrains.com/idea IntelliJ IDEA IDE]. There are currently two XQuery plugins for IntelliJ IDEA on the market:
This article is part of the [[Getting Started]] Section. It describes how to run XPath/XQuery code from within the [https://www.jetbrains.com/idea IntelliJ IDEA IDE]. There are currently two XQuery plugins for IntelliJ IDEA on the market:
-
* The [https://plugins.jetbrains.com/plugin/9757-xquery-support--marklogic-debugger XQuery Support + MarkLogic Debugger] plugin by Grzegorz Ligas.
 
* The [https://plugins.jetbrains.com/plugin/8612-xquery-intellij-plugin xquery-intellij-plugin] by Reece H. Dunn.
* The [https://plugins.jetbrains.com/plugin/8612-xquery-intellij-plugin xquery-intellij-plugin] by Reece H. Dunn.
 +
* The [https://plugins.jetbrains.com/plugin/9757-xquery-support--marklogic-debugger XQuery Support + MarkLogic Debugger] plugin by Grzegorz Ligas.
* '''Note:''' BaseX itself is a highly compliant XQuery 3.1 processor. We strongly encourage you to use the [[Graphical_User_Interface#Text_Editor|XML editor]] integrated into the BaseX GUI to edit and query your XML data!<br/><br/>
* '''Note:''' BaseX itself is a highly compliant XQuery 3.1 processor. We strongly encourage you to use the [[Graphical_User_Interface#Text_Editor|XML editor]] integrated into the BaseX GUI to edit and query your XML data!<br/><br/>
Line 13: Line 13:
* Start BaseX (see [[Startup]]).
* Start BaseX (see [[Startup]]).
* Create a BaseX database (see [[Databases]]).
* Create a BaseX database (see [[Databases]]).
 +
 +
=xquery-intellij-plugin=
 +
 +
This section focuses on Reece H. Dunn's [https://plugins.jetbrains.com/plugin/8612-xquery-intellij-plugin 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===
 +
* Start IntelliJ IDEA and select ''Configure''→''Plugins''.
 +
* In the Plugins window, select the tab ''Marketplace''.
 +
* Type "XQuery" into the ''Search plugins in marketplace'' field.
 +
* Click the ''Install'' button below ''xquery-intellij-plugin''.
 +
* You will be prompted to restart IDEA to load the new plugin.
 +
 +
===From the IntelliJ IDEA Menu===
 +
* Select ''Settings'' (Windows)/''Preferences'' (macOS) in the ''IntelliJ IDEA'' menu.
 +
* In the Settings/Preferences window, select ''Plugins''.
 +
* In the Plugins window, select the tab ''Marketplace''.
 +
* Type "XQuery" into the ''Search plugins in marketplace'' field.
 +
* Click the ''Install'' button below ''xquery-intellij-plugin'' plugin.
 +
* You will be prompted to restart IDEA to load the new plugin.
 +
 +
==Configuring The Processor==
 +
* Start IntelliJ IDEA and navigate to ''Settings'' (Windows)/''Preferences'' (macOS) either using the ''Configure'' button from the start screen or the ''IntelliJ IDEA'' menu.
 +
* 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.:
 +
** <code>Implementation = BaseX</code>
 +
** <code>Implementation version = BaseX 9.1</code>
 +
** <code>Default XQuery version = XQuery 3.1</code>
 +
** <code>Dialect for XQuery 3.0 = 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.
 +
 +
==Querying Your Data==
 +
* To create a new project choose the ''Create new project'' option from the start screen or select ''New''→''Project...'' from the ''File'' menu.
 +
* In the ''New Project'' dialog, choose ''Empty Project'' from the left-hand column and click the ''Next'' button.
 +
* Enter a name and location for your project.
 +
* Click the ''Add Configuration'' button below the IntelliJ IDEA menu bar.
 +
[[File:Intellij-add-configuration.png]]
 +
* 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 ''New Query Processor Instance'' dialog, set the following preferences:
 +
** <code>Name = BaseX</code>
 +
** <code>Implementation = BaseX</code> (should be preset!)
 +
** <code>JAR File = basex/BaseX.jar</code>
 +
** <code>Hostname = localhost</code>
 +
** <code>Database port = 1984</code>
 +
** <code>Username = admin</code>
 +
** <code>Password = admin</code>
 +
** If you tick the check box ''Create a standalone instance'', the fields ''Hostname'', ''Database port'', ''Username'', and ''Password'' remain empty.
 +
[[File:Intellij-new-query-processor.png]]
 +
* Click ''OK'' to exit the ''New Query Processor Instance'' dialog.
 +
* In the ''Manage Query Processors'' dialog, now choose the "BaseX 9.1.1 (BaseX)" entry and click ''OK''.
 +
* The ''Query Processor'' dropdown box in the ''Run/Debug Configurations'' dialog should now also display "BaseX 9.1.1 (BaseX)". If not, select it from the dropdown box.
 +
* Click ''Apply'' and then ''OK'' to close the ''Run/Debug Configurations'' dialog.
 +
* In the project view, create a new XQuery file, either by right-clicking on the project name and choosing ''New''→''File'' or by selecting ''New''→''File'' from the File menu. Enter a file name and click ''OK''.
 +
* Type in your query.
 +
* Click on the ''Add Configuration'' button once again.
 +
* In the ''Run/Debug Configurations'' dialog, click the {{Code|+}} button to create a new configuration based on a template.
 +
* Choose the "XQuery" template you configured earlier.
 +
* Enter a name, e.g. "BaseX", into the ''Name'' field.
 +
* The query processor should be preset to "BaseX 9.1.1 (BaseX)".
 +
* 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.
 +
* Now, the configuration should be set and the green ''Run'' button should be available below the IntelliJ IDEA menu bar.
 +
[[File:Intellij-run-button.png]]
 +
* If the configuration does not run as a standalone instance, make sure that BaseX is up and running.
 +
* Click the ''Run'' button to execute your query.
=XQuery Support + MarkLogic Debugger=
=XQuery Support + MarkLogic Debugger=
Line 88: Line 160:
* In the ''Edit Configuration'' dialog, choose one of the two data sources 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 sources from the dropdown box, either "BaseX" or "BaseX (native embedded)". If you select "BaseX", make sure that BaseX is up and running.
* Click ''Run'' to execute your query.
* Click ''Run'' to execute your query.
-
 
-
=xquery-intellij-plugin=
 
-
 
-
This section focuses on Reece H. Dunn's [https://plugins.jetbrains.com/plugin/8612-xquery-intellij-plugin 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===
 
-
* Start IntelliJ IDEA and select ''Configure''→''Plugins''.
 
-
* In the Plugins window, select the tab ''Marketplace''.
 
-
* Type "XQuery" into the ''Search plugins in marketplace'' field.
 
-
* Click the ''Install'' button below ''xquery-intellij-plugin''.
 
-
* You will be prompted to restart IDEA to load the new plugin.
 
-
 
-
===From the IntelliJ IDEA Menu===
 
-
* Select ''Settings'' (Windows)/''Preferences'' (macOS) in the ''IntelliJ IDEA'' menu.
 
-
* In the Settings/Preferences window, select ''Plugins''.
 
-
* In the Plugins window, select the tab ''Marketplace''.
 
-
* Type "XQuery" into the ''Search plugins in marketplace'' field.
 
-
* Click the ''Install'' button below ''xquery-intellij-plugin'' plugin.
 
-
* You will be prompted to restart IDEA to load the new plugin.
 
-
 
-
==Configuring The Processor==
 
-
* Start IntelliJ IDEA and navigate to ''Settings'' (Windows)/''Preferences'' (macOS) either using the ''Configure'' button from the start screen or the ''IntelliJ IDEA'' menu.
 
-
* 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.:
 
-
** <code>Implementation = BaseX</code>
 
-
** <code>Implementation version = BaseX 9.1</code>
 
-
** <code>Default XQuery version = XQuery 3.1</code>
 
-
** <code>Dialect for XQuery 3.0 = 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.
 
-
 
-
==Querying Your Data==
 
-
* To create a new project choose the ''Create new project'' option from the start screen or select ''New''→''Project...'' from the ''File'' menu.
 
-
* In the ''New Project'' dialog, choose ''Empty Project'' from the left-hand column and click the ''Next'' button.
 
-
* Enter a name and location for your project.
 
-
* Click the ''Add Configuration'' button below the IntelliJ IDEA menu bar.
 
-
[[File:Intellij-add-configuration.png]]
 
-
* 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 ''New Query Processor Instance'' dialog, set the following preferences:
 
-
** <code>Name = BaseX</code>
 
-
** <code>Implementation = BaseX</code> (should be preset!)
 
-
** <code>JAR File = basex/BaseX.jar</code>
 
-
** <code>Hostname = localhost</code>
 
-
** <code>Database port = 1984</code>
 
-
** <code>Username = admin</code>
 
-
** <code>Password = admin</code>
 
-
** If you tick the check box ''Create a standalone instance'', the fields ''Hostname'', ''Database port'', ''Username'', and ''Password'' remain empty.
 
-
[[File:Intellij-new-query-processor.png]]
 
-
* Click ''OK'' to exit the ''New Query Processor Instance'' dialog.
 
-
* In the ''Manage Query Processors'' dialog, now choose the "BaseX 9.1.1 (BaseX)" entry and click ''OK''.
 
-
* The ''Query Processor'' dropdown box in the ''Run/Debug Configurations'' dialog should now also display "BaseX 9.1.1 (BaseX)". If not, select it from the dropdown box.
 
-
* Click ''Apply'' and then ''OK'' to close the ''Run/Debug Configurations'' dialog.
 
-
* In the project view, create a new XQuery file, either by right-clicking on the project name and choosing ''New''→''File'' or by selecting ''New''→''File'' from the File menu. Enter a file name and click ''OK''.
 
-
* Type in your query.
 
-
* Click on the ''Add Configuration'' button once again.
 
-
* In the ''Run/Debug Configurations'' dialog, click the {{Code|+}} button to create a new configuration based on a template.
 
-
* Choose the "XQuery" template you configured earlier.
 
-
* Enter a name, e.g. "BaseX", into the ''Name'' field.
 
-
* The query processor should be preset to "BaseX 9.1.1 (BaseX)".
 
-
* 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.
 
-
* Now, the configuration should be set and the green ''Run'' button should be available below the IntelliJ IDEA menu bar.
 
-
[[File:Intellij-run-button.png]]
 
-
* If the configuration does not run as a standalone instance, make sure that BaseX is up and running.
 
-
* Click the ''Run'' button to execute your query.
 

Revision as of 10:33, 6 March 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 and both plugins:

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

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

Personal tools
Namespaces
Variants
Actions
Navigation
Print/export