2020-10-09に更新

無心でDgraph入門

Dgraph

Dgraphの起動とスキーマ定義

Dgraphクラスタの構造

ノード名	説明
Zero	Dgraph Zero controls the Dgraph cluster, assigns servers to a group, and re-balances data between server groups.
Alpha	Dgraph Alpha hosts predicates and indexes.
Ratel	Ratel serves the UI to run queries, mutations & altering schema.

ついでにpredicateとindexの説明.

用語	説明
Predicate	Predicates are either the properties associated with a node or the relationship between two nodes.
Index	Indexes are the tokenizers that can be associated with the predicates to enable filtering using appropriate functions.

Get Started - Quickstart Guideから引用

少し補足するとPredicateとはノードのプロパティやノードを繋ぐエッジのことです. Indexは他のデータベースと大体同じ意味で索引付けのことで検索するときに指定します.

Dgraphコンテナ

とりあえずお試しで動かすならdgraph/standaloneというイメージを使います.

docker pull dgraph/standalone:v20.03.0

起動は以下のようにします.

docker run --name first-dgraph --rm -it -p 8080:8080 -p 9080:9080 -p 8000:8000 -v my-vol:/dgraph dgraph/standalone:v20.03.0

とりあえ

オプション	説明
name	実行されるコンテナのインスタンスに付けられる名前です
rm	停止するときにコンテナが削除されます
it	interactive ttyでttyを通じてコンテナとやり取りできます. 今回はひたすらログが流れてきます.
0	ポート・フォーワーディングといってホストとクライアントの間でポートの対応を付けを行います
v	ボリュームをマウントします. my-volはdockerが管理するボリュームで/dgraphがコンテナ側のマウントポイントです

注意点はボリュームのマウント・ポイントは/dgraphに指定する必要があります. しないとrmオプションの効果でコンテナを停止するとデータごと消えてしまいます(お試しだから良いのかもしれませんが).

実行後以下のコマンドでmy-volボリュームが作られていることを確認しましょう.

docker volume ls

Ratel UIを使ったSchema編集

Ratel UIへのアクセス

http://localhost:8000/にアクセスします.

真ん中のLatestを選びます.

スキーマの設定やデータの投入, クエリなどを実行できます.

スキーマを設定する

スキーマの設定方法は２つあります.

データを投入する
手動でスキーマを定義する

基本的にノードを投入すると自動的にスキーマが定義されます. そのため一度スキーマを定義しても新しいプレディケートがあると勝手にスキーマが更新されます.

例えばConsoleのMutationタブに以下をコピペします.

{
  "set":[
    {
      "name": "Michael",
      "age": 40
    }
  ]
}

Runをクリックするとスキーマが生成されます. 左のSchemaタブを選ぶとプレディケートとタイプが表示されます.

次にアドレスというプレディケートを加えて新しいデータを投入します.

{
  "set":[
    {
      "name": "Michael",
      "age": 40,
      "e-mail" : "example.com"
    }
  ]
}

するとe-mailというプレディケートが追加されました.

このため導入するデータのバリデーションはアプリケーション側で行うのが良さそうです.

スキーマを設定する利点

ではスキーマが無駄なのかというと, そうでもないようです. Ratel UIでQueryを入力する際に補完されるようになるようです. ただ階層とかは考慮してくれないようです.

ボリュームにはもう一つマウント・ボリュームというのがあります. こちらもホスト側のフォルダをコンテナ側にマウントする点は同じですが, フォルダを自分で指定する必要があります. DockerはWindows, macOS, そして各Linuxディストリビューションで提供されマルティ・プラットフォームでコンテナを動かすことができます. しかしこのマウント・ポイントを指定してしまうと互換性がなくなってしまう可能性があります. そこで後からDocker側がボリュームを管理するような仕組みが導入されたようです. 領域はDockerの管理下にあるので, プラットフォームごとの際はDockerが吸収してくれます.