AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

$querySettings(集計ステージ)

$querySettings

バージョン8.0の新機能。

以前にsetQuerySettingsで追加されたクエリ設定を返します。 設定はクラスター全体に適用されます。 クラスターはシャットダウン後も設定を保持します。

このコマンドは、次の環境でホストされている配置で使用できます。

  • MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

重要

このコマンドは、M0 および Flex クラスターではサポートされていません。詳細については、「 サポートされていないコマンド 」を参照してください。

  • MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

  • MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

You can only add query settings on a replica set or sharded cluster. setQuerySettings doesn't run on a standalone mongod instance. To use query settings in a test environment, deploy a replica set. To learn how, see Deploy a Self-Managed Replica Set for Testing and Development.

複数のパイプライン ステージを使用する場合は、パイプラインの最初に$querySettingsを配置します。

db.aggregate( [ { $querySettings: { showDebugQueryShape: <boolean> } }, // Add any additional pipeline stages after $querySettings ...] )

$querySettings このフィールドは、次のフィールドがあります。

フィールド
タイプ
必要性
説明

showDebugQueryShape

ブール値

任意

trueの場合、 $querySettingsはクエリシェイプ出力のデバッグ バージョンを返します。 次のセクションで例を示します。 出力の詳細については、「クエリシェイプ 」を参照してください。

デフォルトは、false に設定されています。

次の例では、コレクションを作成し、クエリ設定を追加して、設定を返します。

1

実行:

// Create pizzaOrders collectiondb.pizzaOrders.insertMany( [ { _id: 0, type: "pepperoni", totalNumber: 5, orderDate: new Date( "2024-01-15T12:00:00Z" ) }, { _id: 1, type: "cheese", totalNumber: 15, orderDate: new Date( "2024-01-23T11:12:32Z" ) }, { _id: 2, type: "vegan", totalNumber: 20, orderDate: new Date( "2024-03-20T10:01:12Z" ) }] ) // Create ascending index on orderDate fielddb.pizzaOrders.createIndex( { orderDate: 1 } ) // Create ascending index on totalNumber fielddb.pizzaOrders.createIndex( { totalNumber: 1 } )

インデックスのデフォルト名はorderDate_1とtotalNumber_1です。

2

次のsetQuerySettingsの例では、クエリ設定を追加します。

db.adminCommand( { setQuerySettings: { find: "pizzaOrders", filter: { orderDate: { $gt: ISODate( "2024-01-20T00:00:00Z" ) } }, sort: { totalNumber: 1 }, $db: "test" }, settings: { indexHints: { ns: { db: "test", coll: "pizzaOrders" }, allowedIndexes: [ "orderDate_1" ] }, queryFramework: "classic", comment: "Index hint for orderDate_1 index to improve query performance" }} )

commentフィールドはMongoDB 8.0.4 以降で使用可能です。

3

次の例では、集計パイプラインの$querySettingsステージを使用してクエリ設定を返します。

db.aggregate( [ { $querySettings: { showDebugQueryShape: true }} ] )

showDebugQueryShapeはtrueであるため、 debugQueryShapeドキュメントが出力に含まれます。 クエリ設定を見つけるには、 queryShapeHash識別子を使用します。 この出力では、 queryShapeHashとdebugQueryShapeが強調表示されています。

[ { queryShapeHash: 'AB8ECADEE8F0EB0F447A30744EB4813AE7E0BFEF523B0870CA10FCBC87F5D8F1', settings: { indexHints: [ { ns: { db: 'test', coll: 'pizzaOrders' }, allowedIndexes: [ 'orderDate_1' ] } ], queryFramework: 'classic', comment: 'Index hint for orderDate_1 index to improve query performance' }, representativeQuery: { find: 'pizzaOrders', filter: { orderDate: { '$gt': ISODate('2023-01-20T00:00:00.000Z') } }, sort: { totalNumber: 1 }, '$db': 'test' }, debugQueryShape: { cmdNs: { db: 'test', coll: 'pizzaOrders' }, command: 'find', filter: { orderDate: { '$gt': '?date' } }, sort: { totalNumber: 1 } } }]