メソッド

項目一覧

管理メソッド

Atlas Search インデックスメソッド
一括操作メソッド
コレクションメソッド
接続方法
カーソルメソッド
データベースメソッド
使用中の暗号化メソッド
ネイティブメソッド
クエリプランキャッシュメソッド
レプリケーションメソッド
ロールマネジメントメソッド
セッションオブジェクトメソッド
サーバーステータスメソッド
シャーディングメソッド
テレメトリーメソッド
トランザクションメソッド
ユーザー管理メソッド

次のドキュメントは、MongoDB Shell で利用可能なメソッドを示しています。メソッドをクリックすると、構文や例えなどのドキュメントが MongoDB マニュアルで表示されます。

重要

shelltriggerのサーバーへの接続をリセットするメソッドは、開いているすべてのサーバーセッションの終了をします。セッションが終了すると、進行中のすべての操作も終了されます。その場合、認証が有効になっている場合はクライアントは再認証を行う必要があります。

次のメソッドは shell の接続をリセットします。

db.auth
Mongo.setReadPref
Mongo.setReadConcern

管理メソッド

方式	説明
`db.adminCommand()`	`admin` データベースに対してコマンドを実行します。
`db.currentOp()`	現在進行中の操作を報告します。
`db.killOp()`	指定された操作を終了します。
`db.shutdownServer()`	現在の`mongod`または`mongos`プロセスを正常かつ安全にシャットダウンします。
`db.fsyncLock()`	データベースをロックして書き込み操作を防ぎ、バックアップ操作を支援するには、ディスクへの書き込みをフラッシュします。
`db.fsyncUnlock()`	`db.fsyncLock()`でロックされたデータベースで書込みを継続できるようにします。

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

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

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

重要

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

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

一括操作メソッド

方式	説明
`db.collection.initializeOrderedBulkOp()`	コレクションの新しい`Bulk()`操作ビルダを初期化して返します。ビルダは、MongoDB が一括して実行する書込み (write) 操作の順序付きリストを作成します。
`db.collection.initializeUnorderedBulkOp()`	コレクションの新しい`Bulk()`操作ビルダを初期化して返します。ビルダは、MongoDB が一括して実行する書込み (write) 操作の順序なしのリストを作成します。
`Bulk()`	単一のコレクションに対して一括して実行する書込み (write) 操作のリストを作成するために使われる一括操作ビルダを作成します。ビルダをインスタンス化するには、 `db.collection.initializeOrderedBulkOp()` } メソッドまたは`db.collection.initializeUnorderedBulkOp()`メソッドのいずれかを使用します。
`Bulk.execute()`	`Bulk()`操作ビルダによって構築された操作リストを実行します。
`Bulk.find()`	アップデート操作または削除操作のクエリ条件を指定します。
`Bulk.find.hint()`	一括操作をサポートするインデックスを指定するヒントオプションを設定します。
`Bulk.find.remove()`	一括操作リストに削除操作を追加します。
`Bulk.find.removeOne()`	一括操作リストに 1 つのドキュメントの削除操作を追加します。
`Bulk.find.replaceOne()`	一括操作リストに 1 つのドキュメント置換操作を追加します。
`Bulk.find.updateOne()`	一括操作リストに 1 つのドキュメントのアップデート操作を追加します。
`Bulk.find.update()`	一括操作リストにマルチアップデート操作を追加します。このメソッドは、既存のドキュメントの特定のフィールドをアップデートします。
`Bulk.find.upsert()`	更新操作または置換操作でアップサートオプションを`true`に設定します。
`Bulk.getOperations()`	`Bulk.execute()`を通じて実行された書き込み操作の配列を返します。
`Bulk.insert()`	一括操作リストに挿入操作を追加します。
`Bulk.toJSON()`	`Bulk()`オブジェクト内の操作とバッチの数を含む JSON document を返します。
`Bulk.toString()`	`Bulk()`オブジェクト内の操作とバッチの数を含む JSON ドキュメントを string として返します。

コレクションメソッド

方式	説明
`db.collection.aggregate()`	集計パイプラインへのアクセス権を提供します。
`db.collection.bulkWrite()`	一括書き込み操作機能を提供します。
`db.collection.count()`	`mongosh` 1.0.6では非推奨。代わりに`db.collection.countDocuments()`または`db.collection.estimatedDocumentCount()`を使用してください。
`db.collection.countDocuments()`	コレクションまたはビューに含まれるドキュメント数を返します。 `$group`集計ステージを`$sum`式でラップします。
`db.collection.estimatedDocumentCount()`	collectionまたはビュー内のドキュメントのおおよその数を返します。
`db.collection.createIndex()`	コレクションにインデックスを構築します。
`db.collection.createIndexes()`	コレクションに 1 つ以上のインデックスを構築します。
`db.collection.dataSize()`	コレクションのサイズを返します。の出力で`size` `collStats`フィールドをラップします。
`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.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.getShardVersion()`	シャーディングされたクラスター内のデータの状態に関する情報を返します。
`db.collection.insertOne()`	コレクションに新しいドキュメントを挿入します。
`db.collection.insertMany()`	コレクションに複数の新しいドキュメントを挿入します。
`db.collection.isCapped()`	コレクションがCapped コレクションかどうかを報告します。
`db.collection.mapReduce()`	コレクションに対してmap-reduce集計操作を実行します。
`db.collection.reIndex()`	コレクションのすべての既存のインデックスを再構築します。
`db.collection.renameCollection()`	コレクションの名前を変更します。
`db.collection.replaceOne()`	コレクションの 1 つのドキュメントを置き換えます。
`db.collection.stats()`	コレクションの状態を報告します。 `collStats`を囲むラッパーを提供します。
`db.collection.storageSize()`	コレクションで使用される合計サイズをバイト単位で報告します。 `storageSize`出力の`collStats` フィールドを囲むラッパーを提供します。
`db.collection.totalIndexSize()`	コレクションのインデックスによって使用される合計サイズを報告します。 `totalIndexSize`出力の`collStats` フィールドを囲むラッパーを提供します。
`db.collection.totalSize()`	コレクション内のすべてのドキュメントとすべてのインデックスのサイズを含む、コレクションの合計サイズを報告します。
`db.collection.updateOne()`	コレクションの 1 つのドキュメントを変更します。
`db.collection.updateMany()`	コレクションの複数のドキュメントを変更します。
`db.collection.validate()`	コレクションを検証します。
`db.collection.watch()`	コレクション上で変更ストリームカーソルを開きます。

接続方法

方式

説明

Mongo()

mongo shell または JavaScript ファイルからデータベース接続をインスタンス化するための JavaScript コンストラクター。

Mongo()メソッドには次のパラメータがあります。

Parameter	タイプ	説明
`host`	string	任意ターゲットデータベース接続の接続string 。省略した場合、 `Mongo()`はデフォルトのポート`27017`でローカルホストインターフェースへの接続をインスタンス化します。
`autoEncryptionOpts`	ドキュメント	任意バージョン 4.2の新機能クライアント側のフィールドレベル暗号化を有効にするための構成パラメーター。 `autoEncryptionOpts` は、データベース接続の既存のクライアント側のフィールドレベル暗号化構成を上書きします。省略した場合、 `Mongo()`は現在のデータベース接続のクライアント側のフィールドレベル暗号化構成を継承します。の使用方法と構文のドキュメントについては、 AutoEncryptionOpts を参照してください。

Mongo.getDB()

データベースオブジェクトを返します。

Mongo.setReadPref()

MongoDB 接続の読み込み設定（ read preference ）を設定します。

Mongo.watch()

レプリカセットまたはシャーディングされたクラスターの変更ストリームカーソルを開き、 admin 、 local 、 configデータベースを除き、データベース全体のすべての非システムコレクションについてレポートします。

カーソルメソッド

方式

説明

cursor.addOption()

クエリの動作を変更する特別なワイヤプロトコルフラグを追加します。

cursor.allowPartialResults()

シャーディングされたコレクションに対するdb.collection.find()操作では、クエリされたシャードが 1 つ以上利用できない場合に、エラーではなく部分的な結果を返すことができます。

cursor.batchSize()

MongoDB が単一のネットワークメッセージでクライアントに返すドキュメントの数を制御します。

次のクエリの例では、100 のバッチが返されます。

db.myCollection.find().batchSize(100)

cursor.close()

カーソルを閉じて、関連付けられているサーバーリソースを解放します。

cursor.collation()

db.collection.find()によって返されるカーソルの照合を指定します。

cursor.comment()

ログおよび system.profile コレクションのトレーサビリティを確保できるように、クエリにコメントを付けます。

cursor.count()

カーソルがドキュメントそのものではなく、結果セット内のドキュメント数を返すように変更します。

cursor.explain()

カーソルのクエリ実行プランについて報告します。

cursor.forEach()

カーソル内のすべてのドキュメントに JavaScript 関数を適用します。

cursor.hasNext()

カーソルにドキュメントがあり、反復処理できる場合はtrueを返します。

cursor.hint()

MongoDB がクエリに特定のインデックスを使用するように強制します。

cursor.isClosed()

カーソルが閉じている場合は true を返します。

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.readConcern()

操作の db.collection.find()読み取り保証を指定します。

cursor.readPref()

カーソルに読み込み設定（ read preference）を指定して、クライアントがレプリカセットにクエリを送信する方法を制御します。

cursor.returnKey()

カーソルを変更して、ドキュメントではなくインデックスキーを返します。

cursor.showRecordId()

カーソルによって返される各ドキュメントに内部 storage engine ID フィールドを追加します。

cursor.size()

skip() } メソッドとlimit()メソッドを適用した後、カーソル内のドキュメントの数を返します。

cursor.skip()

一定数のドキュメントを渡したりスキップした後にのみ結果を返し始めるカーソルを返します。

cursor.sort()

ソート指定に従って順序付けられた結果を返します。

cursor.tailable()

カーソルを末尾可能としてマークします。上限付きコレクションのカーソルに対してのみ有効です。

cursor.toArray()

カーソルによって返されたすべてのドキュメントを含む配列を返します。

データベースメソッド

方式	説明
`db.aggregate()`	基礎のコレクションを必要としない管理および診断パイプラインを実行します。
`db.createCollection()`	新しいコレクションまたはビューを作成します。
`db.createView()`	指定された集計パイプラインをソースコレクションまたはビューに適用してビューを作成します。
`db.commandHelp()`	指定されたデータベースコマンドのヘルプテキストを表示します。
`db.dropDatabase()`	現在のデータベースを削除します。
`db.getCollection()`	コレクションまたはビューオブジェクトを返します。 `mongo` shell で有効でない名前を持つコレクションへのアクセスに使用されます。
`db.getCollectionInfos()`	現在のデータベース内のすべてのコレクションとビューのコレクション情報を返します。
`db.getCollectionNames()`	現在のデータベース内のすべてのコレクションとビューを一覧表示します。
`db.getMongo()`	現在のデータベース接続を返します。
`db.getLogComponents()`	現在のログの冗長設定を返します。
`db.getName()`	現在のデータベースの名前を返します。
`db.getProfilingStatus()`	現在のプロファイルレベル、 slowOpThresholdMs設定、 slowOpSampleRate設定を返します。
`db.getSiblingDB()`	指定されたデータベースへのアクセス権を提供します。
`db.listCommands()`	すべてのデータベースコマンドの一覧を提供します。
`db.logout()`	認証されたセッションを終了します。
`db.printShardingStatus()`	シャーディング構成のフォーマットされたレポートと、シャーディングされたクラスター内の既存のチャンクに関する情報を出力します。
`db.runCommand()`	データベースコマンドを実行します。
`db.setLogLevel()`	ログメッセージに単一の冗長レベルを設定します。
`db.setProfilingLevel()`	データベースプロファイラーレベル、 slowms 、 sampleRate を構成します。
`db.watch()`	データベースの変更ストリームカーソルを開き、すべての非システムコレクションについてレポートします。

使用中の暗号化メソッド

注意

制限

自動暗号化は、 mongoshが Atlas クラスターまたは MongoDB Enterprise Server に接続されている場合にのみ使用できます。詳細については、「クライアント側フィールドレベルの自動暗号化」を参照してください。このセクションにリストされているメソッドは手動暗号化に使用され、非エンタープライズサーバーでサポートされています。
mongoshの Homebrew インストールでは自動暗号化は利用できません。
フィールドレベルの暗号化はmongoshバイナリでのみ使用可能であり、埋め込み Compass shell では使用できません。

方式	説明
ClientEncryption.createEncryptedCollection()	暗号化されたフィールドを持つコレクションを作成します。
`ClientEncryption.decrypt()`	`encryptedValue`現在のデータベース接続がKMS （KMS ）とキーヴォールトへのアクセスで構成されている場合は、指定された`encryptedValue` を復号化します。
`ClientEncryption.encrypt()`	指定された`encryptionKeyId`と`encryptionAlgorithm`を使用して指定された値を暗号化します。
`getClientEncryption()`	現在のデータベースコレクションの`ClientEncryption`オブジェクトを返します。
`getKeyVault()`	現在のデータベース接続の`KeyVault`オブジェクトを返します。
`KeyVault.addKeyAlternateName()`	指定された UUID を持つデータ暗号化キーの`keyAltNames`配列に`keyAltName`を追加します。
`KeyVault.createKey()`	データベース接続に関連付けられたキーヴォールトにデータ暗号化キーを追加します。
`KeyVault.deleteKey()`	指定された UUID を持つデータ暗号化キーを、データベース接続に関連付けられたキーヴォールトから削除します。
`KeyVault.getKey()`	指定された UUID を持つデータ暗号化キーを取得します。データ暗号化キーは、データベース接続に関連付けられたキーヴォールトに存在する必要があります。
`KeyVault.getKeyByAltName()`	指定された`keyAltName`を持つすべてのデータ暗号化キーを取得します。
`KeyVault.getKeys()`	データベース接続に関連付けられたキーヴォールトに保存されているすべてのデータ暗号化キーを返します。
`KeyVault.removeKeyAlternateName()`	指定された UUID を持つデータ暗号化キーから、指定された`keyAltName`を削除します。データ暗号化キーは、データベース接続に関連付けられたキーヴォールトに存在する必要があります。

ネイティブメソッド

方式

説明

buildInfo()

mongoshビルドとドライバーの依存関係を説明する次の JSON 形式のドキュメントを返します。

{
  version: '1.10.1',
  distributionKind: 'packaged',
  buildArch: 'x64',
  buildPlatform: 'linux',
  buildTarget: 'unknown',
  buildTime: '2023-06-21T09:49:37.225Z',
  gitVersion: '05ad91b4dd40382a13f27abe1ae8c3f9f52a38f7',
  nodeVersion: 'v16.20.1',
  opensslVersion: '3.1.1',
  sharedOpenssl: true,
  runtimeArch: 'x64',
  runtimePlatform: 'darwin',
  deps: {
     nodeDriverVersion: '5.6.0',
     libmongocryptVersion: undefined,
     libmongocryptNodeBindingsVersion: undefined
   }
}

cd()

現在の作業ディレクトリを指定されたパスに変更します。

isInteractive()

mongosh が対話モードまたはスクリプトモードのどちらで実行されているかを示すブール値を返します。

load()

shell に JavaScript ファイルをロードして実行します。

mongoshでは、 load()メソッドで読み込まれたスクリプトは__filenameと__dirname Node.js 変数をサポートしています。これらの変数は、それぞれ、ロードされたスクリプトのファイル名とディレクトリを返します。返される値は常に絶対パスです。

レガシーのmongo shell は、 load()メソッドでスクリプトのファイル名またはディレクトリにアクセスできません。

print()

指定されたテキストまたは変数を出力します。 print()とprintjson()はconsole.log()のエイリアスです。

> print("hello world")
hello world
> x = "example text"
> print(x)
example text

pwd()

アクティブな shell セッションの現在の作業ディレクトリを返します。

quit()

現在の shell セッションを終了します。

sleep()

特定の期間、 mongo shell を一時停止します。

version()

mongoshインスタンスの現在のバージョンを返します。

クエリプランキャッシュメソッド

方式	説明
`db.collection.getPlanCache()`	コレクションのクエリプランキャッシュオブジェクトと関連する`PlanCache`メソッドにアクセスするためのインターフェースを返します。
`PlanCache.clear()`	コレクションのすべてのキャッシュされたクエリプランを削除します。
`PlanCache.clearPlansByQuery()`	指定されたクエリシェイプのキャッシュされたクエリプランをクリアします。
`PlanCache.help()`	コレクションのクエリプランキャッシュを表示および変更するために使用できるメソッドを一覧表示します。
`PlanCache.list()`	コレクションのプランキャッシュエントリの配列を返します。

レプリケーションメソッド

方式

説明

rs.add()

レプリカセットにメンバーを追加します。このメソッドを実行するには、レプリカセットのプライマリに接続する必要があります。

rs.addArb()

既存のレプリカセットにアービタを追加します。

rs.config()

現在のレプリカセットの構成を含むドキュメントを返します。

rs.freeze()

mongoshが接続しているレプリカセットノードを、指定された期間、プライマリになる資格がありません。期間は秒単位で指定する必要があります。

db.getReplicationInfo()

oplog データからレプリカセットのステータスを返します。

rs.initiate()

新しいレプリカセットを初期化します。

db.printReplicationInfo()

mongoshが接続されているレプリカセットノードの oplog を返します。

rs.printReplicationInfo()

mongoshが接続されているレプリカセットノードの oplog を返します。

db.printSecondaryReplicationInfo

レプリカセットのセカンダリメンバーのステータスを返します。

これは rs.printSecondaryReplicationInfo() メソッドと同じです。このメソッドの出力はdb.printSlaveReplicationInfo メソッドと同様です。db.printSlaveReplicationInfoメソッドはmongosh では非推奨です。代わりに db.printSecondaryReplicationInfo() を使用してください。

以下は、2 つのセカンダリノードがあるレプリカセットで発行されたrs.printSecondaryReplicationInfo()メソッドからの出力の例です。

source: rs2.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020  09:37:28 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}
---
source: rs3.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020  09:37:28 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}

rs.printSecondaryReplicationInfo

レプリカセットのセカンダリメンバーのステータスを返します。

これはdb.printSecondaryReplicationInfo() rs.printSlaveReplicationInfomongoメソッドと同じです。このメソッドの出力は、レガシーのシェルのメソッドに似ています。rs.printSlaveReplicationInfo メソッドはmongosh では非推奨です。代わりにrs.printSecondaryReplicationInfo() を使用してください。

以下は、2 つのセカンダリノードがあるレプリカセットで発行されたrs.printSecondaryReplicationInfo()メソッドからの出力の例です。

source: rs2.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020 09:42:18 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}
---
source: rs3.example.net:27017
{
  syncedTo: 'Tue Oct 13 2020 09:42:18 GMT-0700 (Pacific Daylight Time)',
  replLag: '0 secs (0 hrs) behind the primary '
}

rs.reconfig()

既存のレプリカセットの構成を変更します。

rs.remove()

ホスト名で指定されたノードをレプリカセットから削除します。

rs.status()

mongoshが接続しているレプリカセットメンバーのステータスを返します。

rs.stepDown()

レプリカセットのプライマリをセカンダリにします。このメソッドを実行するには、プライマリに接続する必要があります。

rs.syncFrom()

mongoshが接続されているレプリカセットメンバーのホスト名で指定されたレプリカセットメンバーに同期ターゲットをリセットします。

ロールマネジメントメソッド

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

セッションオブジェクトメソッド

方式	説明
`Mongo.startSession()`	接続のセッションを開始します。
Session.advancedOperationTime()	optimeを更新します。
Session.endSession()	セッションを終了します。
Session.getClusterTime()	セッションで確認された最新のクラスター時間を返します。
Session.getDatabase()	shell のセッションから指定されたデータベースにアクセスします。
Session.getOperationTime()	セッションの最後に確認された操作のタイムスタンプを返します。
Session.getOptions()	セッションのオプションを返します。
Session.hasEned()	セッションが終了したかどうかを指定するブール値を返します。
`SessionOptions()`	shell 内のセッションのオプション。 `SessionOptions()`オブジェクトにアクセスするには、 `Session.getOptions()`を使用します。

サーバーステータスメソッド

方式	説明
`db.hello()`	`mongod`インスタンスのロールを説明するドキュメントを返します。 `mongod`がレプリカセットのメンバーである場合、 `isWritablePrimary` } フィールドと`secondary`フィールドは、インスタンスがプライマリであるか、レプリカセットのセカンダリであるかどうかを報告します。
`db.hostInfo()`	MongoDB インスタンスを実行しているシステムについての情報をドキュメントで返します。
`db.collection.latencyStats()`	指定コレクションのレイテンシ統計を返します。
`db.printCollectionStats()`	すべてのコレクションから統計情報を返します。
`db.serverBuildInfo()`	`mongod`インスタンスのコンパイルパラメータを表示するドキュメントを返します。
`db.serverCmdLineOpts()`	MongoDB インスタンスの起動に使用されたランタイムオプションに関する情報をドキュメントで返します。
`db.serverStatus()`	データベースプロセスの概要を示すドキュメントを返します。
`db.stats()`	現在のデータベースの状態を報告するドキュメントを返します。
`db.version()`	`mongod`インスタンスのバージョンを返します。

シャーディングメソッド

方式	説明
`sh.addShard()`	シャーディングされたクラスターにシャードを追加します。
`sh.addShardTag()`	`sh.addShardToZone()`のエイリアス。
`sh.addShardToZone()`	シャードをゾーンに関連付けます。シャーディングされたクラスター内のゾーンの構成をサポートします。
`sh.addTagRange()`	`sh.updateZoneKeyRange()`のエイリアス。
`sh.balancerCollectionStatus()`	シャーディングされたコレクションのチャンクが、バランスが取れているかどうかに関する情報を返します。バージョン 4.4 で追加。
sh.disableAutoMerger()	名前空間のチャンクの自動マージを無効にします。バージョン 7.0 で追加。
`sh.disableAutoSplit()`	シャーディングされたクラスターの自動分割を無効にします。
`sh.disableBalancing()`	Disables balancing on a single collection in a sharded database. シャーディングされたクラスター内の他のコレクションのバランシングには影響しません。
sh.enableAutoMerger()	名前空間のチャンクの自動マージを有効にします。バージョン 7.0 で追加。
`sh.enableAutoSplit()`	シャーディングされたクラスターの自動分割を有効にします。
`sh.enableBalancing()`	以前に`sh.disableBalancing()`を使用して無効にしていた場合、シャーディングされたコレクションバランサープロセスを有効にします。
`sh.enableSharding()`	特定のデータベースのシャーディングを有効にします。
`sh.getBalancerState()`	バランサーが現在有効になっているかどうかを報告するブール値を返します。
`sh.getShardedDataDistribution()`	シャーディングされたコレクションのデータ配信情報を返します。 `sh.getShardedDataDistribution()`は、shell `$shardedDataDistribution`集計パイプラインステージのヘルパーメソッドです。
`sh.isBalancerRunning()`	バランサープロセスが現在チャンクを移行しているかどうかを報告するブール値を返します。
`sh.moveChunk()`	シャーディングされたクラスター内のチャンクを移行します。
`sh.removeRangeFromZone()`	シャードキー値の範囲とゾーンの間の関連付けを削除します。
`sh.removeShardFromZone()`	シャードとゾーンの間の関連付けを削除します。
`sh.removeShardTag()`	タグとシャードの間の関連付けを削除します。
`sh.removeTagRange()`	`sh.addShardTag()`メソッドを使用して作成されたシャードタグからシャードキー値の範囲を削除します。このメソッドは MongoDB 3.4の`sh.removeRangeFromZone()`のエイリアスになります。
`sh.setBalancerState()`	シャード間でチャンクを移行するバランサーを有効または無効にします。
`sh.shardCollection()`	コレクションのシャーディングを有効にします。
`sh.splitAt()`	シャードキーの特定の値を分割点として使用し、既存のチャンクを 2 つに分割します。
`sh.splitFind()`	クエリに一致するドキュメントを含む既存のチャンクを、ほぼ等しい 2 つのチャンクに分割します。
sh.startAutoMerger()	AutoMerger を有効にします。バージョン 7.0 で追加。
`sh.startBalancer()`	バランサーを有効にします。
`sh.status()`	シャーディングされたクラスターの状態を報告します。
sh.stopAutoMerger()	AutoMerger を無効にします。バージョン 7.0 で追加。
`sh.stopBalancer()`	バランサーを無効にします。この操作は、バランサーが進行中の操作を完了するのを待たずに、進行中の操作を終了する可能性があります。
`sh.updateZoneKeyRange()`	シャードキーの範囲をゾーンに関連付けます。シャーディングされたクラスター内のゾーンの設定をサポートします。

テレメトリーメソッド

これらのメソッドは、 mongoshが匿名のテレメトリデータを追跡するかどうかを構成します。テレメトリはデフォルトで有効になっています。

mongoshがテレメトリで追跡するデータの詳細については、「テレメトリオプションの構成」を参照してください。

方式	説明
`disableTelemetry()`	`mongosh`のテレメトリを無効にします。
`enableTelemetry()`	`mongosh`のテレメトリを有効にします。

トランザクションメソッド

方式	説明
`Session.abortTransaction()`	マルチドキュメントトランザクションを終了し、トランザクション内の操作によって行われたデータ変更をロールバックします。
`Session.commitTransaction()`	マルチドキュメントトランザクションの操作によって行われた変更を保存し、トランザクションを終了します。
`Session.startTransaction()`	セッションに関連するマルチドキュメントトランザクションを開始します。

ユーザー管理メソッド

重要

passwordPrompt()メソッドは現在、 mongoshではサポートされていません。そのため、次のメソッドを使用する場合は、パラメーターとしてパスワードを指定する必要があります。

方式	説明
`db.auth()`	データベースに対してユーザーを認証します。
`db.changeUserPassword()`	既存のユーザーのパスワードを変更します。
`db.createUser()`	新規ユーザーを作成します。
`db.dropAllUsers()`	データベースに関連付けられているすべてのユーザーを削除します。
`db.dropUser()`	ユーザーを 1 人削除します。
`db.getUser()`	指定されたユーザーに関する情報を返します。
`db.getUsers()`	データベースに関連付けられているすべてのユーザーに関する情報を返します。
`db.updateUser()`	指定されたユーザーのデータを更新します。
`db.grantRolesToUser()`	ロールとその権限をユーザーに付与します。
`db.revokeRolesFromUser()`	ユーザーからロールを削除します。

戻る

データ型

EJSON

重要

管理メソッド

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

重要

一括操作メソッド

コレクション メソッド

接続方法

カーソル メソッド

データベース メソッド

使用中の暗号化メソッド

注意

制限

ネイティブ メソッド

クエリプラン キャッシュ メソッド

レプリケーション メソッド

ロール マネジメント メソッド

セッション オブジェクト メソッド

サーバー ステータス メソッド

シャーディング メソッド

テレメトリー メソッド

トランザクション メソッド