The JetBrains IDE Plugin for Graph Database Developers
Introducing Neo4j 5: Unbounded Scale, Performance, and Agility | Learn More
Menu
Close
Search
ProductsPlatform OverviewGraph DatabaseNeo4j Graph DatabaseNeo4j AuraDBGraph Data ScienceNeo4j Graph Data ScienceNeo4j AuraDSUser ToolsNeo4j Developer ToolsNeo4j Ops ManagerCypher Query LanguageNeo4j GraphQL LibraryNeo4j Data ConnectorsNeo4j BloomDownload CenterPricingSolutionsUse CasesCase StudiesCustomersProfessional ServicesLearnResourcesWho Uses Neo4j?Executive InsightsGraphAcademyNeo4j BlogVideosBooksResource LibraryEventsGraphSummitConnectionsEvents CalendarLive DemosWebinarsDevelopersDeveloper HomeDocumentationDownload CenterDeveloper BlogCommunityOnline MeetupsData ScientistsGraph Data Science HomeData Science DocumentationGraphAcademy for Data ScienceData Science GuidesData Science CommunityGet Started with Graph Data SciencePricingSign InNeo4j AuraNeo4j SandboxGet StartedNeo4j AuraDBNeo4j SandboxNeo4j DesktopNeo4j AuraDS PartnersFind a PartnerBecome a PartnerSolution PartnersOEM PartnersTechnology PartnersPartner Portal LoginCompanyAbout UsNewsroomAwards and HonorsGraphs4GoodCareersCultureDiversityLeadershipContact UsSupport
Partners
Find a Partner
Become a Partner
Solution Partners
OEM Partners
Technology Partners
Partner Portal Login
Company
About Us
Newsroom
Awards and Honors
Graphs4Good
Careers
Culture
Diversity
Leadership
Contact Us Contact Us
Support
Contact Us
Thank you for your interest! We will get back to you soon!
Regional sales contact information.
×
Products
Platform Overview →
Neo4j graph technology products help the world make sense of
data.
Graph Database
Neo4j Graph Database
Self-managed, deploy anywhere
Neo4j AuraDB
Fully managed graph database as a service
Graph Data Science
Neo4j Graph Data Science
Graph analytics and modeling platform
Neo4j AuraDS
New!
Fully managed graph data science as a service
Download Center
Graph
Database • Graph
Data Science
Pricing
Graph Database • Graph Data
Science
User Tools
Neo4j Developer Tools
Desktop, Browser, and Data Importer
Neo4j Ops Manager
New!
Centrally manage Neo4j databases
Cypher Query Language
Powerful, intuitive, and graph-optimized
Neo4j GraphQL Library
Low-code, open source API library
Neo4j Data Connectors
Apache Kafka, Apache Spark, and BI tools
Neo4j Bloom
Easy graph visualization and exploration
Solutions
Use Cases
Fraud detection, knowledge graphs and more
Knowledge Graphs
Knowledge graphs are the force multiplier of smart data
management and analytics use cases.
Learn More
By Application
Analytics and Data Science
Fraud Detection
Knowledge Graphs
Real Time Recommendations
Supply Chain Management
Identity and Access Management
Master Data Management
Network and IT Operations
Data Privacy, Risk and Compliance
Social Networking
By Industry
Financial Services
Retail
Life Sciences
Telecommunications
Government
Case Studies
In-depth looks at customer success stories
Customers
Companies, governments and NGOs using Neo4j
Professional Services
The world’s best graph database consultants
Learn
Resources
Who Uses Neo4j?
75 percent of Fortune 100 companies
Executive Insights
Get to Know Graph Technology
GraphAcademy
Free online courses and certifications
Neo4j Blog
Daily reads on general Neo4j topics
Videos
Up-to-date, searchable archive
Books
Learn in depth with free books
Resource Library
White papers, data sheets and more
Events
GraphSummit
Live events around the world
Connections
Our ongoing digital event series
Events Calendar
Live online events, trainings and demos
Live Demos
Weekly demos with Neo4j experts
Webinars
Upcoming live and on-demand webinars
Developers
Developer Home
Best practices, how-to guides and tutorials
Documentation
Manuals for Neo4j products, Cypher and drivers
Download Center
Get Neo4j products, tools and integrations
Developer Blog
Deep dives into more technical Neo4j topics
Community
A global forum for online discussion
Online Meetups
Global developer conferences and workshops
Data Scientists
Graph Data Science Home
Learn what Neo4j offers for data science
Data Science Documentation
Manual for the Graph Data Science library
GraphAcademy for Data Science
Free online courses and certifications for data scientists
Data Science Guides
Deep dives & how-tos on more technical topics
Data Science Community
A global forum for online discussion
Get Started with Graph Data Science
Download our software or get started in Sandbox today!
PricingSign In
Neo4j Aura
Fully managed, cloud-native graph service
Neo4j Sandbox
Learn graph databases and graph data science
Get Started
Neo4j AuraDB
Start Free
Start your fully managed Neo4j cloud database
Neo4j Sandbox
Learn and use Neo4j for data science & more
Neo4j Desktop
Manage multiple local or remote Neo4j projects
Neo4j AuraDS
New!
Fully managed graph data science, starting at $1/hour
Warning: JavaScript is disabled on your browser. Parts of Neo4j.com will not work properly.
(Neo4j Blog)←[:BACK]
The JetBrains IDE Plugin for Graph Database Developers [Community Post]
Dmitry Vrublevsky, Lead Software Engineer, Neueda
Mar 16, 2017
8 mins read
[As community content, this post reflects the views and opinions of the particular author and does not necessarily reflect the official stance of Neo4j.]
Many developers mostly stay in their integrated development environments (IDEs) when working on software. That’s why it’s useful if the IDE has database tooling built in that allows you to query your database and validate and complete your statements.
When writing Neo4j-related code, that means extensively supporting Cypher as a first-class query language in your IDE. Today I would like to present to you the Graph Database Support plugin for all JetBrains IDEs. So if you write Ruby, Java, Python, C# or JavaScript code, we got you covered.
Out of the box you can find:
Full Cypher language support
Support for Neo4j 3.0 and higher (via the binary Bolt protocol)
Ability to not only write and validate, but also to execute queries
And a lot of other features that are meant to make you happy
So, if you are using any of the JetBrains IDEs, feel free to check the installation instructions on how to get the plugin to enhance your Neo4j developer experience!
Cypher
Support for the Cypher graph query language is, without any doubt, the most useful (and most used!) plugin feature. It saves quite a lot of effort every time I need to write a larger Cypher query.
Syntax Highlighting and Error Reporting
This is a simple one. As you might expect, Cypher syntax is properly highlighted. Labels, relationship types, properties, functions, procedures, parameters – all elements have their own coloring that you can also configure.
And error reporting is there as well, with helpful error messages that describe what’s wrong, not only when you execute the query but also while you’re typing.
If a Cypher query is written in the Data Source editor (we will take a look at them a bit later), then you also might notice various warnings that are coming directly from the database.
Autocompletion
Probably one of the most used features is autocompletion. Here is the list of what the plugin collects from existing queries and database metadata for autocompletion:
Labels
Relationship types
Property keys
Keywords
Identifiers
Built-in functions
User-defined procedures and functions
User-defined functions and procedures include not only their name, but also information about their signature and return type.
Refactoring
Tired of copy-pasting new identifier names all over the place, then running your query and realizing that there is still one place where the identifier has its old name?
This is exactly a situation where refactoring feature will be very handy.
One can easily rename:
Labels
Relationship types
Identifier names
Property keys
Reformatting
The plugin support for Cypher code reformatting is based on the official openCypher style guide, with some nice additions like aligning patterns or map keys and values to each other.
User-Defined Functions and Procedures
When it comes to working with user-defined functions and procedures, the plugin is able to offer a number of features:
Show parameter information
Validate that the number of passed arguments is correct (with respect to default values)
Type checks
Let’s explore each of the above features in detail.
Parameter Information
You can see parameter information without switching to a browser window with docs to verify what arguments a function expects. Note how the current argument under the cursor is highlighted; that’s also quite useful!
Parameter Count Validation
Another simple but useful feature is parameter count validation. If there are not enough arguments, or too many of them, then an error will be shown in the editor.
Type Checks
Here comes a more advanced feature. The JetBrains IDE plugin is smart enough to detect expression types and – based on those – verify that the arguments passed to a function have valid types.
Types that can be inferred include:
Node
Relationship
Path
Map
List
String
Number (both Float and Integer)
Boolean
Null
Note: There are situations when it is not possible to detect the type (yet). In such cases, the type validation is not performed.
Documentation
The JetBrains IDE plugin provides the ability to view documentation for functions and procedures inline.
The documentation for built-in functions is the same that you can find in Neo4j’s own documentation. This means that it has everything you are looking for, including proper description and example query.
Documentation for user-defined functions and stored procedures is auto-generated. So, there will be information about signature and return type. The description is also included if there is one present.
Language Injection
JetBrains IDEs have a feature called language injections. Simply speaking, it allows you to “inject” support for languages like HTML, SQL or CSS (and others) into a string literal in any other programming language. And Cypher is not an exception here!
On top of that, the graph database support plugin is smart enough to automatically inject Cypher for all official Neo4j API and language drivers and for some of the most widely used and popular community drivers:
Neo4j Embedded API
Neo4j Test Harness API
Neo4j OGM
Spring Data Neo4j
py2neo
Data Sources
If the great Cypher support is the face of the plugin, then data sources are the body. They allow you to:
Manage connection to a database
Use data source specific editor
Explore all database metadata
Perform several useful interactions
Currently only Neo4j 3.0 and higher is supported (via Bolt protocol) but that’s what you should be using anyway. If you’re interested in support for previous versions, please let us know.
Query Editor
One nice feature that the data sources aspect provides is the query editor. It can be accessed by double-clicking on a data source (or via its context menu).
While it’s quite simple, it allows you to:
Write queries without creating extra files in a project
Note: The editor content is persisted across IDE restarts
Benefit from the fact that the plugin knows that this editor is bound to a specific data source and enables several useful features (like EXPLAIN-based inspections)
Run queries directly against desired data source
Enriched Cypher Experience
When a data source for a Neo4j graph database is created, the plugin automatically retrieves the metadata of the database to make Cypher editing even more powerful than before. It extracts information like:
Node labels
Relationship types
Property keys
User-defined procedures
User-defined functions
All this information becomes available for autocompletion while writing Cypher queries.
User-defined procedures and functions also will have information about parameters and return values that will be visible in autocompletion (and documentation!).
Console
Whenever a query is executed, all information about the execution process and results can be found in the console at the bottom of your IDE.
Log
Anything that happens in the plugin will have information in a log, including:
Query execution
Data source metadata refresh
Parameter parsing errors
Graph and Table Result Views
When a query is executed it returns results. Results, however, need to be viewed somehow. This plugin offers two ways of working with query results:
Graph
Table
Graph
The graph view is what graph databases are all about: viewing your data as connected entities.
Available interactions in the graph view include:
Click on a node or relationship to view entity information
Zoom in and out using the mouse wheel
Double left click on the mouse to center the graph
Drag nodes to place them better than our layout algorithm
Click and drag the canvas to change the view position
Table
If graph view is not working for you for any reason, table view is right there. Nothing much to say here. Tables are tables, and they’re everywhere.
Analyze Cypher Queries
Whenever a Cypher query is executed with an EXPLAIN or PROFILE keyword, a new tab is added to the console with a query execution plan.
In that extra tab, you’ll find:
A query plan in a tree format
Execution details for each plan node
Information about the Cypher version, planner and execution runtime
Parameters
Using parameters in your queries? Now there is no need to replace parameters with desired values, just to test out how a query works.
You can specify parameters in the corresponding tab in a JSON format. When a query will be executed, the plugin will automatically pick up the parameters that are needed.
Numbers!
15 – months that the JetBrains IDE plugin has been in the wild.
16000+ – total lifetime plugin downloads
400+ – graphistas are using it every (working) day
Conclusion
If you like what we are doing, then feel free to star us on GitHub and spread the word. In case of any bug, issue, question or feature request – please raise an issue on GitHub.
Want to learn more about graph databases and Neo4j? Click below to register for our online training class, Introduction to Graph Databases and master the world of graph technology in no time.
Sign Me Up
Email me blog updates!
The information you provide will be used in accordance with the terms of
our privacy policy.
cyphergraph databaseIDE pluginJetBrains IDEneo4j ogmopencypherspring data neo4jstored proceduresuser-defined functionsuser-defined procedures
Neo4j Community
Disclaimer
Author
Dmitry Vrublevsky, Lead Software Engineer, Neueda
Dmitry Vrublevsky is the Lead Software Engineer at Neueda. He has some interest in IT automation and orchestration. He is Neo4j Certified and a Neo4j Ambassador.
Related ArticlesThis Week in Neo4j: Typescript Course, Better Graph Displays, Using Apache Hop, and MoreDec 17 4 mins readHow Banks in ANZ Use Data-Driven Insights to Optimize DevOp and Cloud MigrationDec 16 7 mins readThis Week in Neo4j: Visualization, Akamai, House of the Dragon, Geospatial Data, Clustering, Cypher in Neo4j 5, Testcontainers, and MoreDec 10 4 mins read
Products
Platform Overview
Neo4j Graph Database
Neo4j AuraDB
Neo4j Graph Data Science
Neo4j AuraDS
Download Center
Pricing
Learn
Resources
Events
Solutions
Use Cases
Case Studies
Customers
Partners
Professional
Services
About
Company
Newsroom
Awards and Honors
Careers
Leadership
Support
Contact Us →
US: 1-855-636-4532
Sweden: +46 171 480 113
UK: +44 20 3868 3223
France: +33 (0) 1 88 46 13 20
2022 Neo4j, Inc.
Terms | Privacy | Sitemap
Anti-Corruption Policy
Neo4j®, Neo Technology®, Cypher®, Neo4j® Bloom™, Neo4j® AuraDS™ and Neo4j® AuraDB™ are registered trademarks
of Neo4j, Inc. All other marks are owned by their respective companies.
Contact Us