データベースコマンド

項目一覧

コマンド構文

ユーザーコマンド
データベース操作
監査コマンド
Atlas Search コマンド

以下で概説するすべてのコマンドドキュメントには、コマンドとコマンドで使用可能なパラメーターの説明、およびドキュメントテンプレートまたは各コマンドのプロトタイプが提示されています。一部のコマンドのドキュメントには、関連する mongoshヘルパーも含まれています。

現在のデータベースにコマンドを実行するには、db.runCommand() を使用します。

db.runCommand( { <command> } )

admin データベースに対して管理コマンドを実行するには、db.adminCommand() を使用します。

db.adminCommand( { <command> } )

注意

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

コマンド構文

データベースコマンドを実行するときは、コマンドをドキュメントとして db.runCommand() に指定します。ドキュメントのキーは実行用コマンドであり、値は通常 1 として提供されます。この値は、サンプル向けのコマンドの出力には影響しません。

db.runCommand( { hello: 1 } )

ユーザーコマンド

集計コマンド

名前	説明	MongoDB Atlas のサポート
`aggregate`	集計パイプラインを使用して、`$group` などの集計タスクを実行します。	M 0 、M 2 、M 5クラスターの限定的なサポート。
`count`	コレクションまたはビューに含まれるドキュメント数をカウントします。	M 0 、M 2 、M 5クラスターの限定的なサポート。
`distinct`	コレクションまたはビュー内の指定されたキーに対して見つかった個別の値を表示します。	M 0 、M 2 、M 5クラスターの限定的なサポート。
`mapReduce`	大規模なデータセットで map-reduce 集計を実行します。	M 0 、M 2 、M 5クラスターはサポートされていません。

地理空間コマンド

名前	説明	MongoDB Atlas のサポート
`geoSearch`	MongoDB 5.0 で削除されました。MongoDB の haystack インデックス機能を使用して地理空間クエリを実行します。	サーバーレスインスタンスのサポートはありません。

クエリと書込み操作コマンド

名前	説明	MongoDB Atlas のサポート
`bulkWrite`	1 回のリクエストで複数のコレクションに対して多くの挿入、アップデート、削除操作を実行します。バージョン8.0の新機能。	No
`delete`	1 つ以上のドキュメントを削除します。	はい
`find`	コレクションまたはビュー内のドキュメントを選択します。	M 0 、M 2 、M 5クラスターの限定的なサポート。
`findAndModify`	1 つのドキュメントを返して変更します。	はい
`getMore`	現在カーソルでポイントされているドキュメントのバッチを返します。	はい
`insert`	1 つ以上のドキュメントを挿入します。	はい
`resetError`	MongoDB 5.0 で削除されました。最後のエラーステータスをリセットします。	No
`update`	1 つ以上のドキュメントを更新します。	はい

クエリプランキャッシュコマンド

名前	説明	MongoDB Atlas のサポート
`planCacheClear`	コレクションのキャッシュされたクエリプランを削除します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`planCacheClearFilters`	コレクションのインデックスフィルターをクリアします。	M 0 、M 2 、M 5クラスターはサポートされていません。
`planCacheListFilters`	コレクションのインデックスフィルターを一覧表示します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`planCacheSetFilter`	コレクションのインデックスフィルターを設定します。	M 0 、M 2 、M 5クラスターはサポートされていません。

データベース操作

認証コマンド

名前	説明	MongoDB Atlas のサポート
`authenticate`	ユーザー名とパスワードを使用して認証されたセッションを開始します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`logout`	現在認証されているセッションを終了します。	はい

ユーザー管理コマンド

名前	説明	MongoDB Atlas のサポート
`createUser`	新規ユーザーを作成します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`dropAllUsersFromDatabase`	データベースに関連付けられているすべてのユーザーを削除します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`dropUser`	ユーザーを 1 人削除します。	M 10クラスターのサポートはありません。
`grantRolesToUser`	ロールとその権限をユーザーに付与します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`revokeRolesFromUser`	ユーザーからロールを削除します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`updateUser`	ユーザーのデータを更新します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`usersInfo`	指定したユーザーに関する情報を返します。	M 0 、M 2 、M 5クラスターの限定的なサポート。

ロール管理コマンド

名前	説明	MongoDB Atlas のサポート
`createRole`	ロールを作成し、その権限を指定します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`dropRole`	ユーザー定義ロールを削除します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`dropAllRolesFromDatabase`	データベースからすべてのユーザー定義ロールを削除します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`grantPrivilegesToRole`	ユーザー定義のロールに権限を割り当てます。	M 0 、M 2 、M 5クラスターはサポートされていません。
`grantRolesToRole`	ユーザー定義ロールが権限を継承するロールを指定します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`invalidateUserCache`	認証情報やロールなどのユーザー情報のメモリ内キャッシュをフラッシュします。	M 0 、M 2 、M 5クラスターはサポートされていません。
`revokePrivilegesFromRole`	指定した権限をユーザー定義ロールから排除します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`revokeRolesFromRole`	ユーザ定義ロールから指定された継承ロールを削除します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`rolesInfo`	指定したロールの情報を返します。	はい
`updateRole`	ユーザー定義ロールを更新します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。

レプリケーションコマンド

名前	説明	MongoDB Atlas のサポート
`appendOplogNote`	非操作エントリをoplog に書込みます。	M 0 、M 2 、M 5クラスターはサポートされていません。
`applyOps`	現在のデータセットに oplog エントリを適用する内部コマンド。	サーバーレスインスタンスのサポートはありません。
`hello`	レプリカセット内のこのノードのロールに関する情報（プライマリであるかどうかなど）を表示します。	はい
`replSetAbortPrimaryCatchUp`	選択したプライマリに同期（キャッチアップ）の中止を強制してから、プライマリへの移行を完了させます。	はい
`replSetFreeze`	現在のノードが一定期間、プライマリとして選出されることを禁止します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`replSetGetConfig`	レプリカセットの構成オブジェクトを返します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`replSetGetStatus`	レプリカセットの状態を報告するドキュメントを返します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`replSetInitiate`	新しいレプリカセットを初期化します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`replSetMaintenance`	メンテナンスモードを有効または無効にし、セカンダリノードを `RECOVERING` 状態にします。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`replSetReconfig`	既存のレプリカセットに新しい構成を適用します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`replSetResizeOplog`	レプリカセットノードの oplog サイズを動的に変更します。WiredTiger ストレージエンジンでのみ使用できます。	M 10クラスターのサポートはありません。
`replSetStepDown`	現在のプライマリをステップダウンさせてセカンダリにし、選挙を強制します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`replSetSyncFrom`	複製するノードを選択するためのデフォルトロジックを明示的に上書きします。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。

Tip

以下も参照してください。

レプリケーションの詳細については、「レプリケーション」を参照してください。

シャーディングコマンド

名前	説明	MongoDB Atlas のサポート
`abortReshardCollection`	再シャーディング操作を中止します。バージョン 5.0 で追加	はい
`abortMoveCollection`	進行中の `moveCollection` 操作を停止します。バージョン8.0の新機能。	サーバーレスインスタンスと Atlas共有階層はサポートされていません。
`abortUnshardCollection`	進行中の `unshardCollection` 操作を停止します。バージョン8.0の新機能。	サーバーレスインスタンスと Atlas共有階層はサポートされていません。
`addShard`	シャーディングされたクラスターにシャードを追加します。	サーバーレスインスタンスのサポートはありません。
`addShardToZone`	シャードをゾーンに関連付けます。シャーディングされたクラスター内のゾーンの構成をサポートします。	サーバーレスインスタンスのサポートはありません。
`analyzeShardKey`	シャードキーを評価するためのメトリクスを計算します。バージョン 7.0 で追加。	はい
`balancerCollectionStatus`	シャーディングされたコレクションのチャンクが、バランスが取れているかどうかに関する情報を返します。	サーバーレスインスタンスのサポートはありません。
`balancerStart`	バランサースレッドを開始します。	サーバーレスインスタンスのサポートはありません。
`balancerStatus`	バランサーの状態に関する情報を返します。	サーバーレスインスタンスのサポートはありません。
`balancerStop`	バランサースレッドを停止します。	サーバーレスインスタンスのサポートはありません。
`checkMetadataConsistency`	シャーディングメタデータの整合性に関して一連のチェックを実行します。バージョン 7.0 で追加。	はい
`clearJumboFlag`	チャンク用の `jumbo` フラグをクリアします。	サーバーレスインスタンスのサポートはありません。
`cleanupReshardCollection`	失敗した再シャーディング操作をクリーンアップします。バージョン 5.0 で追加	はい
`commitReshardCollection`	再シャーディング操作を強制し、書込みをブロックして完了します。バージョン 5.0 で追加	はい
`configureCollectionBalancing`	シャーディングされたコレクションのバランサー設定を構成します。バージョン 5.3 で追加。	はい
`configureQueryAnalyzer`	コレクションのクエリサンプリングを構成します。バージョン 7.0 で追加。	はい
`enableSharding`	データベースを作成します。	サーバーレスインスタンスのサポートはありません。
`flushRouterConfig`	`mongod` / `mongos` インスタンスにキャッシュされたメタデータの更新を強制します。	サーバーレスインスタンスのサポートはありません。
`getShardMap`	シャーディングされたクラスターの状態を報告する内部コマンド。	M 0 、M 2 、M 5クラスターとサーバーレスインスタンスはサポートされていません。
`isdbgrid`	プロセスが `mongos` であることを確認します。	はい
`listShards`	構成されたシャードの一覧を返します。	サーバーレスインスタンスのサポートはありません。
`moveChunk`	シャード間でチャンクを移行する内部コマンド。	サーバーレスインスタンスのサポートはありません。
`movePrimary`	シャーディングされたクラスターからシャードを削除するときに、プライマリシャードを再割り当てします。	サーバーレスインスタンスのサポートはありません。
`moveRange`	シャード間で範囲を移動します。	はい
`mergeAllChunksOnShard`	シャードが所有する特定コレクションでマージ可能なチャンクをすべてマージします。	サーバーレスインスタンスのサポートはありません。
`mergeChunks`	単一のシャードでチャンクを結合する機能を提供します。	サーバーレスインスタンスのサポートはありません。
`refineCollectionShardKey`	コレクションのシャードキーを調整するために、既存キーにサフィックスを追加します。	M 10クラスターとサーバーレスインスタンスはサポートされていません。
`removeShard`	シャーディングされたクラスターからシャードを削除するプロセスを開始します。	M 10クラスターとサーバーレスインスタンスはサポートされていません。
`removeShardFromZone`	シャードとゾーンの間の関連付けを削除します。シャーディングされたクラスター内のゾーンの構成をサポートします。	サーバーレスインスタンスのサポートはありません。
`reshardCollection`	コレクションのシャードキーを変更してデータの分散状況を変えるために、再シャーディング操作を開始します。バージョン 5.0 で追加	はい
`setAllowMigrations`	コレクションでの新規の自動移行を防止します。	サーバーレスインスタンスのサポートはありません。
`shardCollection`	コレクションのシャーディング機能を有効にし、コレクションをシャーディングできるようにします。	サーバーレスインスタンスのサポートはありません。
`shardingState`	`mongod` がシャーディングされたクラスターのノードであるかどうかを報告します。	はい
`split`	新しいチャンクを作成します。	サーバーレスインスタンスのサポートはありません。
`splitVector`	分割ポイントを決定する内部コマンド。	はい
`transitionFromDedicatedConfigServer`	専用のコンフィギュレーションサーバーをコンフィギュレーションシャードとして実行するように構成します。バージョン8.0の新機能。	サーバーレスインスタンスと Atlas共有階層はサポートされていません。
`transitionToDedicatedConfigServer`	コンフィギュレーションシャードを専用のコンフィギュレーションサーバーとして実行するように構成します。バージョン8.0の新機能。	サーバーレスインスタンスと Atlas共有階層はサポートされていません。
`unsetSharding`	MongoDB 5.0 で削除されました。MongoDB 配置のインスタンス間の接続に影響する内部コマンドです。	はい
`unshardCollection`	既存のシャーディングされたコレクションのシャーディングを解除し、コレクションデータを単一のシャードに移動します。コレクションをシャーディング解除すると、コレクションを複数のシャードに分割できなくなり、シャードキーが削除されます。バージョン8.0の新機能。	はい
`updateZoneKeyRange`	シャーディングされたデータの範囲とゾーンの間の関連付けを追加または削除します。シャーディングされたクラスター内のゾーンの構成をサポートします。	サーバーレスインスタンスのサポートはありません。

Tip

以下も参照してください。

MongoDB のシャーディング機能の詳細については、「シャーディング」を参照してください。

セッションコマンド

コマンド	説明	Atlas サポート
`abortTransaction`	トランザクションを中止します。	はい
`commitTransaction`	トランザクションをコミットします。	はい
`endSessions`	セッションのタイムアウト期間前にセッションを失効させます。	はい
`killAllSessions`	すべてのセッションを強制終了します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`killAllSessionsByPattern`	指定されたパターンに一致するすべてのセッションを強制終了します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`killSessions`	指定したセッションを強制終了します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`refreshSessions`	アイドル状態のセッションを更新します。	はい
`startSession`	新しいセッションを開始します。	はい

管理コマンド

名前	説明	MongoDB Atlas のサポート
`cloneCollectionAsCapped`	上限付きコレクション以外のコレクションを新しい上限付きコレクションとしてコピーします。	M 0 、M 2 、M 5クラスターとサーバーレスインスタンスはサポートされていません。
`collMod`	コレクションにオプションを追加するか、ビュー定義を変更します。	はい
`compact`	コレクションをデフラグし、インデックスを再構築します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`compactStructuredEncryptionData`	状態コレクションで指定されたドキュメントを圧縮し、冗長なドキュメントを削除します。	はい
`convertToCapped`	上限付きコレクション以外のコレクションを上限付きコレクションへ変換します。	サーバーレスインスタンスのサポートはありません。
`create`	コレクションまたはビューを作成します。	はい
`createIndexes`	コレクション向けインデックスを 1 つ以上構築します。	はい
`currentOp`	データベースインスタンスに対して進行中の操作に関する情報を含むドキュメントを返します。	はい
`drop`	指定したコレクションをデータベースから排除します。	はい
`dropDatabase`	現在のデータベースを削除します。	はい
`dropConnections`	指定ホストリストへの送信接続を切断します。	はい
`dropIndexes`	コレクションからインデックスを削除します。	はい
`filemd5`	GridFS を使用して保存されたファイルで md5 ハッシュを返します。	はい
`fsync`	保留中の書込みをストレージレイヤーにフラッシュし、データベースをロックしてバックアップできるようにします。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`fsyncUnlock`	1 つの fsync ロックを解除します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`getDefaultRWConcern`	読み取り保証（read concern）と書込み保証（write concern）のグローバルのデフォルトオプションを配置用に取得します。	はい
`getClusterParameter`	クラスター内のすべてのノードからクラスターパラメータ値を取得します。バージョン 6.0 で追加。	はい
`getParameter`	Retrieves configuration options.	M 0 、M 2 、M 5クラスターの限定的なサポート。
`killCursors`	コレクションの指定カーソルを強制終了します。	はい
`killOp`	操作 ID で指定された操作を終了します。	M 0 、M 2 、M 5 、 M 10クラスターの限定的なサポート。
`listCollections`	現在のデータベース内のコレクションリストを返します。	はい
`listDatabases`	すべてのデータベースを列挙し、基本的データベース統計を返すドキュメントを返します。	はい
`listIndexes`	コレクションのすべてのインデックスを列挙します。	はい
`logRotate`	MongoDB ログをローテーションして、1 つのファイルが専有するスペースが過大になるのを防止します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`reIndex`	コレクションですべてのインデックスを再構築します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`renameCollection`	既存コレクションの名前を変更します。	はい
`rotateCertificates`	オンライン TLS 証明書ローテーションを実行します。	はい
`setFeatureCompatibilityVersion`	下位互換性のないデータを保持する機能を有効または無効にします。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`setIndexCommitQuorum`	データを保持するノード（コミットクォーラム）のうち、プライマリが準備完了とインデックスをマークする前に、進行中のインデックス構築のコミットに投票する必要があるもの（プライマリを含む）を変更します。	はい
`setClusterParameter`	レプリカセットまたはシャーディングされたクラスター内のすべてのノードで構成オプションを変更します。バージョン 6.0 で追加。	はい
`setParameter`	構成オプションを変更します。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`setDefaultRWConcern`	読み取り保証（read concern）と書込み保証（write concern）のグローバルのデフォルトオプションを配置用に設定します。	はい
`setUserWriteBlockMode`	クラスター全体への書込みのブロックとブロック解除を実行します。	No
`shutdown`	`mongod` または `mongos` プロセスをシャットダウンします。	M 0 、M 2 、M 5 、 M 10クラスターはサポートされていません。
`validateDBMetadata`	データベースまたはコレクションの保存されたメタデータが特定の API バージョン内で有効であるかどうかを確認します。バージョン 5.0 で追加	はい

診断コマンド

名前	説明	MongoDB Atlas のサポート
`buildInfo`	MongoDB ビルドに関する統計を表示します。	はい
`collStats`	指定コレクションのストレージ使用率に関する統計情報を報告します。	はい
`connPoolStats`	この MongoDB インスタンスから配置内の他の MongoDB インスタンスへの送信接続に関する統計情報を報告します。	はい
`connectionStatus`	現在の接続の認証状態を報告します。	はい
`dataSize`	データ範囲のデータサイズを返します。内部でのみ使用します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`dbHash`	データベースとそのコレクションのハッシュ値を返します。	M 0 、M 2 、M 5クラスターとサーバーレスインスタンスはサポートされていません。
`dbStats`	指定データベースのストレージ使用率に関する統計情報を報告します。	M 0 、M 2 、M 5クラスターの限定的なサポート。
`explain`	さまざまな操作の実行に関する情報を返します。	はい
`getCmdLineOpts`	MongoDB インスタンスへのランタイム引数とその解析済みオプションを含むドキュメントを返します。	はい
`getLog`	最近のログメッセージを返します。	はい
`hostInfo`	基礎となるホストシステムを反映するデータを返します。	M 0 、M 2 、M 5クラスターはサポートされていません。
`listCommands`	現在の `mongod` インスタンスによって提供されるすべてのデータベースコマンドを一覧表示します。	はい
`lockInfo`	現在一時停止中または保留中であるロックに関する情報を返す内部コマンド。`mongod` インスタンスでのみ利用可能です。	M 0 、M 2 、M 5クラスターはサポートされていません。
`ping`	配置内接続をテストする内部コマンド。	はい
`profile`	データベースプロファイラのインターフェイス。	はい
`serverStatus`	インスタンス全体でのリソース使用率とステータスに関するコレクションメトリクスを返します。	はい
`shardConnPoolStats`	MongoDB 5.0 で削除されました。代わりに `connPoolStats` を使用してください。	サーバーレスインスタンスのサポートはありません。
`top`	`mongod` インスタンス内の各データベースの未加工の使用状況統計を返します。	サーバーレスインスタンスのサポートはありません。
`validate`	コレクションのデータとインデックスをスキャンして正確性を確認する内部コマンド。	M 0 、M 2 、M 5クラスターとサーバーレスインスタンスはサポートされていません。
`whatsmyuri`	現在のクライアントに関する情報を返す内部コマンド。	はい

監査コマンド

名前	説明	MongoDB Atlas のサポート
`getAuditConfig`	`mongod` インスタンスと `mongos` インスタンスから監査構成を取得します。 MongoDB 7.1では非推奨	No
`logApplicationMessage`	監査ログにカスタムメッセージを投稿します。	はい
`setAuditConfig`	実行時に `mongod` インスタンスと `mongos` インスタンスの監査構成を設定します。 MongoDB 7.1では非推奨	No

Atlas Search コマンド

バージョン 7.0 の新機能: （6.0.7 以降でも利用可能）

名前	説明
`createSearchIndexes`	指定されたコレクションに 1 つ以上のAtlas Search インデックスを作成します。
`dropSearchIndex`	既存の Atlas Search インデックスを削除します。
`updateSearchIndex`	既存のAtlas Search インデックスをアップデートします。

戻る

接続文字列の例

集計

注意

コマンド構文

ユーザー コマンド

集計コマンド

地理空間コマンド

クエリと書込み操作コマンド

クエリプラン キャッシュ コマンド

データベース操作

認証コマンド

ユーザー管理コマンド

ロール管理コマンド

レプリケーション コマンド

Tip

以下も参照してください。

シャーディング コマンド

Tip

以下も参照してください。

セッション コマンド

管理コマンド

診断コマンド

監査コマンド

Atlas Search コマンド

ユーザーコマンド

クエリプランキャッシュコマンド

レプリケーションコマンド

シャーディングコマンド

セッションコマンド