MongoDB CompassからDocumentDBに接続する

経緯

AWSのDocumentDBを使って遊んでるんだけど、ローカルの開発で使ってるMongoDB Compassで接続できないかいろいろ試した結果できたのでまとめ。

前提

まずは、接続するマシンにMongoDB Compassを入れておくこと。WindowsもLinuxあるからお好きなので。

AWSのDocumentDBには設定用のEC2が接続できていること。
これはDocumentDBのAWS公式ドキュメントのAmazon EC2 を使用して接続を見ながらやればすぐできると思う。

下準備 EC2編

• AWSのEC2のインスタンス概要に移動して接続するインスタンスまで移動して、接続ボタンをクリック
  

• SSHクライアントを選ぶ
  

そこに書いてあるEC2接続用プライベートキーファイル(AWS-EC2_ExpampleA.pem)と、ユーザ名（初期値はec2-user）とインスタンスのURL([e-mail])を記録しておく。
プライベートキーファイルはEC2インスタンス作成時にしか表示できないので、保存してなかったらインスタンスを再度作成したほうが早い。

• EC2のインスタンス概要の下にあるセキュリティをクリックしてインバウンドルールに追加 通常だと下記の1と3は設定済のはずなので、自分のマシンからMongoDBを接続するので2を追加してポートを通す。

1. SSH接続用(Port22)と自分のIPv4アドレスを追加
2. MongoDB接続用(Port27017)と自分のIPv4アドレスを追加
3. MongoDB接続用(Port27017)とインスタンスのIPv4アドレスを追加

下準備 DocumentDB

• AWSのDocumentDBに移動して、クラスタ→接続とセキュティをクリック

1. DocumentDBのURL(docdb-YYYY-MM-DD-hh-mm-ss.cluster-sample.A1-east-1.docdb.amazonaws.com)
2. DocumentDB作成時のID
3. DocumentDB作成時のパスワード

DocumentDBのURLは、「mongo シェルでこのクラスターに接続する」に書いてあるとこから引っ張ってくる。

MongoDB Compassの設定

• MongoDB Compassを起動したら、New ConnectionにあるFill in connection fields individuallyをクリック
  

• Authenticationを None → Username/Password に変更する
  

• ここはDocumentDBの設定項目で、入力内容は以下の通り
  

1. DocumentDBのURL : docdb-YYYY-MM-DD-hh-mm-ss.cluster-sample.A1-east-1.docdb.amazonaws.com
2. DocumentDBのポート番号 : 27017
3. 認証方法 : Username/Password
4. UserName : DocumentDB作成時のID
5. Password : DocumentDB作成時のパスワード

• More Optionをクリックして入力項目を切り替える
  

• 入力項目を切り替える
  
  SSLをNoneからUnvalidated(insecure)、SSH TunnelをNoneからUse Identity Fileに変更する

• ここはSSHの設定項目で、入力内容は以下の通り　主要箇所だけ記載
  

1. EC2インスタンスのURL : [e-mail]
2. EC2のユーザ名 : ec2-user
3. EC2接続用プライベートキー : AWS-EC2_ExpampleA.pem

これで、入力項目は終わり。

接続

Connectボタンをクリックすると接続を開始する。

接続に成功すると以下のようなダイアログが表示される。
DocumentDBは純粋なMongoDBでないので、警告メッセージがでてるだけで問題ない。

アプリの左側にも警告メッセージ表示されてるけど通常使用には問題ない。

ここまでできればローカルでやってることと特に制限なくできる。
接続してしまえば、ちょっとしたDBの書き換えや抽出できるので便利になるので捗る。