Azure Cosmos DB for MongoDB (4.0 サーバーバージョン): サポートされる機能と構文

[アーティクル]
04/27/2023

適用対象: MongoDB

Azure Cosmos DB は、Microsoft のグローバルに分散されたマルチモデルデータベースサービスです。 Azure Cosmos DB for MongoDB との通信は、オープンソースで公開されている任意の MongoDB クライアントドライバーを使用して行うことができます。 Azure Cosmos DB for MongoDB では、MongoDB ワイヤープロトコルに従うことにより、既存のクライアントドライバーを利用できます。

Azure Cosmos DB for MongoDB を使用すれば、使い慣れた MongoDB API を活用できます。グローバル配信、自動シャーディング、可用性や待ち時間の保証、保存時の暗号化、バックアップを始めとする Azure Cosmos DB のエンタープライズ機能をすべて利用できます。

プロトコルのサポート

以下に、サポートされている演算子およびすべての制限事項や例外の一覧を示します。これらのプロトコルを認識するすべてのクライアントドライバーは、Azure Cosmos DB for MongoDB に接続できるはずです。 Azure Cosmos DB for MongoDB アカウントを作成する場合、3.6 以降のバージョンのアカウントのエンドポイントが *.mongo.cosmos.azure.com という形式であるのに対し、3.2 バージョンのアカウントのエンドポイントは *.documents.azure.com という形式です。

Note

この記事では、サポートされているサーバーコマンドの一覧のみを示し、クライアント側のラッパー関数については除外しています。 deleteMany() や updateMany() などのクライアント側のラッパー関数は、内部では delete() や update() といったサーバーコマンドを利用しています。サポートされるサーバーコマンドを利用している関数は、Azure Cosmos DB for MongoDB と互換性があります。

クエリ言語のサポート

Azure Cosmos DB for MongoDB では、MongoDB クエリ言語のコンストラクトが包括的にサポートされます。以下に、現在サポートされている操作、演算子、ステージ、コマンド、およびオプションの詳細な一覧を示します。

データベースコマンド

Azure Cosmos DB for MongoDB では、次のデータベースコマンドがサポートされます。

クエリおよび書き込み操作コマンド

command	サポートされています
`change streams`	はい
`delete`	はい
`eval`	いいえ
`find`	はい
`findAndModify`	はい
`getLastError`	はい
`getMore`	はい
`getPrevError`	いいえ
`insert`	はい
`parallelCollectionScan`	いいえ
`resetError`	いいえ
`update`	はい

トランザクションコマンド

command	サポートされています
`abortTransaction`	はい
`commitTransaction`	はい

認証コマンド

command	サポートされています
`authenticate`	はい
`getnonce`	はい
`logout`	はい

管理コマンド

command	サポートされています
`cloneCollectionAsCapped`	いいえ
`collMod`	いいえ
`connectionStatus`	いいえ
`convertToCapped`	いいえ
`copydb`	いいえ
`create`	はい
`createIndexes`	はい
`currentOp`	はい
`drop`	はい
`dropDatabase`	はい
`dropIndexes`	はい
`filemd5`	はい
`killCursors`	はい
`killOp`	いいえ
`listCollections`	はい
`listDatabases`	はい
`listIndexes`	はい
`reIndex`	はい
`renameCollection`	いいえ

診断コマンド

command	サポートされています
`buildInfo`	はい
`collStats`	はい
`connPoolStats`	いいえ
`connectionStatus`	いいえ
`dataSize`	いいえ
`dbHash`	いいえ
`dbStats`	はい
`explain`	はい
`features`	いいえ
`hostInfo`	はい
`listDatabases`	はい
`listCommands`	いいえ
`profiler`	いいえ
`serverStatus`	いいえ
`top`	いいえ
`whatsmyuri`	はい

集計パイプライン

集計コマンド

command	サポートされています
`aggregate`	はい
`count`	はい
`distinct`	はい
`mapReduce`	いいえ

集計ステージ

command	サポートされています
`addFields`	はい
`bucket`	いいえ
`bucketAuto`	いいえ
`changeStream`	はい
`collStats`	いいえ
`count`	はい
`currentOp`	いいえ
`facet`	はい
`geoNear`	はい
`graphLookup`	はい
`group`	はい
`indexStats`	いいえ
`limit`	はい
`listLocalSessions`	いいえ
`listSessions`	いいえ
`lookup`	Partial
`match`	はい
`out`	はい
`project`	はい
`redact`	はい
`replaceRoot`	はい
`replaceWith`	いいえ
`sample`	はい
`skip`	はい
`sort`	はい
`sortByCount`	はい
`unwind`	はい

注意

$lookup では、サーバーバージョン3.6 で導入された非相関サブクエリ機能をまだサポートしていません。 let および pipeline フィールドで $lookup 演算子を使用しようとすると、let is not supported という文字列を含むメッセージが表示されエラーが発生します。

ブール式

command	サポートされています
`and`	はい
`not`	はい
`or`	はい

型変換式

command	サポートされています
`convert`	はい
`toBool`	はい
`toDate`	はい
`toDecimal`	はい
`toDouble`	はい
`toInt`	はい
`toLong`	はい
`toObjectId`	はい
`toString`	はい

設定式

command	サポートされています
`setEquals`	はい
`setIntersection`	はい
`setUnion`	はい
`setDifference`	はい
`setIsSubset`	はい
`anyElementTrue`	はい
`allElementsTrue`	はい

比較式

注意

MongoDB 用 API では、クエリ内で配列リテラルを使用した比較式はサポートされていません。

command	サポートされています
`cmp`	はい
`eq`	はい
`gt`	はい
`gte`	はい
`lt`	はい
`lte`	はい
`ne`	はい
`in`	はい
`nin`	はい

算術式

command	サポートされています
`abs`	はい
`add`	はい
`ceil`	はい
`divide`	はい
`exp`	はい
`floor`	はい
`ln`	はい
`log`	はい
`log10`	はい
`mod`	はい
`multiply`	はい
`pow`	はい
`sqrt`	はい
`subtract`	はい
`trunc`	はい

文字列式

command	サポートされています
`concat`	はい
`indexOfBytes`	はい
`indexOfCP`	はい
`ltrim`	はい
`rtrim`	はい
`trim`	はい
`split`	はい
`strLenBytes`	はい
`strLenCP`	はい
`strcasecmp`	はい
`substr`	はい
`substrBytes`	はい
`substrCP`	はい
`toLower`	はい
`toUpper`	はい

テキスト検索演算子

command	サポートされています
`meta`	いいえ

配列式

command	サポートされています
`arrayElemAt`	はい
`arrayToObject`	はい
`concatArrays`	はい
`filter`	はい
`indexOfArray`	はい
`isArray`	はい
`objectToArray`	はい
`range`	はい
`reverseArray`	はい
`reduce`	はい
`size`	はい
`slice`	はい
`zip`	はい
`in`	はい

変数演算子

command	サポートされています
`map`	はい
`let`	はい

システム変数

command	サポートされています
`$$CURRENT`	はい
`$$DESCEND`	はい
`$$KEEP`	はい
`$$PRUNE`	はい
`$$REMOVE`	はい
`$$ROOT`	はい

リテラル演算子

command	サポートされています
`literal`	はい

日付式

command	サポートされています
`dayOfYear`	はい
`dayOfMonth`	はい
`dayOfWeek`	はい
`year`	はい
`month`	はい
`week`	はい
`hour`	はい
`minute`	はい
`second`	はい
`millisecond`	はい
`dateToString`	はい
`isoDayOfWeek`	はい
`isoWeek`	はい
`dateFromParts`	はい
`dateToParts`	はい
`dateFromString`	はい
`isoWeekYear`	はい

条件式

command	サポートされています
`cond`	はい
`ifNull`	はい
`switch`	はい

データ型演算子

command	サポートされています
`type`	はい

アキュムレータ式

command	サポートされています
`sum`	はい
`avg`	はい
`first`	はい
`last`	はい
`max`	はい
`min`	はい
`push`	はい
`addToSet`	はい
`stdDevPop`	はい
`stdDevSamp`	はい

マージ演算子

command	サポートされています
`mergeObjects`	はい

データ型

Azure Cosmos DB for MongoDB では、MongoDB BSON 形式でエンコードされたドキュメントをサポートしています。 4\.0 API バージョンでは、この形式の内部使用が強化され、パフォーマンスを向上し、コストを削減します。 4.0 以降を実行しているエンドポイントで作成または更新されたドキュメントは、最適化によってメリットが得られます。

アップグレードシナリオでは、バージョン 4.0 以降へのアップグレードの前に作成されたドキュメントでは、4.0 以降のエンドポイント経由の書き込み操作によって更新されるまで、強化されたパフォーマンスのメリットは得られません。

16 MB のドキュメントサポートでは、ドキュメントのサイズ制限が 2 MB から 16 MB に引き上げられます。この制限は、この機能が有効になった後に作成されたコレクションにのみ適用されます。この機能がデータベースアカウントに対して有効になると、無効にすることはできません。

16 MB は、Azure portal の [機能] タブで有効にすることも、"EnableMongo16MBDocumentSupport" 機能を追加してプログラムで有効にすることもできます。

より大きなドキュメントを含む要求が成功するように、サーバー側の再試行を有効にし、ワイルドカードインデックスを使用しないことをお勧めします。必要に応じて、DB/コレクション RU を増やすこともパフォーマンスに役立ちます。

コマンド	サポートされています
`Double`	はい
`String`	はい
`Object`	はい
`Array`	はい
`Binary Data`	はい
`ObjectId`	はい
`Boolean`	はい
`Date`	はい
`Null`	はい
`32-bit Integer (int)`	はい
`Timestamp`	はい
`64-bit Integer (long)`	はい
`MinKey`	はい
`MaxKey`	はい
`Decimal128`	はい
`Regular Expression`	はい
`JavaScript`	はい
`JavaScript (with scope)`	はい
`Undefined`	はい

インデックスとそのプロパティ

インデックス

command	サポートされています
`Single Field Index`	はい
`Compound Index`	はい
`Multikey Index`	はい
`Text Index`	いいえ
`2dsphere`	はい
`2d Index`	いいえ
`Hashed Index`	いいえ

インデックスのプロパティ

command	サポートされています
`TTL`	はい
`Unique`	はい
`Partial`	いいえ
`Case Insensitive`	いいえ
`Sparse`	いいえ
`Background`	はい

オペレーター

論理演算子

command	サポートされています
`or`	はい
`and`	はい
`not`	はい
`nor`	はい

要素演算子

command	サポートされています
`exists`	はい
`type`	はい

評価クエリ演算子

command	サポートされています
`expr`	はい
`jsonSchema`	いいえ
`mod`	はい
`regex`	はい
`text`	いいえ (サポートされていません。$regex を使用してください)
`where`	いいえ

$regex クエリでは、左固定の式でインデックス検索が可能です。ただし、'i' 修飾子 (大文字と小文字の区別なし) や 'm' 修飾子 (複数行) を使用すると、すべての式でコレクションスキャンが発生します。

'$' または '|' を含める必要がある場合、2 つ (以上) の正規表現クエリを作成することをお勧めします。たとえば、元のクエリとして find({x:{$regex: /^abc$/}) がある場合、次のように変更する必要があります:

find({x:{$regex: /^abc/, x:{$regex:/^abc$/}})

最初の部分では、インデックスを使用して検索を ^abc で始まるドキュメントに制限し、2 番目の部分で入力そのものを照合します。バー演算子 '|' は "or" 関数として機能します。そのためクエリ find({x:{$regex: /^abc |^def/}) は、フィールド 'x' の値が "abc" または "def" で始まるドキュメントに一致します。インデックスを利用するには、find( {$or : [{x: $regex: /^abc/}, {$regex: /^def/}] }) のように、クエリを 2 つの異なるクエリに分割し、$or 演算子で結合することをお勧めします。

配列演算子

command	サポートされています
`all`	はい
`elemMatch`	はい
`size`	はい

コメント演算子

command	サポートされています
`comment`	はい

射影演算子

command	サポートされています
`elemMatch`	はい
`meta`	いいえ
`slice`	はい

更新演算子

フィールド更新演算子

command	サポートされています
`inc`	はい
`mul`	はい
`rename`	はい
`setOnInsert`	はい
`set`	はい
`unset`	はい
`min`	はい
`max`	はい
`currentDate`	はい

配列更新演算子

command	サポートされています
`$`	はい
`$[]`	はい
`$[\<identifier\>]`	はい
`addToSet`	はい
`pop`	はい
`pullAll`	はい
`pull`	はい
`push`	はい
`pushAll`	はい

更新修飾子

command	サポートされています
`each`	はい
`slice`	はい
`sort`	はい
`position`	はい

ビット単位更新演算子

command	サポートされています
`bit`	はい
`bitsAllSet`	いいえ
`bitsAnySet`	いいえ
`bitsAllClear`	いいえ
`bitsAnyClear`	いいえ

地理空間演算子

演算子	サポートされています
`$geoWithin`	はい
`$geoIntersects`	はい
`$near`	はい
`$nearSphere`	はい
`$geometry`	はい
`$minDistance`	はい
`$maxDistance`	はい
`$center`	いいえ
`$centerSphere`	いいえ
`$box`	いいえ
`$polygon`	いいえ

並べ替え操作

MongoDB バージョン 4.0 用 API で findOneAndUpdate 操作を使用すると、単一フィールドと複数フィールドに対する並べ替え操作がサポートされます。以前のワイヤプロトコルでは、複数フィールドに対する並べ替え操作は制限されていました。

インデックス作成

MongoDB 用 API では、複数のフィールドでの並べ替えを有効にし、クエリのパフォーマンスを向上させ、一意性を適用するため、さまざまなインデックスがサポートされています。

GridFS

Azure Cosmos DB では、GridFS と互換性のある Mongo ドライバーを通じて GridFS をサポートしています。

レプリケーション

Cosmos azure DB では、最下位のレイヤーで、自動のネイティブレプリケーションがサポートされています。このロジックは、低待機時間のグローバルなレプリケーションも実現するために拡張されています。 Azure Cosmos DB では、手動のレプリケーションコマンドはサポートされていません。

再試行可能書き込み

再試行可能書き込みを使用すると、MongoDB ドライバーは障害発生時に特定の書き込み操作を自動的に再試行できますが、その結果、特定の操作について要件がさらに厳しくなり、MongoDB プロトコル要件に一致します。この機能を有効にすると、シャード化されたコレクションでの削除を含む更新操作では、シャードキーをクエリフィルターまたは更新ステートメントに含める必要があります。

たとえば、キー "country" でシャード化されたシャードコレクションがあるとします。再試行可能書き込みが有効になっている場合、city = "NYC" というフィールドがあるすべてのドキュメントを削除するために、アプリケーションはすべてのシャードキー (country) の値に対して操作を実行する必要があります。

db.coll.deleteMany({"country": "USA", "city": "NYC"}) - 成功
db.coll.deleteMany({"city": "NYC"}) - ShardKeyNotFound(61) エラーで失敗

注意

再試行可能な書き込みは現在、順序付けられていない式の一括書き込みをサポートしていません。再試行可能な書き込みを有効にして一括書き込みを実行する場合は、順序付けられた式の一括書き込みを実行します。

この機能を有効にするには、データベースアカウントに EnableMongoRetryableWrites 機能を追加します。また、Microsoft Azure portal の [機能] タブを使用してこの機能を有効にすることもできます。

シャーディング

Azure Cosmos DB は、自動のサーバー側シャーディングをサポートしています。シャードの作成、配置、バランシングが自動的に管理されます。 Azure Cosmos DB では、手動のシャーディングコマンドはサポートされていません。つまり、addShard、balancerStart、moveChunk などのコマンドを呼び出す必要はありません。必要なのは、コンテナーの作成時やデータの照会時にシャードキーを指定することだけです。

セッション

Azure Cosmos DB では、サーバー側のセッションコマンドはまだサポートされていません。

Time-to-live (TTL)

Azure Cosmos DB では、ドキュメントのタイムスタンプに基づく Time-to-live (TTL) がサポートされます。コレクションに対して TTL を有効にするには、Azure portal を使用します。

トランザクション

シャード化されていないコレクション内でマルチドキュメントトランザクションがサポートされています。マルチドキュメントトランザクションは、コレクションまたはシャードコレクションではサポートされていません。トランザクションのタイムアウトは 5 秒に固定されています。

ユーザーとロールの管理

Azure Cosmos DB では、ユーザーとロールはまだサポートされていません。ただし、Azure Cosmos DB では、Azure ロールベースのアクセス制御 (Azure RBAC) と、Azure portal ([接続文字列] ページ) から取得できる読み取り/書き込みおよび読み取り専用のパスワードとキーがサポートされています。

書き込み確認

一部のアプリケーションでは、書き込み操作中に必要な応答数を指定する書き込み確認が利用されています。 Azure Cosmos DB が背景でレプリケーションを処理する方法により、すべての書き込みが既定で自動的に Quorum になります。クライアントコードによって指定される書き込み確認はすべて無視されます。詳細については、整合性レベルを使用して可用性とパフォーマンスを最大化する方法に関するページを参照してください。

次のステップ

Azure Cosmos DB for MongoDB と共に Studio 3T を使用する方法を学習します。
Azure Cosmos DB for MongoDB と共に Robo 3T を使用する方法を学習します。
Azure Cosmos DB for MongoDBと共に MongoDB のサンプルを確認します。
Azure Cosmos DB への移行のための容量計画を実行しようとしていますか? 容量計画のために、既存のデータベースクラスターに関する情報を使用できます。
- 既存のデータベースクラスター内の仮想コアとサーバーの数のみがわかっている場合は、仮想コアまたは vCPU を使用した要求ユニットの見積もりに関するページを参照してください
- 現在のデータベースワークロードに対する通常の要求レートがわかっている場合は、Azure Cosmos DB Capacity Planner を使用した要求ユニットの見積もりに関するページを参照してください

Azure Cosmos DB for MongoDB (4.0 サーバー バージョン): サポートされる機能と構文