Skip to content

mdelambilly/graphdb-intellij-plugin

Repository files navigation

Graph Database plugin for IntelliJ Platform

Build and test

This plugin adds support for graph databases to the IntelliJ IDEA platform. At the moment, the only supported database is Neo4j.

The plugin provides useful developer features for working with graph databases, such as:

  • syntax highlighting and autocompletion for the Cypher query language
  • connecting to and querying local and remote graph databases.

Screenshot 2022-11-21 at 09 08 11

This plugin is maintained and developed in my free time as a personal project, for no commercial reasons. Contributions and sponsorships are welcome! Please see the Getting involved section for more information on how to contribute to this project.

GitHub Sponsors

This plugin is based on the Graph Database Support plugin, originally developed by Neueda Technologies. It was then forked and maintained by Alberto Venturini, whose repository is now archived. This fork continues the work with support for IntelliJ 2025.3 and the following databases:

  • Neo4j 5.x LTS, including AuraDB and Neo4j Sandbox
  • Neo4j 2026.x, including AuraDB and Neo4j Sandbox
  • DozerDB

Installation

The plugin can be installed directly within an IntelliJ IDEA-based IDE.

  1. Go to Preferences -> Plugins -> Marketplace
  2. Search for Graph Database.
  3. Install plugin and restart the IDE.

Alternatively, you can navigate to the plugin homepage on the JetBrains marketplace and click on the 'Install' button.

Usage

Data Sources

After the plugin is installed, you should configure a data source. In order to do that, expand the "Graph Database" tab on the right-hand side of the IDE, then click on the "+" symbol. Fill in the fields, and test that the connection works.

Cypher syntax highlighting

The plugin activates syntax highlighting for Cypher for files with extensions .cyp, .cypher, or .cql.

It is also possible to add syntax highlighting to Java Strings containing Cypher queries via language injection. Simply add the following comment right before a Cypher String:

// language=Cypher

Building the plugin

Prerequisites

If you plan on making changes to grammar or lexer files, you may find it useful to install the Grammar-Kit IntelliJ plugin. This is not required but nice to have.

Build instructions

On Linux/macOS:

./gradlew :graph-database-plugin:buildPlugin

On Windows (PowerShell):

.\gradlew.bat :graph-database-plugin:buildPlugin

Before a release, the plugin should also be tested and verified:

./gradlew test
./gradlew :graph-database-plugin:verifyPlugin

The plugin can also be manually tested in a sandboxed instance of IntelliJ:

./gradlew :graph-database-plugin:runIde

Getting help

Supporting the project

If this plugin is useful to you, consider sponsoring its development:

Getting involved

Contributions are welcome — feel free to open a pull request!

Contacts

For any questions or feedback, please use GitHub Discussions.

About

Graph database plugin for the IntelliJ Platform

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors