データベース コマンド
以下で概説するすべてのコマンド ドキュメントには、コマンドとコマンドで使用可能なパラメーターの説明、およびドキュメント テンプレートまたは各コマンドのプロトタイプが提示されています。 一部のコマンドのドキュメントには、関連する mongosh
ヘルパーも含まれています。
現在のデータベースにコマンドを実行するには、db.runCommand()
を使用します。
db.runCommand( { <command> } )
admin
データベースに対して管理コマンドを実行するには、db.adminCommand()
を使用します。
db.adminCommand( { <command> } )
注意
構文や例えなど、特定のコマンドの詳細については、「 コマンドの参照ページ 」へのリンクをクリックしてください。
コマンド構文
データベースコマンドを実行するときは、コマンドをドキュメントとして db.runCommand()
に指定します。ドキュメントのキーは実行用コマンドであり、値は通常 1
として提供されます。この値は、サンプル向けのコマンドの出力には影響しません。
db.runCommand( { hello: 1 } )
ユーザー コマンド
集計コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
コレクションまたはビューに含まれるドキュメント数をカウントします。 | ||
コレクションまたはビュー内の指定されたキーに対して見つかった個別の値を表示します。 | ||
大規模なデータセットで map-reduce 集計を実行します。 |
地理空間コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
MongoDB 5.0 で削除されました。MongoDB の haystack インデックス機能を使用して地理空間クエリを実行します。 |
クエリと書込み操作コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
1 回のリクエストで複数のコレクションに対して多くの挿入、アップデート、削除操作を実行します。 バージョン8.0の新機能。 | No | |
1 つ以上のドキュメントを削除します。 | はい | |
コレクションまたはビュー内のドキュメントを選択します。 | ||
1 つのドキュメントを返して変更します。 | はい | |
現在カーソルでポイントされているドキュメントのバッチを返します。 | はい | |
1 つ以上のドキュメントを挿入します。 | はい | |
MongoDB 5.0 で削除されました。最後のエラー ステータスをリセットします。 | No | |
1 つ以上のドキュメントを更新します。 | はい |
クエリプラン キャッシュ コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
コレクションのキャッシュされたクエリプランを削除します。 | ||
コレクションのインデックス フィルターをクリアします。 | ||
コレクションのインデックス フィルターを一覧表示します。 | ||
コレクションのインデックス フィルターを設定します。 |
データベース操作
認証コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
ユーザー名とパスワードを使用して認証されたセッションを開始します。 | ||
現在認証されているセッションを終了します。 | はい |
ユーザー管理コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
新規ユーザーを作成します。 | ||
データベースに関連付けられているすべてのユーザーを削除します。 | ||
ユーザーを 1 人削除します。 | ||
ロールとその権限をユーザーに付与します。 | ||
ユーザーからロールを削除します。 | ||
ユーザーのデータを更新します。 | ||
指定したユーザーに関する情報を返します。 |
ロール管理コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
ロールを作成し、その権限を指定します。 | ||
ユーザー定義ロールを削除します。 | ||
データベースからすべてのユーザー定義ロールを削除します。 | ||
ユーザー定義のロールに権限を割り当てます。 | ||
ユーザー定義ロールが権限を継承するロールを指定します。 | ||
認証情報やロールなどのユーザー情報のメモリ内キャッシュをフラッシュします。 | ||
指定した権限をユーザー定義ロールから排除します。 | ||
ユーザ定義ロールから指定された継承ロールを削除します。 | ||
指定したロールの情報を返します。 | はい | |
ユーザー定義ロールを更新します。 |
レプリケーション コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
非操作エントリをoplog に書込みます。 | ||
現在のデータセットに oplog エントリを適用する内部コマンド。 | ||
レプリカセット内のこのノードのロールに関する情報(プライマリであるかどうかなど)を表示します。 | はい | |
選択したプライマリに同期(キャッチアップ)の中止を強制してから、プライマリへの移行を完了させます。 | はい | |
現在のノードが一定期間、プライマリとして選出されることを禁止します。 | ||
レプリカセットの構成オブジェクトを返します。 | ||
レプリカセットの状態を報告するドキュメントを返します。 | ||
新しいレプリカセットを初期化します。 | ||
メンテナンスモードを有効または無効にし、セカンダリノードを | ||
既存のレプリカセットに新しい構成を適用します。 | ||
レプリカセット ノードの oplog サイズを動的に変更します。WiredTiger ストレージエンジンでのみ使用できます。 | ||
複製するノードを選択するためのデフォルト ロジックを明示的に上書きします。 |
シャーディング コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
再シャーディング操作を中止します。 バージョン 5.0 で追加 | はい | |
進行中の バージョン8.0の新機能。 | サーバーレスインスタンスと Atlas共有階層はサポートされていません。 | |
進行中の バージョン8.0の新機能。 | サーバーレスインスタンスと Atlas共有階層はサポートされていません。 | |
シャーディングされたクラスターにシャードを追加します。 | ||
シャードキーを評価するためのメトリクスを計算します。 バージョン 7.0 で追加。 | はい | |
シャーディングされたコレクションのチャンクが、バランスが取れているかどうかに関する情報を返します。 | ||
バランサー スレッドを開始します。 | ||
バランサーの状態に関する情報を返します。 | ||
バランサー スレッドを停止します。 | ||
シャーディング メタデータの整合性に関して一連のチェックを実行します。 バージョン 7.0 で追加。 | はい | |
チャンク用の | ||
失敗した再シャーディング操作をクリーンアップします。 バージョン 5.0 で追加 | はい | |
再シャーディング操作を強制し、書込みをブロックして完了します。 バージョン 5.0 で追加 | はい | |
シャーディングされたコレクションのバランサー設定を構成します。 バージョン 5.3 で追加。 | はい | |
コレクションのクエリ サンプリングを構成します。 バージョン 7.0 で追加。 | はい | |
データベースを作成します。 | ||
シャーディングされたクラスターの状態を報告する内部コマンド。 | ||
プロセスが | はい | |
構成されたシャードの一覧を返します。 | ||
シャード間でチャンクを移行する内部コマンド。 | ||
シャーディングされたクラスターからシャードを削除するときに、プライマリシャードを再割り当てします。 | ||
シャード間で範囲を移動します。 | はい | |
シャードが所有する特定コレクションでマージ可能なチャンクをすべてマージします。 | ||
単一のシャードでチャンクを結合する機能を提供します。 | ||
コレクションのシャードキーを調整するために、既存キーにサフィックスを追加します。 | ||
シャーディングされたクラスターからシャードを削除するプロセスを開始します。 | ||
コレクションのシャードキーを変更してデータの分散状況を変えるために、再シャーディング操作を開始します。 バージョン 5.0 で追加 | はい | |
コレクションでの新規の自動移行を防止します。 | ||
コレクションのシャーディング機能を有効にし、コレクションをシャーディングできるようにします。 | ||
| はい | |
新しいチャンクを作成します。 | ||
専用のコンフィギュレーションサーバーをコンフィギュレーションシャードとして実行するように構成します。 バージョン8.0の新機能。 | サーバーレスインスタンスと Atlas共有階層はサポートされていません。 | |
コンフィギュレーションシャードを専用のコンフィギュレーションサーバーとして実行するように構成します。 バージョン8.0の新機能。 | サーバーレスインスタンスと Atlas共有階層はサポートされていません。 | |
MongoDB 5.0 で削除されました。MongoDB 配置のインスタンス間の接続に影響する内部コマンドです。 | はい | |
はい | ||
セッション コマンド
コマンド | 説明 | Atlas サポート |
---|---|---|
トランザクションを中止します。 | はい | |
トランザクションをコミットします。 | はい | |
セッションのタイムアウト期間前にセッションを失効させます。 | はい | |
すべてのセッションを強制終了します。 | ||
指定されたパターンに一致するすべてのセッションを強制終了します。 | ||
指定したセッションを強制終了します。 | ||
アイドル状態のセッションを更新します。 | はい | |
新しいセッションを開始します。 | はい |
管理コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
上限付きコレクション以外のコレクションを新しい 上限付きコレクションとしてコピーします。 | ||
コレクションにオプションを追加するか、ビュー定義を変更します。 | はい | |
コレクションをデフラグし、インデックスを再構築します。 | ||
状態コレクションで指定されたドキュメントを圧縮し、冗長なドキュメントを削除します。 | はい | |
上限付きコレクション以外のコレクションを上限付きコレクションへ変換します。 | ||
コレクションまたはビューを作成します。 | はい | |
コレクション向けインデックスを 1 つ以上構築します。 | はい | |
データベース インスタンスに対して進行中の操作に関する情報を含むドキュメントを返します。 | はい | |
指定したコレクションをデータベースから排除します。 | はい | |
現在のデータベースを削除します。 | はい | |
指定ホスト リストへの送信接続を切断します。 | はい | |
コレクションからインデックスを削除します。 | はい | |
はい | ||
保留中の書込みをストレージ レイヤーにフラッシュし、データベースをロックしてバックアップできるようにします。 | ||
1 つの fsync ロックを解除します。 | ||
読み取り保証(read concern)と書込み保証(write concern)のグローバルのデフォルト オプションを配置用に取得します。 | はい | |
クラスター内のすべてのノードからクラスター パラメータ値を取得します。 バージョン 6.0 で追加。 | はい | |
Retrieves configuration options. | ||
コレクションの指定カーソルを強制終了します。 | はい | |
操作 ID で指定された操作を終了します。 | ||
現在のデータベース内のコレクション リストを返します。 | はい | |
すべてのデータベースを列挙し、基本的データベース統計を返すドキュメントを返します。 | はい | |
コレクションのすべてのインデックスを列挙します。 | はい | |
MongoDB ログをローテーションして、1 つのファイルが専有するスペースが過大になるのを防止します。 | ||
コレクションですべてのインデックスを再構築します。 | ||
既存コレクションの名前を変更します。 | はい | |
オンライン TLS 証明書ローテーションを実行します。 | はい | |
下位互換性のないデータを保持する機能を有効または無効にします。 | ||
データを保持するノード(コミットクォーラム)のうち、プライマリが準備完了とインデックスをマークする前に、進行中のインデックス構築のコミットに投票する必要があるもの(プライマリを含む)を変更します。 | はい | |
レプリカセットまたはシャーディングされたクラスター内のすべてのノードで構成オプションを変更します。 バージョン 6.0 で追加。 | はい | |
構成オプションを変更します。 | ||
読み取り保証(read concern)と書込み保証(write concern)のグローバルのデフォルト オプションを配置用に設定します。 | はい | |
クラスター全体への書込みのブロックとブロック解除を実行します。 | No | |
データベースまたはコレクションの保存されたメタデータが特定の API バージョン内で有効であるかどうかを確認します。 バージョン 5.0 で追加 | はい |
診断コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
MongoDB ビルドに関する統計を表示します。 | はい | |
指定コレクションのストレージ使用率に関する統計情報を報告します。 | はい | |
この MongoDB インスタンスから配置内の他の MongoDB インスタンスへの送信接続に関する統計情報を報告します。 | はい | |
現在の接続の認証状態を報告します。 | はい | |
データ範囲のデータ サイズを返します。内部でのみ使用します。 | ||
データベースとそのコレクションのハッシュ値を返します。 | ||
指定データベースのストレージ使用率に関する統計情報を報告します。 | ||
さまざまな操作の実行に関する情報を返します。 | はい | |
MongoDB インスタンスへのランタイム引数とその解析済みオプションを含むドキュメントを返します。 | はい | |
最近のログ メッセージを返します。 | はい | |
基礎となるホスト システムを反映するデータを返します。 | ||
現在の | はい | |
現在一時停止中または保留中であるロックに関する情報を返す内部コマンド。 | ||
配置内接続をテストする内部コマンド。 | はい | |
データベースプロファイラのインターフェイス。 | はい | |
インスタンス全体でのリソース使用率とステータスに関するコレクション メトリクスを返します。 | はい | |
MongoDB 5.0 で削除されました。代わりに | ||
| ||
コレクションのデータとインデックスをスキャンして正確性を確認する内部コマンド。 | ||
現在のクライアントに関する情報を返す内部コマンド。 | はい |
監査コマンド
名前 | 説明 | MongoDB Atlas のサポート |
---|---|---|
No | ||
監査ログにカスタムメッセージを投稿します。 | はい | |
No |
Atlas Search コマンド
バージョン 7.0 の新機能: (6.0.7 以降でも利用可能)
名前 | 説明 |
---|---|
指定されたコレクションに 1 つ以上のAtlas Search インデックスを作成します。 | |
既存の Atlas Search インデックスを削除します。 | |
既存のAtlas Search インデックスをアップデートします。 |