`mongosh` メソッド

項目一覧

Atlas Search インデックスメソッド

Atlas Stream Processing メソッド
コレクション
Cursor
Database
クエリプランキャッシュ
一括書き込み操作
ユーザー管理
ロールマネジメント
複製
シャーディング
コンストラクター
接続
クライアントサイドのフィールドレベル暗号化

注意

MongoDB の JavaScript

これらのメソッドは JavaScript を使用しますが、MongoDB とのほとんどのやり取りでは JavaScript は使用されず、やり取りするアプリケーションの言語の慣用的なドライバーが使用されます。

注意

構文や例など、特定のメソッドの詳細については、「メソッドの参照ページ」へのリンクをクリックしてください。

Atlas Search インデックスメソッド

Atlas Search インデックスを使用すると、Atlas Search 内のデータをクエリできます。Atlas Search インデックスは、検索タームを含むドキュメントにタームをマッピングすることで、テキスト検索クエリの効率を高めます。

次の方法を使用して、Atlas Search インデックスを管理します。

重要

次のメソッドは、MongoDB Atlas でホストされている配置でのみ実行でき、少なくとも M10 の Atlas クラスター階層が必要です。

名前	説明
`db.collection.createSearchIndex()`	指定されたコレクションに Atlas Search インデックスを作成します。
`db.collection.dropSearchIndex()`	既存の Atlas Search インデックスを削除します。
`db.collection.getSearchIndexes()`	指定されたコレクションの既存の Atlas Search インデックスに関する情報を返します。
`db.collection.updateSearchIndex()`	既存の Atlas Search インデックスをアップデートします。

Atlas Stream Processing メソッド

Atlas Stream プロセッサを使用すると、保存データで使用するのと同じデータモデルとクエリ API を使用して、連続データのストリームに対して集計操作を実行できます。

ストリームプロセッサを管理するには、次のメソッドを使用します。

重要

以下のメソッドは、MongoDB Atlas でホストされている配置でのみ実行できます。

名前	説明
`sp.createStreamProcessor()`	ストリームプロセッサを作成します。
`sp.listConnections()`	現在のストリームプロセシングインスタンスの接続レジストリにある既存の接続をすべて一覧表示します。
`sp.listStreamProcessors()`	現在のストリームプロセシングインスタンスに存在するすべてのストリームプロセッサを一覧表示します。
`sp.process()`	エフェメラルストリームプロセッサを作成します。
`sp.processor.drop()`	既存のストリームプロセッサを削除します。
`sp.processor.sample()`	現在実行中のストリームプロセッサからサンプル結果の配列を返します。
`sp.processor.start()`	既存のストリームプロセッサを起動します。
`sp.processor.stats()`	既存のストリームプロセッサを要約する統計を返します。
`sp.processor.stop()`	現在実行中のストリームプロセッサを停止します。

コレクション

名前	説明
`db.collection.analyzeShardKey()`	シャードキーを評価するためのメトリクスを計算します。
`db.collection.aggregate()`	集計パイプラインへのアクセス権を提供します。
`db.collection.bulkWrite()`	一括書き込み操作機能を提供します。
`db.collection.compactStructuredEncryptionData()`	成功または失敗のオブジェクトを返すには、`compactStructuredEncryptionData` をラップします。
`db.collection.configureQueryAnalyzer()`	コレクションのクエリサンプリングを構成します。
`db.collection.count()`	コレクションまたはビュー内のドキュメントの数を返すには、`count` をラップします。
`db.collection.countDocuments()`	コレクションまたはビュー内のドキュメントの数を返すには、`$group` 集計ステージを `$sum` 式でラップします。
`db.collection.createIndex()`	コレクションにインデックスを構築します。
`db.collection.createIndexes()`	コレクションに 1 つ以上のインデックスを構築します。
`db.collection.dataSize()`	コレクションのサイズを返します。`collStats` の出力で `size` フィールドをラップします。
`db.collection.deleteOne()`	コレクション内の 1 つのドキュメントを削除します。
`db.collection.deleteMany()`	コレクション内の複数のドキュメントを削除します。
`db.collection.distinct()`	指定されたフィールドに対して異なる値を持つドキュメントの範囲を返します。
`db.collection.drop()`	指定したコレクションをデータベースから排除します。
`db.collection.dropIndex()`	コレクションの指定されたインデックスを削除します。
`db.collection.dropIndexes()`	コレクションのすべてのインデックスを削除します。
`db.collection.ensureIndex()`	削除されました。`db.collection.createIndex()` を使用してください。
`db.collection.estimatedDocumentCount()`	コレクションまたはビュー内のドキュメントのおおよその数を返すには、`count` をラップします。
`db.collection.explain()`	さまざまなメソッドのクエリ実行についての情報を返します。
`db.collection.find()`	コレクションまたはビューに対してクエリを実行し、カーソルオブジェクトを返します。
`db.collection.findAndModify()`	アトミックに修正して 1 つのドキュメントを返します。
`db.collection.findOne()`	クエリを実行し、1 つのドキュメントを返します。
`db.collection.findOneAndDelete()`	1 つのドキュメントを検索して削除します。
`db.collection.findOneAndReplace()`	1 つのドキュメントを検索して置き換えます。
`db.collection.findOneAndUpdate()`	1 つのドキュメントを検索してアップデートします。
`db.collection.getIndexes()`	コレクションの既存のインデックスを記述するドキュメントの配列を返します。
`db.collection.getShardDistribution()`	シャーディングされたクラスター内のコレクションの場合、`db.collection.getShardDistribution()` はチャンク分散のデータを報告します。
`db.collection.getShardVersion()`	シャーディングされたクラスターの内部診断方法。
`db.collection.hideIndex()`	クエリプランナーでインデックスを非表示にします。
`db.collection.insertOne()`	コレクションに新しいドキュメントを挿入します。
`db.collection.insertMany()`	コレクションに複数の新しいドキュメントを挿入します。
`db.collection.isCapped()`	コレクションが上限付きコレクションかどうかを報告します。
`db.collection.latencyStats()`	コレクションのレイテンシ統計を返します。
`db.collection.mapReduce()`	map-reduce スタイルのデータ集計を実行します。
`db.collection.reIndex()`	コレクションのすべての既存のインデックスを再構築します。
`db.collection.remove()`	コレクションからドキュメントを削除します。
`db.collection.renameCollection()`	コレクションの名前を変更します。
`db.collection.replaceOne()`	コレクションの 1 つのドキュメントを置き換えます。
`db.collection.stats()`	コレクションの状態を報告します。`collStats` を囲むラッパーを提供します。
`db.collection.storageSize()`	コレクションで使用される合計サイズをバイト単位で報告します。`collStats` 出力の `storageSize` フィールドを囲むラッパーを提供します。
`db.collection.totalIndexSize()`	コレクションのインデックスによって使用される合計サイズを報告します。`collStats` 出力の `totalIndexSize` フィールドを囲むラッパーを提供します。
`db.collection.totalSize()`	コレクション内のすべてのドキュメントとすべてのインデックスのサイズを含む、コレクションの合計サイズを報告します。
`db.collection.unhideIndex()`	クエリプランナーからインデックスを再表示します。
`db.collection.updateOne()`	コレクションの 1 つのドキュメントを変更します。
`db.collection.updateMany()`	コレクションの複数のドキュメントを変更します。
`db.collection.watch()`	コレクションに変更ストリームを確立します。
`db.collection.validate()`	コレクションに対して診断操作を実行します。

Cursor

名前	説明
`cursor.addOption()`	クエリの動作を変更する特別なワイヤプロトコルフラグを追加します。
`cursor.allowDiskUse()`	MongoDB ではブロッキングソート操作の処理中にディスクの一時ファイルを使用して 100 メガバイトのシステムメモリ制限を超えるデータを保存できるようになります。
`cursor.allowPartialResults()`	シャーディングされたコレクションに対する `db.collection.find()` 操作では、クエリされたシャードが 1 つ以上利用できない場合に、エラーではなく部分的な結果を返すことができます。
`cursor.batchSize()`	MongoDB が単一のネットワークメッセージでクライアントに返すドキュメントの数を制御します。
`cursor.close()`	カーソルを閉じて、関連付けられているサーバーリソースを解放します。
`cursor.isClosed()`	カーソルが閉じている場合は `true` を返します。
`cursor.collation()`	`db.collection.find()` によって返されるカーソルの照合を指定します。
`cursor.comment()`	ログおよび system.profile コレクションのトレーサビリティを確保できるように、クエリにコメントを付けます。
`cursor.count()`	カーソルがドキュメントそのものではなく、結果セット内のドキュメント数を返すように変更します。
`cursor.explain()`	カーソルのクエリ実行プランについて報告します。
`cursor.forEach()`	カーソル内のすべてのドキュメントに JavaScript 関数を適用します。
`cursor.hasNext()`	カーソルにドキュメントがあり、反復処理できる場合は true を返します。
`cursor.hint()`	MongoDB がクエリに特定のインデックスを使用するように強制します。
`cursor.isExhausted()`	カーソルが閉じており、かつ、バッチにオブジェクトが残っていない場合は `true` を返します。
`cursor.itcount()`	結果セットを取得して反復処理することにより、クライアント側のカーソルにあるドキュメントの総数を計算します。
`cursor.limit()`	カーソルの結果セットのサイズを制限します。
`cursor.map()`	カーソル内の各ドキュメントに関数を適用し、戻り値を配列に収集します。
`cursor.max()`	カーソルに対して限定的な上位インデックスの限界を指定します。使用用途 `cursor.hint()`
`cursor.maxTimeMS()`	カーソルに対する情報処理操作の累積時間制限をミリ秒単位で指定します。
`cursor.min()`	カーソルに対して限定しない下位インデックスの限界を指定します。使用用途 `cursor.hint()`
`cursor.next()`	カーソル内の次のドキュメントを返します。
`cursor.noCursorTimeout()`	非アクティブな状態が一定期間続いた後、カーソルを自動的に閉じないようサーバーへ指示します。
`cursor.objsLeftInBatch()`	現在のカーソルバッチに残っているドキュメントの数を返します。
`cursor.pretty()`	結果を読みやすい形式で表示するようカーソルを設定します。
`cursor.readConcern()`	`find()`操作の読み取り保証（read concern）を指定します。
`cursor.readPref()`	カーソルに読み込み設定（read preference）を指定して、クライアントがレプリカセットにクエリを送信する方法を制御します。
`cursor.returnKey()`	カーソルを変更して、ドキュメントではなくインデックスキーを返します。
`cursor.showRecordId()`	カーソルによって返される各ドキュメントに内部 storage engine ID フィールドを追加します。
`cursor.size()`	`skip()`および`limit()`メソッドを適用した後、カーソル内のドキュメントの数を返します。
`cursor.skip()`	一定数のドキュメントを渡したりスキップした後にのみ結果を返し始めるカーソルを返します。
`cursor.sort()`	ソート指定に従って順序付けられた結果を返します。
`cursor.tailable()`	カーソルを末尾可能としてマークします。上限付きコレクションのカーソルに対してのみ有効です。
`cursor.toArray()`	カーソルによって返されたすべてのドキュメントを含む配列を返します。

Database

名前	説明
`db.adminCommand()`	`admin` データベースに対してコマンドを実行します。
`db.aggregate()`	基礎のコレクションを必要としない管理および診断パイプラインを実行します。
`db.commandHelp()`	データベースコマンドのヘルプ情報を返します。
`db.createCollection()`	新しいコレクションまたはビューを作成します。一般的に、上限付きコレクションを作成するために使用されます。
`db.createView()`	ビューを作成します。
`db.currentOp()`	現在進行中の操作を報告します。
`db.dropDatabase()`	現在のデータベースを削除します。
`db.fsyncLock()`	データベースをロックして書き込み操作を防ぎ、バックアップ操作を支援するには、ディスクへの書き込みをフラッシュします。`fsync` をラップします。
`db.fsyncUnlock()`	`db.fsyncLock()` でロックされたデータベースへの書き込みを続行できるようにします。
`db.getCollection()`	コレクションまたはビューオブジェクトを返します。`mongosh` で有効でない名前を持つコレクションへのアクセスに使用されます。
`db.getCollectionInfos()`	現在のデータベース内のすべてのコレクションとビューのコレクション情報を返します。
`db.getCollectionNames()`	現在のデータベース内のすべてのコレクションとビューを一覧表示します。
`db.getLogComponents()`	ログメッセージの冗長レベルを返します。
`db.getMongo()`	現在の接続の `Mongo()` 接続オブジェクトを返します。
`db.getName()`	現在のデータベースの名前を返します。
`db.getProfilingStatus()`	現在のプロファイリングレベルとプロファイリングしきい値を反映するドキュメントを返します。
`db.getReplicationInfo()`	レプリケーション統計を含むドキュメントを返します。
`db.getSiblingDB()`	指定されたデータベースへのアクセス権を提供します。
`db.hello()`	レプリカセットの状態を報告するドキュメントを返します。
`db.help()`	一般的な `db` オブジェクトのメソッドの説明を表示します。
`db.hostInfo()`	MongoDB が動作するシステムについての情報をドキュメントで返します。ラップ `hostInfo`
`db.killOp()`	指定された操作を終了します。
`db.listCommands()`	一般的なデータベースコマンドの一覧を表示します。
`db.logout()`	非推奨。認証されたセッションを終了します。
`db.printCollectionStats()`	すべてのコレクションから統計を出力します。`db.collection.stats()` をラップします。
`db.printReplicationInfo()`	プライマリから見たレプリカセットの状態のレポートを出力します。
`db.printSecondaryReplicationInfo()`	セカンダリから見たレプリカセットの状態を出力します。
`db.printShardingStatus()`	シャーディングの構成とチャンクの範囲のレポートを出力します。
`db.resetError()`	MongoDB 5.0 で削除されました。最後のエラーステータスをリセットします。
`db.rotateCertificates()`	オンライン TLS 証明書ローテーションを実行します。`rotateCertificates` をラップします。
`db.runCommand()`	データベースコマンドを実行します。
`db.serverBuildInfo()`	`mongod` インスタンスのコンパイルパラメーターを表示するドキュメントを返します。`buildInfo` をラップします。
`db.serverCmdLineOpts()`	MongoDB インスタンスの起動に使用されたランタイムについての情報をドキュメントで返します。`getCmdLineOpts` をラップします。
`db.serverStatus()`	データベースプロセスの状態の概要を示すドキュメントを返します。
`db.setLogLevel()`	1 つのログメッセージの冗長レベルを設定します。
`db.setProfilingLevel()`	データベースプロファイリングの現在のレベルを変更します。
`db.shutdownServer()`	現在の `mongod` または `mongos` プロセスを正常かつ安全にシャットダウンします。
`db.stats()`	現在のデータベースの状態を報告するドキュメントを返します。
`db.version()`	`mongod` インスタンスのバージョンを返します。
`db.watch()`	データベースの変更ストリームカーソルを開き、`system` 以外のすべてのコレクションについてレポートします。`admin`、`local`、または `config` データベースでは開くことができません。

クエリプランキャッシュ

名前	説明
`db.collection.getPlanCache()`	コレクションのクエリプランキャッシュオブジェクトと関連する PlanCache メソッドにアクセスするためのインターフェースを返します。
`PlanCache.clear()`	コレクションのすべてのキャッシュされたクエリプランをクリアします。特定のコレクションのプランキャッシュオブジェクト（`db.collection.getPlanCache().clear()`）を通じてアクセスできます。
`PlanCache.clearPlansByQuery()`	指定されたクエリシェイプのキャッシュされたクエリプランをクリアします。特定のコレクションのプランキャッシュオブジェクトを通じてアクセスできます。 `db.collection.getPlanCache().clearPlansByQuery()`
`PlanCache.help()`	コレクションのクエリプランキャッシュに使用できるメソッドを表示します。特定のコレクションのプランキャッシュオブジェクト（`db.collection.getPlanCache().help()`）を通じてアクセスできます。
`PlanCache.list()`	コレクションのプランキャッシュ情報を返します。特定のコレクションのプランキャッシュオブジェクト（`db.collection.getPlanCache().list()`）を通じてアクセスできます。

一括書き込み操作

名前	説明
`db.collection.initializeOrderedBulkOp()`	順序付けられた操作リストの `Bulk()` 操作ビルダを初期化します。
`db.collection.initializeUnorderedBulkOp()`	順序付けられていない操作リストの `Bulk()` 操作ビルダを初期化します。
`Bulk()`	一括操作ビルダ。
`Bulk.execute()`	操作リストを一括で実行します。
`Bulk.find()`	アップデート操作または削除操作のクエリ条件を指定します。
`Bulk.find.arrayFilters()`	`update` 操作または `updateOne` 操作で更新する配列の要素を決定するフィルターを指定します。
`Bulk.find.collation()`	クエリ条件の照合を指定します。
`Bulk.find.delete()`	複数のドキュメントの削除操作を操作リストに追加します。
`Bulk.find.deleteOne()`	1 つのドキュメントの削除操作を操作リストに追加します。
`Bulk.find.hint()`	更新操作または置換操作に使用するインデックスを指定します。
`Bulk.find.remove()`	`Bulk.find.delete()` のエイリアス。
`Bulk.find.removeOne()`	`Bulk.find.deleteOne()` のエイリアス。
`Bulk.find.replaceOne()`	1 つのドキュメントの置換操作を操作リストに追加します。
`Bulk.find.updateOne()`	1 つのドキュメントのアップデート操作を操作リストに追加します。
`Bulk.find.update()`	`multi` のアップデート操作を操作リストに追加します。
`Bulk.find.upsert()`	アップデート操作の `upsert: true` を指定します。
`Bulk.getOperations()`	`Bulk()` 操作オブジェクトで実行された書き込み操作の配列を返します。
`Bulk.insert()`	挿入オペレーションを操作リストに追加します。
`Bulk.toJSON()`	`Bulk()` 操作オブジェクト内の操作およびバッチの数を含む JSON document を返します。
`Bulk.toString()`	`Bulk.toJSON()` 結果を文字列として返します。

ユーザー管理

名前	説明
`db.auth()`	データベースに対してユーザーを認証します。
`db.changeUserPassword()`	既存のユーザーのパスワードを変更します。
`db.createUser()`	新規ユーザーを作成します。
`db.dropUser()`	ユーザーを 1 人削除します。
`db.dropAllUsers()`	データベースに関連付けられているすべてのユーザーを削除します。
`db.getUser()`	指定されたユーザーに関する情報を返します。
`db.getUsers()`	データベースに関連付けられているすべてのユーザーに関する情報を返します。
`db.grantRolesToUser()`	ロールとその権限をユーザーに付与します。
`db.removeUser()`	非推奨。データベースからユーザーを削除します。
`db.revokeRolesFromUser()`	ユーザーからロールを削除します。
`db.updateUser()`	ユーザーデータをアップデートします。
`passwordPrompt()`	`mongosh` のさまざまなユーザー認証および管理方法でパスワードを直接指定する代わりに、パスワードの入力を要求します。

ロールマネジメント

名前	説明
`db.createRole()`	ロールを作成し、その権限を指定します。
`db.dropRole()`	ユーザー定義のロールを削除します。
`db.dropAllRoles()`	データベースに関連付けられているすべてのユーザー定義のロールを削除します。
`db.getRole()`	指定されたロールの情報を返します。
`db.getRoles()`	データベース内のすべてのユーザー定義のロールに関する情報を返します。
`db.grantPrivilegesToRole()`	ユーザー定義のロールに権限を割り当てます。
`db.revokePrivilegesFromRole()`	指定した権限をユーザー定義ロールから排除します。
`db.grantRolesToRole()`	ユーザー定義ロールが権限を継承するロールを指定します。
`db.revokeRolesFromRole()`	継承されたロールをロールから削除します。
`db.updateRole()`	ユーザー定義ロールを更新します。

複製

名前	説明
`rs.add()`	レプリカセットにノードを追加します。
`rs.addArb()`	アービタをレプリカセットに追加します。
`rs.conf()`	レプリカセット構成ドキュメントを返します。
`rs.freeze()`	現在のノードは一定期間、プライマリとして選挙を目指すことができません。
`rs.help()`	レプリカセット関数の基本的なヘルプテキストを返します。
`rs.initiate()`	新しいレプリカセットを初期化します。
`rs.printReplicationInfo()`	プライマリから見たレプリカセットの状態を形式化されたレポートで出力します。
`rs.printSecondaryReplicationInfo()`	セカンダリから見たレプリカセットの状態を形式化されたレポートで出力します。
`rs.reconfig()`	新しいレプリカセット構成オブジェクトを適用して、レプリカセットを再構成します。
`rs.remove()`	レプリカセットからノードを削除します。
`rs.status()`	レプリカセットの状態に関する情報をドキュメントで返します。
`rs.stepDown()`	現在のプライマリがセカンダリになり、強制的に選挙が行われます。
`rs.syncFrom()`	このレプリカセットノードが同期する元ノードを設定し、デフォルトの同期ターゲット選択ロジックをオーバーライドします。

シャーディング

名前	説明
`sh.abortReshardCollection()`	再シャーディング操作を中止します。バージョン 5.0 で追加
`sh.addShard()`	シャーディングされたクラスターにシャードを追加します。
`sh.addShardTag()`	このメソッドは`sh.addShardToZone()`のエイリアスになります。
`sh.addShardToZone()`	シャードをゾーンに関連付けます。シャーディングされたクラスター内のゾーンの設定をサポートします。
`sh.addTagRange()`	このメソッドは`sh.updateZoneKeyRange()`のエイリアスになります。
`sh.balancerCollectionStatus()`	シャーディングされたコレクションのチャンクが、バランスが取れているかどうかに関する情報を返します。
`sh.commitReshardCollection()`	再シャーディング操作を強制し、書込みをブロックして完了します。バージョン 5.0 で追加
`sh.disableBalancing()`	シャーディングされたデータベース内の単一のコレクションのバランシングを無効にします。シャーディングされたクラスター内の他のコレクションのバランシングには影響しません。
`sh.enableBalancing()`	以前に `sh.disableBalancing()` を使用して無効にしていた場合、シャーディングされたコレクションバランサープロセスを有効にします。
`sh.disableAutoMerger()`	名前空間のチャンクの自動マージを無効にします。バージョン 7.0 で追加。
`sh.disableAutoSplit()`	シャーディングされたクラスターの自動分割を無効にします。 MongoDB 6.0.3以降、自動チャンク分割は実行されません。これはバランシングポリシーの改善によるものです。自動分割コマンドは引き続き存在しますが、操作は実行されません。
`sh.enableAutoMerger()`	名前空間のチャンクの自動マージを有効にします。バージョン 7.0 で追加。
`sh.enableAutoSplit()`	シャーディングされたクラスターの自動分割を有効にします。 MongoDB 6.0.3以降、自動チャンク分割は実行されません。これはバランシングポリシーの改善によるものです。自動分割コマンドは引き続き存在しますが、操作は実行されません。
`sh.enableSharding()`	データベースを作成します。
`sh.getBalancerState()`	バランサーが現在有効になっているかどうかを報告するブール値を返します。
`sh.getShardedDataDistribution()`	シャーディングされたコレクションのデータ配信情報を返します。`sh.getShardedDataDistribution()` は、`$shardedDataDistribution` 集計パイプラインステージのシェルヘルパーメソッドです。
`sh.removeTagRange()`	このメソッドは`sh.removeRangeFromZone()`のエイリアスになります。
`sh.removeRangeFromZone()`	シャードキーの範囲とゾーンの間の関連付けを削除します。シャーディングされたクラスター内のゾーンの設定をサポートします。
`sh.help()`	`sh` メソッドのヘルプテキストを返します。
`sh.isBalancerRunning()`	バランサーの状態を説明するドキュメントを返します。
`sh.moveChunk()`	シャーディングされたクラスター内のチャンクを移行します。
`sh.removeShardTag()`	このメソッドは`sh.removeShardFromZone()`のエイリアスです。
`sh.removeShardFromZone()`	シャードとゾーンの間の関連付けを削除します。ゾーンシャーディングを管理するために使用します。
`sh.reshardCollection()`	コレクションのシャードキーを変更してデータの分散状況を変えるために、再シャーディング操作を開始します。バージョン 5.0 で追加
`sh.setBalancerState()`	シャード間でチャンクを移行するバランサーを有効または無効にします。
`sh.shardCollection()`	コレクションのシャーディングを有効にします。
`sh.splitAt()`	シャードキーの特定の値を分割点として使用し、既存のチャンクを 2 つに分割します。
`sh.splitFind()`	クエリに一致するドキュメントを含む既存のチャンクを、ほぼ等しい 2 つのチャンクに分割します。
`sh.startAutoMerger()`	AutoMerger を有効にします。バージョン 7.0 で追加。
`sh.startBalancer()`	バランサーを有効にし、バランシングが開始されるのを待ちます。
`sh.status()`	シャーディングされたクラスターの状態を `db.printShardingStatus()` として報告します。
`sh.stopAutoMerger()`	AutoMerger を無効にします。バージョン 7.0 で追加。
`sh.stopBalancer()`	バランサーを無効にし、進行中のバランサーラウンドが完了するのを待ちます。
`sh.waitForBalancer()`	内部。バランサーの状態が変化するのを待ちます。
`sh.waitForBalancerOff()`	内部。バランサーが動作を停止するまで待ちます。
`sh.waitForPingChange()`	内部。シャーディングされたクラスター内のいずれかの `mongos` の ping 状態が変化するの待ちます。
`sh.updateZoneKeyRange()`	シャードキーの範囲をゾーンに関連付けます。シャーディングされたクラスター内のゾーンの設定をサポートします。
`convertShardKeyToHashed()`	入力のハッシュ値を返します。

コンストラクター

名前	説明
`Binary.createFromBase64()`	base64 値からバイナリオブジェクトを作成します。
`Binary.createFromHexString()`	16 進値からバイナリオブジェクトを作成します。
`BinData()`	バイナリデータオブジェクトを返します。
`BulkWriteResult()`	`Bulk.execute()` の結果セットを囲むラッパー。
`Date()`	日付オブジェクトを作成します。デフォルトでは、現在の日付を含む日付オブジェクトが作成されます。
`HexData()`	バイナリデータオブジェクトを返します。
`ObjectId()`	ObjectId を返します。
`ObjectId.createFromBase64()`	base64 値から ObjectId を作成します。
`ObjectId.createFromHexString()`	16 進値から ObjectId を作成します。
`ObjectId.getTimestamp()`	ObjectId のタイムスタンプ部分を返します。
`ObjectId.toString()`	ObjectId の文字列表現を表示します。
UUID()	32 バイトの 16 進文字列を UUID BSON サブタイプに変換します。
`WriteResult()`	書き込みメソッドからの結果セットを囲むラッパー。
`WriteResult.hasWriteError()`	結果に `WriteResult.writeError` が含まれているかどうかを指定するブール値を返します。
`WriteResult.hasWriteConcernError()`	結果に `WriteResult.writeConcernError` が含まれているかどうかを指定するブール値を返します。

接続

名前	説明
connect()	MongoDB インスタンスとそのインスタンス上の指定されたデータベースに接続します。
`Mongo()`	新しい接続オブジェクトを作成します。
`Mongo.getDB()`	データベースオブジェクトを返します。
`Mongo.getReadPrefMode()`	MongoDB 接続の現在の読み込み設定（read preference）モードを返します。
`Mongo.getReadPrefTagSet()`	MongoDB 接続の読み込み設定（read preference）タグセットを返します。
`Mongo.setCausalConsistency()`	接続オブジェクトの因果整合性を有効または無効にします。
`Mongo.setReadPref()`	MongoDB 接続の読み込み設定（read preference）を設定します。
`Mongo.startSession()`	接続オブジェクトでセッションを開始します。
`Mongo.watch()`	配置の変更ストリームカーソルを開き、内部の `admin`、`local`、および `config` データベースを除き、`system` 以外の全データベースにわたるすべてのコレクションについてレポートします。
`Session()`	セッションオブジェクト。
`SessionOptions()`	セッションのオプションオブジェクト。

クライアントサイドのフィールドレベル暗号化

注意

mongosh クライアント側のフィールドレベル暗号化メソッドでは、クライアント側のフィールドレベル暗号化が有効になっているデータベース接続が必要です。現在のデータベース接続がクライアント側のフィールドレベル暗号化を有効にして開始されなかった場合、次のいずれかが発生します。

Mongo()必要なクライアント側のフィールドレベル暗号化オプションとの接続を確立するには、mongosh からコンストラクターを使用します。Mongo()メソッドは、CMK（Customer Master Key）管理のために次のKMS （ KMS ）プロバイダーをサポートしています。
or
必要なオプションとの接続を確立するには、 mongoshコマンドラインオプションを使用します。コマンドラインオプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。

名前	説明
`getKeyVault()`	現在の MongoDB 接続のキーヴォールトオブジェクトを返します。
`KeyVault.createDataKey()`	`KeyVault.createKey()` のエイリアス。
`KeyVault.createKey()`	クライアント側のフィールドレベル暗号化で使用するデータ暗号化キーを作成します。
`KeyVault.deleteKey()`	指定されたデータ暗号化キーをキーヴォールトから削除します。
`KeyVault.getKey()`	指定されたデータ暗号化キーをキーヴォールトで検索します。
`KeyVault.getKeys()`	キーヴォールト内のすべてのキーを検索します。
`KeyVault.addKeyAlternateName()`	指定されたデータ暗号化キーに、キーの別名を関連付けます。
`KeyVault.addKeyAltName()`	`KeyVault.addKeyAlternateName()` のエイリアス。
`KeyVault.removeKeyAlternateName()`	指定されたデータ暗号化キーからキーの別名を削除します。
`KeyVault.removeKeyAltName()`	`KeyVault.removeKeyAlternateName()` のエイリアス。
`KeyVault.getKeyByAltName()`	指定されたキーの別名を持つキーを検索します。
`KeyVault.rewrapManyDataKey()`	複数のデータキーを復号化し、再暗号化します。
`getClientEncryption()`	フィールドの明示的な暗号化および復号化をサポートするためのクライアント暗号化オブジェクトを返します。
`ClientEncryption.createEncryptedCollection()`	暗号化されたフィールドを持つコレクションを作成します。
`ClientEncryption.encrypt()`	指定されたデータ暗号化キーと暗号化アルゴリズムを使ってフィールドを暗号化します。
`ClientEncryption.decrypt()`	関連付けられたデータ暗号化キーと暗号化アルゴリズムを使ってフィールドを復号化します。

戻る

レガシー命令コード

ネイティブメソッド

注意