/nebula-console-intellij-plugin

Nebula Graph Databases support for JetBrains family IDEs.一款针对Jetbrains开发工具的console工具,支持语法高亮、函数字段自动补全、数据表格分页显示、关系图展示

Primary LanguageJavaApache License 2.0Apache-2.0

Build Status

#English | #中文

Plugin for IntelliJ IDEA to support Nebula-Console.


  • Provides support for console to manage nebula data with IntelliJ IDEA.

Plugin is developed and supported by awang12345.

plugin screenshot

This plugin is based on the Graph Database Support plugin, originally developed by Neueda Technologies. The original plugin has not been updated for a long time and does not work with Nebula.

Features


  • Works in any Jetbrains IDE
  • Manage data sources
  • Write and execute queries
  • Explore query results in table view
  • Explore query results in graph view
  • Supported databases:
    • Neo4j 3.4+ (Bolt)
    • Nebula 3.0+ (Thrift)
  • nGQL query language:
    • Understands queries in .ngql files
    • Syntax highlight
    • Autocompletion support for identifiers, keywords, functions, space, tag, edge, etc. nebula-graph, nebula-client
  • Cypher query language:
    • Understands queries in .cyp, .cypher or .cql files
    • Syntax highlight and error reporting
    • Refactoring support for identifiers, labels, relationship types and properties
    • Autocompletion support for identifiers, labels, relationship types, properties, functions and stored procedures. Information gathered from existing queries and configured data sources
    • Code reformatting
    • Provide documentation for functions and stored procedures
    • Inspections: database warnings, function checks, type system.

How To Use


  1. Install the plugin
  2. In the sidebar toolwindow of idea IDE find "database_setting.svg" menu
  3. Click "+" button to add a graph database config and verify that the connection is valid.
  4. Click "refresh.svg" button to refresh the database metadata.
  5. Double-click the root node (datasource name) to open the graph sql editor panel.
  6. Write your sql on editor panel and right click and choose Run.Or click "run_sql.svg" button to run your sql.
  7. The sql result show in the console panel below the editor panel.The "log" table show the execute log information.The "table" table show the result information.

Supported Jetbrains Products


  • IntelliJ Idea 2019.1+
  • RubyMine
  • WebStorm
  • PhpStorm
  • PyCharm
  • AppCode
  • Android Studio
  • Datagrip
  • CLion

Development


Warning: Required to switch local environment to JDK 11.

Gradle is used as build system.

# Build plugin distribution
./gradlew buildPlugin

# Run idea in development mode
./gradlew :graph-database-support-plugin:runIde