Amazon DynamoDB のGUIツール「NoSQL Workbench」を調べる機会があり、せっかくなので構築手順書をブログにしてみました。
※(敢えて書きますが)本情報は2020年12月のものです。
NoSQL Workbench
GUIツールと言っても、「AWSコンソールで十分じゃないか?」と言う意見もあるかもしれませんが、NoSQL Workbenchには各種RDBのGUIツール同様(それ以上に)さまざまな機能が備わっているようです。
公式情報
2019年9月16日時点
Amazon DynamoDB 用 NoSQL Workbench のプレビュー版の発表
2020年5月7日時点
Amazon DynamoDB 向け NoSQL Workbench を使用したデータモデリング
後者によると、
- 1つ以上のテーブルを使用してデータモデルを定義します。
- データモデルを視覚化して、さまざまなシナリオでどのように機能するかを理解します。
- 複数のプログラミング言語用のデータプレーン操作を構築します。
といったことが可能とのこと(しかし今回はあまり触れない!!)
前提
こちらの構築手順はmacOS
のものです。
インストーラーのダウンロード
以下の公式サイトから各OSに対応したインストーラーをダウンロードします。
今回はmacOs
なので赤枠の「Download for macOS」のリンクをクリックします。
インストーラーを起動していつものようにApplicatioonsフォルダにアプリを移動。
アプリの起動→接続設定画面
アプリを開く前にセキュリティの確認が出るので「開く」をクリック。
ホーム(?)画面で、Amazon DynamoDBの「Launch」を選択。
左のメニューの「Operation builder」を選択。
接続設定(AWS CLIの設定が済んでいる場合)
AWS CLIで既にAWSと接続設定は済んでいるので、「open」を選択したらDynamoDBと接続されます。
設定しているAccess KeyとSecret KeyはDynamoDBアクセス権限を持っているユーザのものでないといけないはず。
open後はregionがDynamoDBを作成した場所と違ければ変更。
(ほぼほぼ「ap-northeast-1」でしょうか)
Nameもdefaultから変更する場合は変更。
ap-northeast-1に変更すると作成しているテーブル名が出てきます。
接続設定(AWS CLIの設定が済んでいない場合)
ちなみに、私は確認できてないですが、AWS CLIのインストールは少なくとも必要そうです。
参考
DynamoDB の GUI ツールが公式から出たよ!
AWS CLIでAWSの接続設定が済んでいない。AWS CLIとは異なる接続設定を利用したい場合。
「+ Add connection」を選択。
以下の入力項目が出てくるのでそれぞれ設定。
最低限の設定項目
Connection name : 任意
Default AWS Region : ap-northeast-1 (DynamoDBを作成した場所)
Access key ID : 接続するユーザのもの
Secret access key : 接続するユーザのもの
必須でない項目
Session token
今のところ分かってない!!(以下参照ください)
Amazon DynamoDB用 NoSQL Workbenchでsession tokenを使って接続してみた
IAM role Arn
今のところやってみた人いなさそう?(以下公式情報)
Amazon DynamoDB 用の NoSQL Workbench が、AWS Identity and Access Management (IAM) ロールと一時的なセキュリティ認証情報のサポートを追加
Persist connection
チェックするとAWSの接続情報を/Users/[ユーザ名]/.aws/credentials
に保存される。
動作確認
テーブルを選択して、DynamoDBに登録したデータが表示されたらOKです。
ちょっと使ってみる
DynamoDBを操作するには、今までみていた「Results」ではなく「Build operations」を開きます。
開くと「Data plane operations」という項目があり、このプルダウンの中の操作ができる模様。
PutItem
書き込みやってみたかったので、PutItem
やってみます。
入力項目(ざっと)
Data plane operations : PutItem
Table : 操作したいテーブル名
Partition Key : Partition Keyの値の入力
Other attributes→その他の値
あとは「Run」をクリックして、入力項目に問題がなければデータが追加されます。
また「Generate code」をクリックすると、「Build operations」で指定した操作について「Python」「JavaScript」「Java」それぞれのコードを作成してくれます。(すごい)
Scan
キャプチャのみにとどめますがScan
の場合は以下のようになります。
(satisfaction)
余談
普通にインストールするとデスクトップにアイコン配置されるのなんででしょうね。(macOSは個人的になくていい)
おわり
便利な機能たくさんありそうなので、何か発見したらまた記事にしようかと思います。
以上です!!