|
| 1 | +# JetBrains IDE plugin - Graph Database support |
| 2 | + |
| 3 | +## About the author |
| 4 | + |
| 5 | +* Name: Dmitry Vrublevsky |
| 6 | +* Title: Lead Software Engineer |
| 7 | +* Company: Neueda |
| 8 | + |
| 9 | +> TODO: What Information I need here? |
| 10 | +
|
| 11 | +## Introduction |
| 12 | + |
| 13 | +The story of a plugin starts a bit more than a year ago. |
| 14 | + |
| 15 | +I have started to work with Neo4j daily and writing Cypher queries started to become a routine. |
| 16 | + |
| 17 | +What tools I had to help myself? Not much: |
| 18 | +* Neo4j Browser |
| 19 | +* [Cypher for VIM](https://github.com/neo4j-contrib/cypher-vim-syntax) |
| 20 | +* [Cypher for Sublime](https://github.com/kollhof/sublime-cypher) |
| 21 | + |
| 22 | +While Neo4j Browser is quite awesome and helps a *lot* I found myself struggling with it. |
| 23 | + |
| 24 | +Being Java developer for quite some time, I started to become lazy. |
| 25 | +By being "lazy" I mean that I want my tools to help me write code. |
| 26 | + |
| 27 | +As someone might guess, I am fan of IntelliJ IDEA. |
| 28 | +It help write Java code effectively by being smart ... blah blah ... |
| 29 | + |
| 30 | +## Overview |
| 31 | + |
| 32 | +First of all, plugin works in **any** IDE by JetBrains. |
| 33 | +It doesn't matter are you Java, PHP, Ruby, Golang or <language of your choice> developer - |
| 34 | +Neo4j can be home for everyone (TODO: Joke is somewhere there). |
| 35 | + |
| 36 | +In the box can be found: |
| 37 | +* Cypher support |
| 38 | + * Autocompletion |
| 39 | + * Refactoring |
| 40 | + * Quick documentation |
| 41 | + * Auto-injection for popular libraries |
| 42 | + * Inspections |
| 43 | +* Ability to manage data sources |
| 44 | + * Neo4j 3.0 and higher is supported |
| 45 | +* Execute queries |
| 46 | + * View results as a graph, or table |
| 47 | + * Query parameters are supported too |
| 48 | + * `EXPLAIN` and `PROFILE` are supported as well |
| 49 | + |
| 50 | +## Features |
| 51 | + |
| 52 | +Let's explore some of the most important features in detail. |
| 53 | + |
| 54 | +### Data sources |
| 55 | + |
| 56 | +Data sources is a heart of a plugin. |
| 57 | + |
| 58 | +Create data source that connects to running Neo4j instance. |
| 59 | +After doing that you will see metadata that is pulled out from a database. |
| 60 | + |
| 61 | +Now you can double-click on data source (or right-click and select appropriate menu option). |
| 62 | +Now you can write queries with all the features that plugin offers: |
| 63 | +* Metadata autocompletion |
| 64 | +* Database-based inspections (warning) |
| 65 | + |
| 66 | +### Query editor |
| 67 | + |
| 68 | +> What I am going to talk about there? |
| 69 | +
|
| 70 | +* Green border |
| 71 | +* <ctrl>-<enter> to run query |
| 72 | + |
| 73 | +### Cypher |
| 74 | + |
| 75 | +* Autocompletion |
| 76 | +* Refactoring |
| 77 | +* Documentation |
| 78 | +* Parameters |
| 79 | +* Inspection - warning |
| 80 | + |
| 81 | +### Console |
| 82 | + |
| 83 | +#### Log |
| 84 | + |
| 85 | +> Maybe I don't need to talk about Log at all? |
| 86 | +
|
| 87 | +Log contains information about all executed queries and their stats (time, counters). |
| 88 | +Also all errors can be found there |
| 89 | + |
| 90 | +#### Graph |
| 91 | + |
| 92 | +While not best graph visualisation in the world, it still works and delivers. |
| 93 | + |
| 94 | +Features: |
| 95 | +* Click on node |
| 96 | + |
| 97 | +#### Table |
| 98 | + |
| 99 | +Table is quite simple and boring. |
| 100 | +Nothing much to say. |
| 101 | + |
| 102 | +## Stats |
| 103 | + |
| 104 | +> Do I need this? |
| 105 | +> It shows that we are spying :( |
| 106 | +
|
| 107 | +Total downloads: ~14.000 |
| 108 | +Active daily users: 400 |
| 109 | + |
| 110 | +## In the end |
| 111 | + |
| 112 | +Any feedback is appreciated |
0 commit comments