Microsoft AzureのNoSQLデータベース「Cosmos DB」における実装方法を知る
Microsoft AzureのNoSQLデータベース「Cosmos DB」を使ってみよう 第3回
Cosmos DB Emulatorのインストールとセットアップ
続いて、Cosmos DB Emulatorを使用できるようにしていきます。
インストール
Cosmos DB Emulatorのインストーラーは、Cosmos DB Emulatorの紹介ページから入手できます。
バイナリ版とDocker版の2種類から選ぶことができますが、今回はバイナリ版からインストールします。
ページの冒頭にある[Download MSI]のリンクをクリックすると、インストーラーのダウンロードが始まります。
ダウンロードしたインストーラーにしたがって、Emulatorをインストールします。
インストールが完了すると、ブラウザが起動してEmulatorのクライアント画面が表示されます。表示されない場合は、ブラウザを起動してhttps://localhost:8081/_explorer/index.htmlにアクセスしてください。
画面左側に[Quickstart]と[Explorer]というメニューが表示されています。それぞれ、以下のことができます。
- Quickstart:各言語(.NET, Java, Node.js, Python)向けのテンプレートがダウンロードできる画面
- Explorer:Cosmos DB Emulatorに作成したデータベース・コレクション・ドキュメントを確認できる画面
今回はアプリを一から作っていくためQuickstartは使用せず、Explorerだけを使用します。
認証キーの取得
アプリからCosmos DBにアクセスするために必要な認証キーを作成します。コマンドプロンプトからリスト1のコマンドを実行することで、ファイルに認証キーが出力されます。
> cd C:\Program Files\Azure Cosmos DB Emulator > CosmosDB.Emulator.exe /GenKeyFile=<保存先ファイル名>
認証キーを作成したら一度Emulatorを停止し、認証キーファイルを指定して再度Emulatorを起動します。これにより、ファイル内に記載されている認証キーを使って、アプリケーションからCosmos DBにアクセスすることができるようになります。
> cd C:\Program Files\Azure Cosmos DB Emulator > CosmosDB.Emulator.exe /Shutdown > CosmosDB.Emulator.exe /KeyFile="<認証キーファイルのフルパス>"
以上でEmulatorの準備は完了です。
プロジェクトの作成
それでは、ここからは実際にDocumentDB APIを使ってCosmos DBを操作してみましょう。
Visual StudioといったIDEのプロジェクトの新規作成メニューから、[Console Application]を選択してプロジェクトを作成します。プロジェクト名は「TodoApplication」とします。
必要なライブラリの追加
プロジェクトを作成したら、ライブラリを追加していきます。NuGetを使って「DocumentDB Client Library」と「JSON」のパッケージをインストールします。DocumentDB APIのドキュメントの形式はJSONのため、オブジェクトの変換に「JSON」を利用します。
PM> Install-Package Microsoft.Azure.DocumentDB PM> Install-Package Newtonsoft.Json
接続情報の設定
次に、Cosmos DBの接続情報を「App.config」に追加していきます。「authKey」の値には、先ほど作成した認証キーを設定してください。
<appSettings>
<add key="endpointUrl" value="https://localhost:8081/" />
<add key="authKey" value="認証キー" />
<add key="databaseId" value="DemoDb" />
<add key="collectionId" value="TodoCollection" />
</appSettings>
プロジェクトに、新しく「DocumentRepository.cs」というクラスを作成します。このクラスにCosmos DBへのデータアクセス機能を集約します。
まずは「App.config」に設定した接続情報を読み込み、Cosmos DBとやり取りを行うクライアントオブジェクトを生成しましょう。
public class DocumentRepository
{
// Cosmos DBのURL
private static readonly string EndpointUrl = ConfigurationManager.AppSettings["endpointUrl"];
// Cosmos DBの認証キー
private static readonly string AuthKey = ConfigurationManager.AppSettings["authKey"];
// データベース名
private static readonly string DatabaseId = ConfigurationManager.AppSettings["databaseId"];
// コレクション名
private static readonly string CollectionId = ConfigurationManager.AppSettings["collectionId"];
// DocumentDB APIのクライアントオブジェクト
private static DocumentClient client;
public static void Initialize()
{
// DocumentDB APIクライアントのインスタンスを生成
client = new DocumentClient(new Uri(EndpointUrl), AuthKey);
}
・・・
この記事は参考になりましたか?
- Microsoft AzureのNoSQLデータベース「Cosmos DB」を使ってみよう連載記事一覧
-
- Microsoft AzureのNoSQLデータベース「Cosmos DB」における運用時...
- Cosmos DBアプリで検索/更新/削除機能を実装する
- Microsoft AzureのNoSQLデータベース「Cosmos DB」における実装方...
- この記事の著者
-
WINGSプロジェクト 秋葉 龍一(アキバ リュウイチ)
<WINGSプロジェクトについて>有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。 2026年時点での登録メンバは約50名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂きたい。著書、記事多数。 RSS X: @WingsPro_info(公式)、@WingsPro_info/wings(メンバーリスト) Facebook
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です
-
山田 祥寛(ヤマダ ヨシヒロ)
静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるLaravel実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数。
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です
この記事は参考になりましたか?
この記事をシェア
