パブリック プレビュー:フィードバックを提供してください : 名前で識別されるクラスターにローリング方式でインデックスを作成します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です（フィードバック 930808-Atlas-cli ）。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
この方法でインデックスを作成すると、セカンダリ ノードから始めて、一度に 1 つのレプリカ セット ノードに対してスタンドアロンとしてインデックスを構築できます。この方法でインデックスを作成するには、少なくとも 1 つのレプリカ セットを選択する必要があります。このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データ アクセス管理者ロールが必要です。
このコマンドは自動生成され、:1 と1 Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 / 操作/operation-createloadingindex 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api rollingIndex createRollingIndex [options]
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | MongoDB Cloud がインデックスを作成するクラスターを識別する、人間に判読可能なラベル。 |
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--file | string | false | APIリクエストファイルへのパス。代わりに標準入力を使用するには、 を空のままにします。どちらか一方を指定する必要がありますが、両方を指定することはできません。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | createRollingIndex のヘルプ | |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ（例: gzip）で、コマンドがパイプライン化されていない場合（例: Atlas コマンド >out.zip）に必要です。 |
--pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
--version | string | false | API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01" |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。Atlas CLI のプロファイルの詳細については、https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. を参照してください。 |
例
2dspere Index
以下のファイルを作成し、保存します payload.json
{ "collation": { "alternate": "non-ignorable", "backwards": false, "caseFirst": "lower", "caseLevel": false, "locale": "af", "maxVariable": "punct", "normalization": false, "numericOrdering": false, "strength": 3 }, "collection": "accounts", "db": "sample_airbnb", "keys": [ { "property_type": "1" } ], "options": { "name": "PartialIndexTest", "partialFilterExpression": { "limit": { "$gt": 900 } } } }
payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
部分インデックス
以下のファイルを作成し、保存します payload.json
{ "collation": { "alternate": "non-ignorable", "backwards": false, "caseFirst": "lower", "caseLevel": false, "locale": "af", "maxVariable": "punct", "normalization": false, "numericOrdering": false, "strength": 3 }, "collection": "accounts", "db": "sample_airbnb", "keys": [ { "property_type": "1" } ], "options": { "name": "PartialIndexTest", "partialFilterExpression": { "limit": { "$gt": 900 } } } }
payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
Sparse Index
以下のファイルを作成し、保存します payload.json
{ "collation": { "alternate": "non-ignorable", "backwards": false, "caseFirst": "lower", "caseLevel": false, "locale": "af", "maxVariable": "punct", "normalization": false, "numericOrdering": false, "strength": 3 }, "collection": "accounts", "db": "sample_airbnb", "keys": [ { "test_field": "1" } ], "options": { "name": "SparseIndexTest", "sparse": true } }
payload.json を作成したら、 同じディレクトリで以下のコマンドを実行します。
atlas api rollingIndex createRollingIndex --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8