mongosh
ヘルプ
このドキュメントは、mongosh
で利用可能なヘルプの概要を説明します。
Tip
mongosh
のヘルプにアクセスするときは、.help()
構文と .help
構文をどちらも使用できます。
コマンドライン ヘルプ
mongosh
実行可能ファイルを実行し、配置に接続するためのオプションを表示するには、コマンドラインから --help
オプションを使用します。
mongosh --help
mongosh
Shell ヘルプ
mongosh
コンソールで使用できるコマンドの一覧を表示するには、実行中の mongosh
コンソール内で help
を入力します。
help
データベース ヘルプ
mongosh
コンソール内からデータベース レベルの情報を表示できます。
デフォルトでは、mongosh
は、プロンプトに現在のデータベースを表示します。また、db
コマンドを実行して現在のデータベースを確認することもできます。
db
使用可能なデータベースの表示
サーバー上で使用可能なデータベースの一覧を表示するには、show dbs
コマンドを使用します。
show dbs
show databases
これは、show dbs
のエイリアスです。
Tip
データベースのリストは、アクセス権限によって異なります。データベースの表示に関するアクセス制限の詳細については、 listDatabases
を参照してください。
データベース メソッドの表示
db
オブジェクトで使用できるデータベース メソッドのリストを表示するには、db.help()
を実行します。
db.help()
出力は、次のような省略されたリストになります。
Database Class: getMongo Returns the current database connection getName Returns the name of the DB getCollectionNames Returns an array containing the names of all collections in the current database. getCollectionInfos Returns an array of documents with collection information, i.e. collection name and options, for the current database. runCommand Runs an arbitrary command on the database. adminCommand Runs an arbitrary command against the admin database. ...
特定のデータベース メソッドのヘルプの表示
mongosh
で特定のデータベース メソッドのヘルプを表示するには、db.<method name>
に続けて、 .help
または .help()
を入力します。次の例では、db.adminCommand()
メソッドのヘルプを返します。
db.adminCommand.help()
出力は次のようになります。
db.adminCommand({ serverStatus: 1 }): Runs an arbitrary command against the admin database. For more information on usage: https://www.mongodb.com/ja-jp/docs/manual/reference/method/db.adminCommand
データベース メソッドのその他の使用状況の詳細表示
データベース メソッドのその他の使用方法の詳細を表示するには、mongosh
で括弧(()
)を付けずにdb.<method name>
を入力します。次の例では、db.adminCommand()
メソッドの詳細を返します。
db.adminCommand
出力は次のようになります。
[Function: adminCommand] AsyncFunction { apiVersions: [ 1, Infinity ], serverVersions: [ '3.4.0', '999.999.999' ], returnsPromise: true, topologies: [ 'ReplSet', 'Sharded', 'LoadBalanced', 'Standalone' ], returnType: { type: 'unknown', attributes: {} }, deprecated: false, platforms: [ 0, 1, 2 ], isDirectShellCommand: false, acceptsRawInput: false, shellCommandCompleter: undefined, help: [Function (anonymous)] Help }
コレクション ヘルプ
mongosh
コンソール内からコレクション レベルの情報を表示できます。
これらのヘルプ メソッドはコレクション名 <collection>
を受け入れますが、一般的なタームの "collection" や、存在しないコレクションを使用することもできます。
現在のデータベース内のコレクションの一覧表示
現在のデータベース内のコレクションの一覧を表示するには、show collections
コマンドを使用します。
show collections
show collections
出力は、コレクションが時系列コレクションなのか、読み取り専用表示なのかを示します。
managementFeedback [view] survey weather [time-series] system.buckets.weather system.views
前の例では、次のようになります。
managementFeedback
はビューですweather
時系列ですsurvey
コレクションですsystem.buckets.weather
システムが生成したコレクションで、weather
時系列をサポートしますsystem.views
システムが生成したコレクションで、他のコレクションに対するビューをサポートします
コレクション メソッドを表示
コレクション オブジェクトで使用できるメソッドの一覧を表示するには、db.<collection>.help()
メソッドを使用します。
db.collection.help()
<collection>
既存のコレクションまたは存在しないコレクションの名前です。
出力は、次のような省略されたリストになります。
Collection Class: aggregate Calculates aggregate values for the data in a collection or a view. bulkWrite Performs multiple write operations with controls for order of execution. count Returns the count of documents that would match a find() query for the collection or view. countDocuments Returns the count of documents that match the query for a collection or view. deleteMany Removes all documents that match the filter from a collection. deleteOne Removes a single document from a collection. ...
特定のコレクション メソッドのヘルプの表示
mongosh
で特定のコレクション メソッドのヘルプを表示するには、db.<collection>.<method name>
を使用し、続けて .help
または .help()
を使用します。
次の例では、db.collection.insertOne()
のヘルプを表示します。
db.collection.insertOne.help()
出力は次のようになります。
db.collection.insertOne(document, options): Inserts a document into a collection. For more information on usage: https://www.mongodb.com/ja-jp/docs/manual/reference/method/db.collection.insertOne
コレクション メソッドの追加の詳細の表示
コレクション メソッドのさらなる詳細を表示するには、メソッド名 db.<collection>.<method>
を括弧(()
)を付けずに入力します。
次の例では、insertOne()
メソッドの詳細を返します。
db.collection.insertOne
出力は次のようになります。
[Function: insertOne] AsyncFunction { apiVersions: [ 1, Infinity ], serverVersions: [ '3.2.0', '999.999.999' ], returnsPromise: true, topologies: [ 'ReplSet', 'Sharded', 'LoadBalanced', 'Standalone' ], returnType: { type: 'unknown', attributes: {} }, deprecated: false, platforms: [ 0, 1, 2 ], isDirectShellCommand: false, acceptsRawInput: false, shellCommandCompleter: undefined, help: [Function (anonymous)] Help }
カーソル ヘルプ
find()
を使用する読み取り操作 を変更するには、カーソル メソッドを使用します。
使用可能な修飾子とカーソル処理メソッドを一覧表示するには、db.collection.find().help()
コマンドを使用します。
db.collection.find().help()
このヘルプ呼び出しはコレクション名 <collection>
を受け入れますが、一般的なタームの "collection" や、存在しないコレクションを使用することもできます。
カーソルを処理する便利な方法がいくつかあります。
hasNext()
カーソルにさらにドキュメントがあるかどうかをチェックします。next()
次のドキュメントを返し、カーソルの位置を 1 つ先に移動します。forEach(<function>)
は、カーソルによって返される各ドキュメントに<function>
を適用します。
使用可能なカーソル メソッドの一覧については、 カーソルを参照してください。
BSON クラス ヘルプ
mongosh
は、BSON クラスのヘルプ メソッドを提供します。ヘルプ メソッドには、BSON クラスの簡単な概要と、詳細情報のリンクが記載されています。
BSON クラスのヘルプにアクセスするには、クラス名またはクラスのインスタンス化されたインスタンスのいずれかで .help()
を実行します。
<BSON class>.help() // or <BSON class>().help()
たとえば、ObjectId
BSON クラスのヘルプを表示するには、次のいずれかのコマンドを実行します。
ObjectId.help()
ObjectId().help()
mongosh
.help()
メソッドの両方で同じ出力を返します。
The ObjectId BSON Class: For more information on usage: https://mongodb.github.io/node-mongodb-native/3.6/api/ObjectID.html
mongosh
次の BSON クラスのヘルプ メソッドを提供します。
BinData
Code
DBRef
MinKey
MaxKey
NumberDecimal
NumberInt
NumberLong
ObjectId
Symbol
(非推奨)Timestamp
コマンド ヘルパー
mongosh
特定のデータベース コマンドをラップして配置に関する情報を取得するため、次のメソッドとコマンドを提供しています。
ヘルプ メソッドとコマンド | 説明 | |
---|---|---|
| データベース メソッドのヘルプを表示します。 | |
| コレクション メソッドに関するヘルプを表示します。 | |
| ヘルプを表示します。 | |
| 現在のデータベースのすべてのコレクションの一覧を表示します。 | |
| サーバー上のすべてのデータベースの一覧を表示します。
| |
| 指定されたロガー名のメモリ内のログの最後のセグメントを表示します。
| |
| アクセス可能なロガー名を表示します。「shell ログの検索」を参照してください。 | |
| 1 ミリ秒以上かかった直近の 5 つの操作を表示します。詳細については、データベースプロファイラーのドキュメントを参照してください。 | |
| 現在のデータベースのすべてのロール(ユーザー定義ロールと組み込みロールの両方)の一覧を表示します。 | |
| 現在のデータベース内のコレクションの一覧を表示します。 | |
| 現在のデータベースのユーザーの一覧を表示します。 |