Changes

This article is part of the [[Getting Started]] Section. It describes how to run XpathXPath/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:

=Preparations= The following steps apply to all operating systemsand both plugins:

* Download your favorite [http://basex.org/download BaseX distribution ] (JAR, ZIP, EXE): .* Start BaseX (see [[http://basexStartup]]).org/download/* Create a BaseX database (see [[Databases]]).

This article focuses on Grzegorz Ligas' [https://plugins.jetbrains.com/idea/plugin/7262=xquery-xqueryintellij-support XQuery Support plugin]. =

After installing IDEA and BaseX, install the XQuery Support plugin by one of the following methods:===From the Start Screen===# Start IDEA and select ''Configure''→''Plugins''This section focuses on Reece H.# In the Plugins window select ''Browse Repositories'Dunn's [https://plugins.# In the Browse Repositories window, search for (or scroll to) ''XQuery Support''jetbrains.# You will be prompted to restart IDEA to load the new com/plugin/8612-xquery-intellij-plugin xquery-intellij-plugin].

==Installation=From the File Menu===# Select ''Settings''.# In the Settings window select ''Plugins''.# In the Plugins window select ''Browse Repositories''.# In the Browse Repositories window, search for (or scroll to) ''XQuery Support''.# You will be prompted to restart IDEA to load the new plugin.

=='''From the Start Screen''' [[File Extensions :intellij-startbildschirm.png]] * Start IntelliJ IDEA and select ''Configure''→''Plugins''.* In the Plugins window, select the tab ''Marketplace''.* Type "XQuery Flavor" 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'' (OS dependentWindows)/''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== '''Create a New Project'''* To create a new project choose the ''Create new project'' option from the start screen or select ''Other SettingsNew''→''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 and click on the ''Finish'' button. '''Customize the XQueryModule'''* 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 which 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> (optional; if you leave this field blank, <code>[Implementation] [Version]</code> will be used as name)** <code>Implementation = BaseX</code> (should be preset!)** <code>JAR File = BaseX.jar</code> (name and location of the JAR file may differ depending on your BaseX distribution and version)** <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 [''Version''] (BaseX)" entry and click ''OK''.* The ''Query Processor'' dropdown box in the ''Run/Debug Configurations'' dialog should now also display "BaseX [''Version''] (BaseX)". If not, select it from the dropdown box.* Click ''Apply'' and then ''OK'' to close the ''Run/Debug Configurations'' dialog. '''Create a Query File'''* 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, e.g. <code>db:open("factbook")</code>, and save your file. '''Create a New Configuration'''* 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 flavor " template you would like configured earlier.* Enter a name, e.g. "BaseX", into the ''Name'' field.* The query processor should be preset to "BaseX [''Version''] (BaseX)".* In the ''Run the query from'' area, either enter the path to your query file into the ''Local file'' field to limit the run configuration to that query or choose the ''Active editor file'' option to make the configuration run the script that is currently opened in the IntelliJ editor panel.[[File:Intellij-xquery-configuration.png]]* Click ''Apply'' and then ''OK'' to useclose 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]] '''Execute Your Query'''* 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. ==Conclusion== The plugin is very well maintained! It adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX. The plugin contains some minor flaws regarding the static binding of BaseX namespaces. A few namespaces are marked as unknown in the code, however, query execution in the BaseX backend works fine in spite of them. Also, the IntelliJ ''Find Usages'' and ''Go To'' options did not work as expected in some cases, especially with regard to functions and across modules. The plugin does not yet include a code completion feature. Note that the usage of functions from imported or declared namespaces that do not exist in the namespace might not be marked as unknown. To highlight invalid functions, you may enable the ''XPath and XQuery > XPST: XPath static errors > XPST0017: Undefined function'' inspection in the ''Editor > Inspections'' section. =XQuery Support Plugin= This section focuses on Grzegorz Ligas' [https://plugins.jetbrains.com/plugin/7262-xquery-support 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''' * Start IntelliJ IDEA and select ''Configure''→''Plugins''.* In the ''Plugins'' window, select the tab ''Marketplace''.* Type "XQuery" into the ''Search plugins in marketplace'' field and press Enter.* Click the ''Install'' button below the ''XQuery Support'' plugin or click on the ''XQuery Support'' link to get more information on the plugin before installing it.* You will be prompted to restart IDEA to load the new plugin. '''From the IntelliJ IDEA Menu'''* Select ''Settings'' (Windows)/''Preferences'' (macOS) from the ''IntelliJ IDEA'' menu.* In the Settings/Preferences window, select ''Plugins''.* In the ''Plugins'' panel, select the tab ''Marketplace''.* Type "XQuery" into the ''Search plugins in marketplace'' field and press Enter.* Click the ''Install'' button below the ''XQuery Support'' plugin or click on the ''XQuery Support'' link to get more information on the plugin before installing it.* You will be prompted to restart IDEA to load the new plugin. ==Setting Up== '''File Extensions and XQuery Flavor'''* Start IntelliJ IDEA and navigate to ''Settings'' (Windows)/''Preferences'' (macOS) either using the ''Configure'' button on the start screen or the ''IntelliJ IDEA'' menu.* In the Settings/Preferences window, expand the ''Languages & Frameworks'' item, select ''XQuery'' and choose which default file extensionsand which XQuery flavor you would like to use. (see attached screenshot)* Click ''Apply'' to store your XQuery settings. [[File:intellij-xquery-settings.png]]

# Start IDEA and navigate to * In the ''Settings'' (OS dependentWindows)/''Preferences'' (macOS).# In window, expand the settings window select ''Other SettingsLanguages & Frameworks''→item and select ''XQuery Data Sources''.# * Click on the {{Code|+}} button in the middle column to add a new data source.* Select ''BaseX (native embedded)''from the dropdown box.# Check * In the right-hand column, check the ''User defined XQJ Driver'' radio check box.# Using * Use the ''' {{Code|+''', }} button below the check box to add the following {{code|jars}}from your BaseX distribution: ** {{Code|basex/BaseX.jar, }}** {{Code|basex/lib/basex-apiapj-89.61.12.jar, }}** {{Code|basex/lib/basex-xqj-89.60.jar, and }}** {{Code|basex/lib/xqj2-0.2.0.jar from }}* Click ''Apply'' to store your BaseX distributionsettings.

This assumes that you already have a BaseX database named {{code|factbook}}.# Start IDEA and navigate to * In the ''Settings'' (OS dependentWindows).# In /''Preferences'' (macOS) window, expand the settings window select ''Other SettingsLanguages & Frameworks''→item and select ''XQuery Data Sources''.# Using * Click on the '''{{Code|+''', select }} button in the middle column to add a new data source.* Select ''BaseX'' as your data sourcefrom the dropdown box.# Fill * In the right-hand column, fill in the appropriate connection details; , e.g. default values:#** <code>Host = localhost</code>#** <code>Port = 1984</code>#** <code>Database name = factbook</code>#** <code>Username = admin</code>#** <code>Password = admin</code># * Select ''Apply'', then ''OK'' and your BaseX {{code|factbook}} database is ready to query. [[File:Intellij-basex-data-source.png]] ==Querying Your Data== '''Create a New Project'''* 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 and click on the ''Finish'' button. '''Customize the XQuery Module'''* 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 Main Module'' entry.* Click on the ''Configure'' button next to the ''Data Source'' field and either choose the previously configured standalone version (''BaseX (native embedded)'' item) or the client version (''BaseX'' item) from the list.* Click ''Apply'' and then ''OK'' to close the ''Run/Debug Configurations'' dialog. '''Create a Query File'''* In the project view, create a new XQuery file by right-clicking on the project name and choosing New→XQuery File. Enter a file name, select ''Main Module'' from the ''Kind'' dropdown and click OK.* Type in your query and save your file.[[File:Intellij-query.png]] '''Create a New Configuration'''* 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 Main Module" template you configured earlier.* Enter a name, e.g. "BaseX", into the ''Name'' field.* The data source should be preset either to "BaseX (native embedded)" or ''BaseX'' depending on your processor configuration.* In the ''Main file'' field, enter the path to your query file.[[File:Intellij-xquery-configuration2.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]] '''Execute Your Query'''* 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. ==Conclusion==The plugin adds support for various XQuery Implementations to the IntelliJ IDEA (among them BaseX). It provides syntax highlighting for XQuery and XML and detects syntactical errors while you type offering a description for each error. Queries are executed using Run Configurations for which you can configure various query processors, e.g. BaseX. The plugin offers code completion for XQuery functions, integrated library modules, such as FunctX or the BaseX Module Library, and user-defined modules. IntelliJ’s Find Usages and Go To options seem to work fine for variables and functions, even across modules. Users can set XQuery-specific code style preferences. This plugin also has a few minor drawbacks. If no path is specified, syntax highlighting marks user-defined modules as unknown, even if they reside in the designated BaseX module repository. However, the BaseX query processor, resolves them correctly during query execution. Error messages in the editor seem to be kept rather general and should me more specific.Parameter lists of code completion may be quite extensive and clog the screen.Leading tab space can be increased in user-defined steps, but neither decreased in single, nor user-defined steps.