Linux ベースのエミュレーター - vNext

Azure Cosmos DB エミュレーターの次世代は完全に Linux ベースであり、Docker コンテナーとして使用できます。 さまざまなプロセッサとオペレーティング システムでの実行をサポートしています。

Important

このバージョンのエミュレーターでは、ゲートウェイ モード のNoSQL用 API のみがサポートされ、一部の機能が選択されています。 現在、認証は強制されません。 詳細については、 認証 と機能の サポートに関する記事を参照してください。

Prerequisites

Installation

docker pull を使用して Docker コンテナー イメージを取得します。 コンテナー イメージは、 として mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latestに公開されます。

docker pull mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest

Running

コンテナーを実行するには、docker run を使用します。 その後、docker ps を使用して、コンテナーが実行されていることを検証します。

docker run --detach --publish 8081:8081 --publish 8080:8080 --publish 1234:1234 mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest

docker ps
CONTAINER ID   IMAGE                                                             COMMAND                  CREATED         STATUS         PORTS                                                                                  NAMES
c1bb8cf53f8a   mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest  "/bin/bash -c /home/…"   5 seconds ago   Up 5 seconds   0.0.0.0:1234->1234/tcp, :::1234->1234/tcp, 0.0.0.0:8081->8081/tcp, :::8081->8081/tcp   <container-name>

エミュレーターには、次の 2 つのコンポーネントが含まれています。

  • Data Explorer - エミュレーター内のデータを対話形式で探索します。 既定では、このコンポーネントはポート 1234で実行されます。
  • Azure Cosmos DB エミュレーター - Azure Cosmos DB データベース サービスのローカル バージョン。 既定では、このコンポーネントはポート 8081で実行されます。

エミュレーター ゲートウェイ エンドポイントは、アドレス 8081でポート http://localhost:8081を使用します。 Data Explorerに移動するには、Web ブラウザーでアドレス http://localhost:1234 を使用します。 通常、ゲートウェイ エンドポイントはすぐに使用できますが、Data Explorerの開始には数秒かかる場合があります。

ヘルスプローブ

エミュレーターは、ポート 8080で正常性プローブ エンドポイントを公開します。 このエンドポイントを使用して、エミュレーターが完全に初期化され、要求を受け入れる準備ができているタイミングを判断します。

次のエンドポイントを使用できます。

注

従来のログ メッセージ System is now fully ready to accept requests は下位互換性のために出力されますが、今後のバージョンでは削除される可能性があります。 代わりに、ヘルスプローブを使用して準備状態を確認してください。

HTTPS モード

.NET SDK と Java SDK は、エミュレーターの HTTP モードをサポートしていません。 このバージョンのエミュレータは、既定では HTTP で始まるため、コンテナーを開始するときに明示的に HTTPS を有効にする必要があります (以下を参照)。 Java SDK の場合は、証明書をインストールする必要もあります。

docker run --detach --publish 8081:8081 --publish 8080:8080 --publish 1234:1234 mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest --protocol https

永続化されたデータ ボリュームで HTTPS を使用すると、エミュレーターは起動時に SSL 証明書を自動的に再生成するため、証明書の更新を管理する必要はありません。

Authentication

vNext エミュレーターでは、現在認証を強制していません。 SDK とツールでは、引き続きクライアント構成または接続文字列にアカウント キーが必要になる場合がありますが、エミュレーターはアクセスを制御するための資格情報を検証しません。 --key-fileを使用してカスタム キーを構成しても、認証の適用は有効になりません。

HTTPS はトラフィックを暗号化しますが、この動作は変更されません。 エミュレーターは、信頼できる環境での開発とテストにのみ使用し、そのエンドポイントを信頼されていないネットワークに公開しないでください。 認証と承認の動作をテストするには、vNext エミュレーターではなくAzure Cosmos DB アカウントを使用します。

Docker コマンド

次の表は、エミュレータを構成するために使用できる Docker コマンドをまとめています。 この表では、対応する引数、環境変数、使用できる値、既定の設定、および各コマンドの説明について詳しく説明します。

Requirement Arg Env 使用できる値 Default Description
コンテナーから stdout に設定を出力する --help、-h N/A N/A N/A 使用可能な構成に関する情報を表示する
Cosmos エンドポイントのポートを設定する --port [INT] ポート INT 8081 コンテナー上の Cosmos エンドポイントのポート。 引き続きこのポートを公開する必要があります (たとえば、-p 8081:8081)。
Cosmos エンドポイントによって使用されるプロトコルを指定する --protocol プロトコル https、http、https-insecure http コンテナー上の Cosmos エンドポイントのプロトコル。
データ エクスプローラーを有効にする --enable-explorer エクスプローラーを有効化 true、false true 同じコンテナーで Cosmos Data Explorerの実行を有効にします。
データ エクスプローラーで使用されるポートを設定する --explorer-port EXPLORER_PORT INT 1234 コンテナー上の Cosmos データ エクスプローラーのポート。 引き続きこのポートを公開する必要があります (たとえば、-p 1234:1234)。
データ エクスプローラーで使用されるプロトコルを指定する --explorer-protocol EXPLORER_PROTOCOL https、http、https-insecure <the value of --protocol> コンテナー上の Cosmos データ エクスプローラーのプロトコル。 既定で、Cosmos エンドポイントのプロトコル設定になります。
ゲートウェイ パブリック エンドポイントをカスタマイズする --gateway-endpoint ゲートウェイ公開エンドポイント N/A localhost パブリック ゲートウェイ エンドポイント。 既定値は localhost です。
ファイルを介してキーを指定する --key-file [PATH] キー_ファイル PATH <default secret> ファイルで指定されたキーで既定のキーをオーバーライドします。 このファイルをコンテナーにマウントする必要があります (たとえば、KEY_FILE=/mykey の場合は、docker run に次のようなオプションを追加します: --mount type=bind,source=./myKey,target=/myKey)
データ パスを設定する --data-path [PATH] DATA_PATH PATH /data データのディレクトリを指定します。 docker run --mount オプションで頻繁に使用されます (たとえば、DATA_PATH=/usr/cosmos/data の場合は、docker run に次のようなオプションを追加します: --mount type=bind,source=./.local/data,target=/usr/cosmos/data)
https に使用する証明書のパスを指定する --cert-path [PATH] CERT_PATH PATH <default cert> トラフィックをセキュリティで保護するために証明書へのパスを指定します。 このファイルをコンテナーにマウントする必要があります (たとえば、CERT_PATH=/mycert.pfx の場合は、docker run に次のようなオプションを追加します: --mount type=bind,source=./mycert.pfx,target=/mycert.pfx)
https に使用する証明書のシークレットを指定する N/A CERT_SECRET 文字列 <default secret> CERT_PATH で指定された証明書のシークレット。
ログ レベルを設定する --log-level [LEVEL] LOG_LEVEL quiet、 error、 warn、 info、 debug、 trace info エミュレーターとデータ エクスプローラーによって出力されるログの詳細度。
OpenTelemetry OTLP エクスポーターを有効にする --enable-otlp ENABLE_OTLP_EXPORTER true、false false OpenTelemetry 統合を有効にします。
コンソール エクスポーターを有効にする --enable-console ENABLE_CONSOLE_EXPORTER true、false false テレメトリ データのコンソール出力を有効にします (デバッグに役立ちます)。
詳細モードを有効にする --verbose 冗長 true、false false 冗長モードを有効にして、PostgreSQL ログ (pglog) をコンソールに表示します。 デバッグに便利です。
クエリ バッファー サイズを設定する --query-buffer-size QUERY_BUFFER_SIZE_KB INT 4096 (4 MB)、最大 65536 (64 MB) クエリ結果バッファーの最大サイズ (KB 単位)。 大規模なクエリで HTTP 500 エラーが発生した場合は、これを増やします。
コンテナーの起動時にデータのシード処理を有効にする --enable-init-data ENABLE_INIT_DATA true、false false エミュレーターが要求を受け入れる前に、init ディレクトリの最上位にある .csh スクリプトをアルファベット順に実行します。 Azure Cosmos DB のシェル統合を参照してください。
init スクリプトのディレクトリを設定する --init-path [PATH] INIT_PATH PATH /init エミュレーターが.cshするときにENABLE_INIT_DATA=trueシード スクリプトをスキャンするディレクトリ。
Microsoft に診断情報を送信できるようにする --enable-telemetry テレメトリを有効にする true、false true エミュレーターの改善に役立つ使用状況データを Microsoft に送信できるようにします。

機能のサポート

すべてのAzure Cosmos DB機能がエミュレーターでサポートされているわけではなく、将来のサポートが予定されていないものもあります。 この表には、さまざまな機能の状態とそのサポート レベルが記載されています。

特徴 Support
認証の適用 ❌ サポートされていません
Batch API ✅ サポートされています
Bulk API ✅ サポートされています
変更フィード ✅ サポートされています
UTF データを使用したドキュメントの作成と読み取り ✅ サポートされています
コレクションを作成 ✅ サポートされています
コレクションの重複作成の競合 ✅ サポートされています
カスタム インデックス ポリシーを使用してコレクションを作成する ⚠️ 部分的なサポート。インデックス作成のサポートを参照してください
TTL による有効期限付きコレクションを作成する ✅ サポートされています
データベースの作成 ✅ サポートされています
データベースを2回作成した場合の競合 ✅ サポートされています
ドキュメントを作成 ✅ サポートされています
パーティション分割コレクションを作成する ✅ サポートされています
コレクションを削除する ✅ サポートされています
データベースの削除 ✅ サポートされています
ドキュメントを削除 ✅ サポートされています
コレクションのパフォーマンスを取得および変更する ⚠️ まだ実装されていません
大きなドキュメントの挿入 ✅ サポートされています
パッチ文書 ✅ サポートされています
パーティション分割されたコレクションを並列で照会する ⚠️ まだ実装されていません
集計を使用したクエリ ✅ サポートされています
クエリを使用したフィルター処理 ✅ サポートされています
フィルターとプロジェクションを使用したクエリ ✅ サポートされています
等価条件でのクエリ ✅ サポートされています
id に対する equals 条件のクエリ ✅ サポートされています
結合を使用したクエリ ✅ サポートされています
ORDER BY付きクエリ ✅ サポートされています
パーティション分割されたコレクションの順序を指定してクエリを実行する ✅ サポートされています
番号でORDER BYするクエリ ✅ サポートされています
ORDER BY に文字列を使うクエリ ✅ サポートされています
ページングを使用したクエリ ✅ サポートされています
範囲演算子を使用した日付時刻のクエリ ✅ サポートされています
数値に対する範囲演算子を使用したクエリ ✅ サポートされています
文字列に対する範囲演算子を使用したクエリ ✅ サポートされています
単一結合を使用したクエリ ✅ サポートされています
文字列の算術演算子と配列演算子を使用したクエリ ✅ サポートされています
サブドキュメントを使用したクエリ ✅ サポートされています
2 つの結合を使用したクエリ ✅ サポートされています
2 つの結合とフィルターを使用したクエリ ✅ サポートされています
コレクションの読み取り ✅ サポートされています
コレクション フィードの読み取り ⚠️ まだ実装されていません
データベースの読み取り ✅ サポートされています
データベース フィードの読み取り ⚠️ まだ実装されていません
ドキュメントの読み取り ✅ サポートされています
ドキュメント フィードの読み取り ✅ サポートされています
ドキュメントを置き換える ✅ サポートされています
要求ユニット ⚠️ まだ実装されていません
ストアド プロシージャ ❌ 未計画
トリガー ❌ 未計画
UDFs ❌ 未計画
コレクションの更新 ⚠️ No-op
ドキュメントを更新する ✅ サポートされています
オファー用エンドポイント ⚠️ No-op
ユーザーエンドポイント ⚠️ No-op
アクセス許可エンドポイント ⚠️ No-op
クライアント暗号化キー (CEK) ⚠️ No-op

注

No-op とマークされた機能は、要求を受け入れ、有効な HTTP 状態コードを返しますが、基になる操作は実行しません。 コードは壊れませんが、特定のこれらの機能に頼りにしないでください。 コレクションの更新は互換性のために受け入れられますが、変更は適用されません。 カスタム インデックス作成ポリシーでは、DiskANN ベクター インデックスに対してのみクエリが最適化されます。他のカスタム インデックス定義は互換性のために受け入れられますが、クエリは最適化されません。

インデックスのサポート

vNext エミュレーターでは、DiskANN ベクター インデックスがサポートされています。 範囲インデックス、複合インデックス、空間インデックスのサポートはまだ開発中であり、まだ使用できません。 次の表は、現在サポートされているインデックスの種類、サポートが計画されているインデックスの種類、およびサポートされていないインデックスの種類を区別しています。

インデックスの種類 Support
範囲 ⚠️ 予定、まだ利用できません
Composite ⚠️ 計画済み、まだ利用できません
Spatial ⚠️ 計画済み、まだ利用できません
DiskANN (diskANN) ベクター ✅ サポートされています
フラット (flat) ベクター ❌ サポートされていません
量子化フラット (quantizedFlat) ベクトル ❌ サポートされていません
Full-text ❌ サポートされていません

DiskANN のサポートは、他のベクター インデックスの種類やフルテキスト インデックスのサポートを意味するものではありません。 これらのインデックスの種類の詳細については、「 インデックス作成の概要 と ベクター検索」を参照してください。

Java SDK の証明書をインストールする

このバージョンのエミュレーターで Java SDK for Azure Cosmos DB を https モードで使用する場合は、その証明書をローカルのJava信頼ストアにインストールする必要があります。

証明書を取得する

bash ウィンドウで、以下を実行します。

# If the emulator was started with /AllowNetworkAccess, replace localhost with the actual IP address of it:
EMULATOR_HOST=localhost
EMULATOR_PORT=8081
EMULATOR_CERT_PATH=/tmp/cosmos_emulator.cert
openssl s_client -connect ${EMULATOR_HOST}:${EMULATOR_PORT} </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > $EMULATOR_CERT_PATH

証明書のインストール

cacerts ファイルがある Java インストールのディレクトリに移動します (以下を正しいディレクトリで置き換えます)。

cd "C:/Program Files/Eclipse Adoptium/jdk-17.0.10.7-hotspot/bin"

証明書をインポートします (パスワードの入力を求められる場合があります。既定値は "changeit" です)。

keytool -cacerts -importcert -alias cosmos_emulator -file $EMULATOR_CERT_PATH

エイリアスが既に存在しているためにエラーが発生した場合は、削除してから、上記をもう一度実行します。

keytool -cacerts -delete -alias cosmos_emulator

エミュレーターで Azure Cosmos DB Shell を使用する

Azure Cosmos DB Shell は、bash のようなコマンドを使用してAzure Cosmos DB データベースを操作できるオープンソースのコマンド ライン インターフェイス (CLI) です。 シェルはエミュレーター コンテナー イメージに含まれているため、個別にインストールする必要はありません。

実行中のエミュレーターに対して対話型セッションを開始するには、 docker execを使用します。

docker exec -it <container-name> cosmoshell.sh

注

cosmoshell.sh ラッパーは、エミュレーター エンドポイントを自動的に検出し、既知のアカウント キーを使用して接続します。 vNext エミュレーターでは、認証を強制しません。 基になるバイナリは、コンテナー内の /usr/local/bin/cosmosdbshell にあります。

シェルでは、コンテナーの初回起動時にスクリプトを実行することもできます。そのため、アプリケーションが接続する前にデータベース、コンテナー、シード ドキュメント、およびその他の状態が準備されます。 オプトインするには、ENABLE_INIT_DATA=trueを設定するか、--enable-init-data=trueを渡します。 既定値は false です。 有効にすると、エミュレーターは.cshの最上位レベルにある/initファイルをアルファベット順に処理します。 別のディレクトリを使用するには、INIT_PATH(または --init-path)でそのディレクトリを指定します。

同梱のサンプルデータを使用する

このイメージには、ビルド時に/initにコピーされる/scripts/init_examples/の下にサンプル シード スクリプトが付属しています。 それらを読み込むには、ENABLE_INIT_DATA=trueを使用してコンテナーを開始します:

docker run --name emulator --rm -e ENABLE_INIT_DATA=true -p 8081:8081 mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest

その後、シェルに接続し、データを探索できます。

docker exec emulator cosmoshell.sh -c 'ls; cd SampleDB; ls'

独自のデータを投入する

独自のデータをシードできます。 たとえば、ローカル フォルダー 03-verify.csh に 3 つのファイル (movies、01-create-db.csh、02-load-movies.csh) を作成します。

mkdir movies && cd movies

01-create-db.csh:

mkdb MovieDB
mkcon Movies /genre --database=MovieDB

02-load-movies.csh:

mkitem -container Movies --database=MovieDB '{"id":"m1","genre":"scifi","title":"Inception","year":2010}'
mkitem -container Movies --database=MovieDB '{"id":"m2","genre":"scifi","title":"The Matrix","year":1999}'
mkitem -container Movies --database=MovieDB '{"id":"m3","genre":"drama","title":"The Godfather","year":1972}'

03-verify.csh:

query "SELECT VALUE COUNT(1) FROM c" --database=MovieDB --container=Movies

次に、そのディレクトリを /init にマウントした状態でエミュレーターを実行します。

docker run --name emulator --rm -e ENABLE_INIT_DATA=true -v "$(pwd):/init" -p 8081:8081 mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest

データが読み込まれたかどうかを確認するには、シェルに接続し、クエリを実行します。

docker exec emulator cosmoshell.sh -c 'ls; query "SELECT VALUE COUNT(1) FROM c" --database=MovieDB --container=Movies'

注

/initのシード データはアルファベット順に処理されます。 一貫性のある順序を確保するには、ファイルに 01-、 02-、 03-などをプレフィックスとして付けます。 常に 2 桁のプレフィックス (01-、 02-、...、 99-) または 3 桁のプレフィックスを使用します。

ファイル名には、文字、数字、ドット、アンダースコア、ハイフンのみを含める必要があります。 たとえば、 01-create-catalog.csh と 02_load_books.csh は有効ですが、 01 create catalog.csh (スペース) と café.csh (ASCII 以外の文字) は有効ではありません。

init スクリプト間で状態を共有する

/init内の各.csh ファイルは同じシェル セッションで実行されるため、1 つのファイルで設定された状態は、次のファイルで引き続き有効になります。 これには、 cdによって設定された現在のパス、 defで定義されたカスタム コマンド、および for ループ変数が含まれます。

これを使用すると、前の例のすべての行で --database=MovieDB を繰り返し書かずに済みます。 01-create-db.cshの末尾にcd MovieDBを追加します。

01-create-db.csh:

mkdb MovieDB
mkcon Movies /genre --database=MovieDB
cd MovieDB

後続のファイルでは --database=MovieDBを省略できます。

02-load-movies.csh:

mkitem -container Movies '{"id":"m1","genre":"scifi","title":"Inception","year":2010}'
mkitem -container Movies '{"id":"m2","genre":"scifi","title":"The Matrix","year":1999}'
mkitem -container Movies '{"id":"m3","genre":"drama","title":"The Godfather","year":1972}'

03-verify.csh:

query "SELECT VALUE COUNT(1) FROM c" --container=Movies

再起動時にデータを保持する

既定では、コンテナーが停止すると、すべての docker run --rm がエミュレーターのデータをワイプするため、init スクリプトは次の起動時に最初から再実行されます。 シードされたデータを保持する (後続の実行で init をスキップする) には、 /dataにホスト フォルダーをバインドマウントします。

mkdir -p ./cosmos-data

docker run --rm -p 8081:8081 -e ENABLE_INIT_DATA=true -v "$(pwd):/init" -v "$(pwd)/cosmos-data:/data" mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest

同じ -v "$(pwd)/cosmos-data:/data" フラグを使用して以降の起動時に、エミュレーターは既存のデータを検出し、init プロセスをスキップするため、以前にシードされた状態が保持されます。 最初から再シード処理するには、ホスト フォルダー (rm -rf ./cosmos-data) を削除して、もう一度開始します。

ローカル シェルから接続する

ローカルにインストールされているバージョンの Azure Cosmos DB Shell から実行中のエミュレーターに接続することもできます。 それをエミュレーターのエンドポイントとキーに指定します。

cosmosdbshell --connect "AccountEndpoint=http://localhost:8081/;AccountKey=<emulator-account-key>"

注

<emulator-account-key>を既知のエミュレーター アカウント キーに置き換えます。

OpenTelemetry のサポート

OpenTelemetry は、テレメトリ データのインストルメント化、生成、収集、エクスポートのためのツール、API、SDK のコレクションを提供するオープンソースの監視フレームワークです。 OpenTelemetry Protocol (OTLP) は、OpenTelemetry がコンポーネント間でテレメトリ データを送信するために使用するプロトコルです。

エミュレーターで OpenTelemetry を使用して、アプリケーションを監視およびトレースできます。 エミュレーターでは、Docker コンテナーの実行時に環境変数またはコマンド ライン フラグを使用して構成できるテレメトリ オプションがサポートされています。

エミュレーターは、次のメトリックをエクスポートします。 これらは、OTLP をサポートし、データベースのパフォーマンスと正常性に関する貴重な分析情報を提供するメトリック バックエンドを通じて利用できます。

  • 要求レート: さまざまな操作の種類のトラフィック パターンを示します
  • クエリ実行時間: さまざまなクエリの実行にかかった時間を測定します
  • リソース使用率: CPU、メモリ使用量、接続プールのメトリック
  • エラー率: 種類とエンドポイントによるエラーの追跡

注

エミュレーターは OTLP エクスポーターの条件付き TLS をサポートしているため、セキュリティで保護された接続を必要とする監視プラットフォームと統合できます。

例を含む詳細な手順 については、GitHub リポジトリを参照してください。

継続的インテグレーション ワークフローでの使用

CI/CD パイプラインで Docker コンテナーを使用すると、特にデータベースなどのステートフル システムに対して多くの利点があります。 これは、テスト スイートのコスト効率、パフォーマンス、信頼性、一貫性の観点から考えられます。

エミュレーターは、CI/CD パイプラインの一部として組み込むことができます。 この GitHub リポジトリ を参照すると、 x64 アーキテクチャと ARM64 アーキテクチャの両方で 、.NET、Python、Java、Go アプリケーションの GitHub Actions CI ワークフローの一部としてエミュレーターを使用する方法の例を示します ( ubuntu を使用した Linux ランナーの場合に示されています)。

GitHub Actions CI ワークフローの例を次に示します。このワークフローでは、エミュレーターを GitHub Actions サービス コンテナー としてワークフロー内のジョブの一部として構成する方法を示します。 GitHub は Docker コンテナーの起動を処理し、ジョブの完了時に破棄します。これには手動の介入(docker run コマンドの使用など)は必要ありません。

name: CI demo app

on:
  push:
    branches: [main]
    paths:
      - 'java-app/**'
  pull_request:
    branches: [main]
    paths:
      - 'java-app/**'

jobs:
  build-and-test:
    runs-on: ubuntu-latest

    services:
      cosmosdb:
        image: mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest
        ports:
          - 8081:8081
        env:
          PROTOCOL: https
        
    env:
      COSMOSDB_CONNECTION_STRING: ${{ secrets.COSMOSDB_CONNECTION_STRING }}
      COSMOSDB_DATABASE_NAME: ${{ vars.COSMOSDB_DATABASE_NAME }}
      COSMOSDB_CONTAINER_NAME: ${{ vars.COSMOSDB_CONTAINER_NAME }}

    steps:

      - name: Set up Java
        uses: actions/setup-java@v3
        with:
          distribution: 'microsoft'
          java-version: '21.0.0'

      - name: Export Cosmos DB Emulator Certificate
        run: |

          sudo apt update && sudo apt install -y openssl

          openssl s_client -connect localhost:8081 </dev/null | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > cosmos_emulator.cert

          cat cosmos_emulator.cert

          $JAVA_HOME/bin/keytool -cacerts -importcert -alias cosmos_emulator -file cosmos_emulator.cert -storepass changeit -noprompt
      
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Run tests
        run: cd java-app && mvn test

このジョブは Ubuntu ランナーで実行され、 mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-latest Docker イメージをサービス コンテナーとして使用します。 環境変数を使用して、接続文字列、データベース名、コンテナー名を構成します。 この場合、ジョブは GitHub Actions ランナー コンピューターで直接実行されるため、ジョブ内の テストの実行 ステップは、 localhost:8081 を使用してエミュレーターにアクセスできます (8081 はエミュレーターによって公開されるポートです)。

Azure Cosmos DB Java SDK は現在、エミュレーターのHTTP モードをサポートしていないため、Cosmos DB Emulator 証明書のエクスポート手順は Java アプリケーションに固有です。 PROTOCOL環境変数は https セクションでservicesに設定され、この手順ではエミュレーター証明書をエクスポートして Java キーストアにインポートします。 .NET にも同じことが当てはまります。

制限事項

次の一覧には、まだサポートされていない機能や計画されていない機能に加えて、エミュレータの現在の制限事項が記載されています。

  • Azure Cosmos DB 用 .NET SDK では、エミュレーターでの一括実行はサポートされていません。
  • 大きなクエリ結果で HTTP 500 エラーが発生した場合は、 --query-buffer-size フラグまたは QUERY_BUFFER_SIZE_KB 環境変数を使用してクエリ バッファー サイズを大きくします。 既定値は 4096 KB (4 MB) で、最大値は 65536 KB (64 MB) です。

問題の報告

このバージョンのエミュレータの使用で問題が発生した場合は、GitHub のリポジトリ (https://github.com/Azure/azure-cosmos-db-emulator-docker) で問題を開き、ラベル cosmosEmulatorVnextPreview を使用してタグ付けします。