警告
次のドキュメントは、mongo
MongoDB Server のダウンロード に含まれる シェルに関連しています。新しいMongoDB Shell(mongosh
)の詳細については、 mongoshドキュメント を参照してください。
2 つの shell の違いを理解するには、「 mongo
Shell とmongosh
の比較 」を参照してください。
MongoDB マニュアルのドキュメントに加えて、 mongo
shell は「オンライン」ヘルプ システムにいくつかの追加情報を提供します。 このドキュメントでは、このヘルプ情報にアクセスする方法の概要を説明します。
コマンドライン ヘルプ
オプションのリストとmongo
shell の起動に役立つオプションのリストを表示するには、コマンドラインから--help
オプションを使用します。
mongo --help
Shell ヘルプ
ヘルプのリストを表示するには、 mongo
shell でhelp
と入力します。
help
データベース ヘルプ
mongo
shell 内:
サーバー上のデータベースの一覧を表示するには、
show dbs
コマンドを使用します。 [ 1 ]show dbs show databases
これは、show dbs
のエイリアスです。db
オブジェクトで使用できるメソッドのヘルプのリストを表示するには、db.help()
メソッドを呼び出します。db.help() shell でのメソッドの実装を確認するには、次の例のように で括弧(
()
)を付けずにdb.<method name>
を入力します。これにより、メソッドdb.updateUser()
の実装が返されます。db.updateUser
[1] | 配置がアクセス制御を使用して実行されている場合、操作はユーザー特権に基づいて異なる 値を返します。 詳細については、「 listDatabases の動作」を参照してください。 |
コレクション ヘルプ
mongo
shell 内:
現在のデータベース内のコレクションの一覧を表示するには、
show collections
コマンドを使用します。show collections コレクション オブジェクトで使用できるメソッドのヘルプを表示するには(例:
db.<collection>
)には、db.<collection>.help()
メソッドを使用します。db.collection.help() <collection>
は存在するコレクションの名前でもかまいませんが、存在しないコレクションを指定することもできます。コレクション メソッドの実装を確認するには、次の例のように、括弧 を付けずに
db.<collection>.<method>
の名前(()
)を入力します。これにより、insertOne()
メソッドの実装が返されます。db.collection.insertOne
カーソル ヘルプ
shell mongo
で メソッドを使用して find()
find()
読み取り操作 を実行する場合、さまざまなカーソル メソッドを使用して の動作を変更し、さまざまな JavaScript メソッドを使用してfind()
メソッドから返されたカーソルを処理できます。
使用可能な修飾子とカーソル処理メソッドを一覧表示するには、
db.collection.find().help()
コマンドを使用します。db.collection.find().help() <collection>
は存在するコレクションの名前でもかまいませんが、存在しないコレクションを指定することもできます。カーソル メソッドの実装を確認するには、次の例のように、括弧を付けずに
db.<collection>.find().<method>
の名前を入力します(()
)。これにより、toArray()
メソッドの実装が返されます。db.collection.find().toArray
カーソルを処理する便利な方法がいくつかあります。
hasNext()
カーソルに返されるドキュメントがさらにあるかどうかを確認します。next()
次のドキュメントを返し、カーソルの位置を 1 つ先に進みます。forEach(<function>)
はカーソル全体を反復処理し、カーソルによって返される各ドキュメントに<function>
を適用します。<function>
は、各反復のドキュメントに対応する単一の引数を要求します。
カーソルを反復処理し、カーソルからドキュメントを取得する例については、カーソル処理 を参照してください。 使用可能なすべてのカーソル メソッドについては、「カーソル」も参照してください。
ラッパー オブジェクト ヘルプ
BinData()
など、 mongo
shell で使用可能なラッパー クラスの一覧を取得するには、 mongo
shell でhelp misc
と入力します。
help misc