Neo4j Webインターフェースは、HTTP/HTTPSでNeo4jサーバーに接続し、Cypherクエリ言語を使い対話式でグラフデータベースを操作できるGUIです。Neo4j Webインターフェースには、Cyhperクエリ言語の実行フレームの他にも、多様な機能が実装されており、ここでは、すべての機能を網羅的に紹介していきます。
この記事は、Neo4j 3.0.6(2016-09-16)に合わせて更新しています。
[関連記事]
CL-Lab
Neo4j Webインターフェース
メイン画面
Neo4jにログインした直後に表示される画面です。
- コマンドライン：Cypherクエリ、ストアドプロシージャ、 REST APIなどを実行
- お気に入り登録：Cypherクエリ文などをお気に入り登録
- チュートリアル：初学者向けのチュートリアルやサンプルデータベース、システムのステータス表示など
- メニューバー：アイコンをクリックするとメインメニューを表示
- 出力フレーム：Cypherクエリなどの実行結果を表示
チュートリアル
＠Start Learning
グラフデータベースの基礎を説明しています。
- ピン止め：出力フレームを常にトップに表示します。
＠Write Code
2つのサンプルデータベース、GUTでCypherクエリ作成のテンプレートが体験できます。
＠Monitor
Neo4jサーバーのステータスが表示されます。
メニューバー
事前準備
ここからの説明は、Neo4jのサンプルデータベース(映画データベース)が存在するという前提で進めています。データベースが必要であれば、こちらの記事の「演習用の映画データベース作成」を参考に作成してしてください。
データベース
「データベースアイコン」をクリックすると、現在のデータベース構成が見られます。
ノードラベル(Node labels)
ラベル(Movieなど)をクリックしてみてください。映画ノードが表示されます。
リレーションシップ(Relationship types)
リレーションシップ(ACTED_INなど)をクリックしてみてください。関連するサブグラフが表示されます。
Cypherクエリ文の実効履歴表示
Cypherクエリ文の実行履歴は、直前に実行したCypherクエリ文(赤枠)のクリック、又はコマンドラインの入力プロンプト上で、「ページアップ&ダウン」操作をすることで表示することができます。
出力結果のエクスポート
出力結果は、多様なフォーマットでエキスポートできます。
なお、出力結果は多様なタイプに変換して表示できます。
次は、ローデータとして表示（赤枠のアイコンクリック）。
次は、JSONで表示（赤枠のアイコンクリック）。
次は、RESTful APIで表示（赤枠のアイコンクリック）。
グラフのサイズや色、線の太さなどのカスタマイズ
グラフの表示は、Neo4jがサイズや色などをある程度までに最適化してくれますか、カスタマイズもできます。出力フレームでラベル又はリレーションシップをクリックしてみてください。下に色やサイズを調整するキャンバスが表示されます。
グラフの拡大や縮小
出力フレームに表示されているグラフに対して拡大や縮小ができます。データベースのリレーションシップでFOLLOWSを表示してから、Jessica Thompsonをワンクリックしてロックしてみてください。
それから、拡大をクリックしてみてください。次のようにチャイルドノードが表示されます。これは、ノードをダブルクリックしても同じ結果が得られます。
チャイルドノードの削除
拡大されたグラフのチャイルドノードを削除したい場合は、同じ要領でノードをロックしてからリムーブ（×）をクリックします。
アンロック
ノードのロックを解除するためには、アンロック(開いている鍵)をクリックするか、出力フレームの空白をクリックします。
AUTO-COMPLATE
出力フレームの右端には、AUTO-COMPLATE(ON/OFF)という表示があります。これは何でしょう。次は、AUTO-COMPLATE(OFF)の状態で表示したグラフです。
次は、AUTO-COMPLATE(ON)の状態で表示したグラフです。このようにAUTO-COMPLATE(ON)の状態では、グラフ表示の数の制限に関わらず、表示されているグラフのなかのすべてのリレーションシップを自動的に完成して表示します。
出力フレーム内のグラフ全体の移動
グラフが常に出力フレームの枠内に綺麗に収まるか、中央に表示されるとは限りません。そのときは、出力フレーム内で空白をワンクリックした状態（グラフロック）でマウスを動かしてみてください。
グラフが左右上下に移動します。
もちろん、フルスクリーン機能で簡単に解決できる場合もあります。あるいは、両方を併用する必要がある場合もあります。
出力フレーム内の個別ノードの移動
一部のサブグラフが一塊になっていて見づらい場合は、個別のノードをワンクリックした状態で移動させることができます。それで見やすい形に再配置します。
属性キーの表示（Property keys)
特定の属性キーをクリックすると、値が表示されます。
ここまでのデータ表示は、デフォルトで表示する数が制限されています。データベース全体のデータをもってくるようなことはありません。
お気に入り機能
お気に入り機能は、ユーザーがお気に入り登録したスクリプトの他にも多様が機能が実装されています。
Save Scripts
ユーザーがコマンドラインから登録したスクリプトが表示されます。
この「お気に入り登録」は、マイフォルダーを作成してグループ化することもできます。スクリプトは「ドラック&ドロップ」で移動できます。
それから、スクリプトの実行方法は2つです(以下、同様）。
- メニュー名を選択すると、スクリプトがコマンドラインラインに表示されるので、コマンドラインかあ実行ボターン(▶)をクリックする。
- メニュー名のラジオボターンを選択すると、実行モード変更するので、メニューから実行ボターンをクリックする。
Sample Scripts
こちらは、Neo4jが提供しているスクリプトです。チュートリアル的なものから、データベースの運用管理に必要な情報を出力するスクリプトまで多様です。これから、代表的なものを1個ずつ見ていきます。
Basic Queries
チュートリアル的なCypherクエリ文を紹介しています。次は、GUIでCypherクエリを作成するクエリテンプレートです。
Example Graph
演習用データベースが2つありますが、次の画面は「映画データベース」です。
Data Profiling
データベースの概要をみることができます。次は、すべてのノード数をカウントしています(Count all nodes)。
System
Neo4jサーバーのシステム情報をみることができます。次は、Neo4jのデータストアファイルの構成とファイルサイズを表示しています(Store file sizes)。
Styling/Graph Style Sheet
Neo4j Webインターフェースは、スタイルシートを編集してカスタマイズすることができます。
Import
Cypherクエリ文が書かれている外部のファイルをインポートのドロップボックスにドラック&ドロップすると、Cypherクエリ文は、お気に入り(Saved Scripts)に登録されます。
Cypherクエリ文の他に、GRASS(graph-style-sheet)のインポートもここで可能です。
ドキュメンテーション（Documentation)
Neo4jの各種ドキュメントのリンクが紹介されています。
Neo4jブラウザーシンク(Browser Sync)
認証にオープンIDを登録することで、Neo4jサーバーを複数のユーザー間で共有できます。各種設定なども共有できるメリットがあります。
ブラウザーセッティング
ブラウザーのビジュアライゼーションをカスタマイズできます。
Neo4jについて
Neo4jの開発元やコミュニティー、ソースコードなどに関する情報のリンクが載っています。
まとめ
以上、駆け足でNeo4j Webインターフェースの機能を一通り紹介しました。Neo4j 2.x系に比べ、3.xになってから、かなりパワーアップされていることが分かります。