Atlas クラスター検索インデックスの更新
クラスターの検索インデックスを変更します。
このコマンドを使用するには、プロジェクト データアクセス管理者ロールのユーザー アカウントまたは API キーで認証する必要があります。
構文
コマンド構文
atlas clusters search indexes update <indexId> [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
indexId | string | true | インデックスの ID。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--clusterName | string | true | クラスターの名前。 詳しくは、 https://docub.mongodb.org/core/create-cluster-api を参照してください。 |
-f, --file | string | false | 使用する JSON インデックス構成ファイルの名前。 Atlas Search および Atlas Vector Search インデックス構成ファイルの詳細については、 https://docub.mongodb.org/core/search-index-config-file-atlascli を参照してください。 。Atlas Search インデックスの構文と構成ファイルで定義できるオプションの詳細については、 https://docub.mongodb.org/core/index-defineds-fts を参照してください。 。Atlas Vector Search インデックス構文と構成ファイルで定義できるオプションの詳細については、 https://docub.mongodb.org/core/index-defined-avs を参照してください。 |
-h, --help | false | 更新のヘルプ | |
-o, --output | string | false | 出力形式。 有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。 完全な出力を表示するには、 -o JSONオプションを使用します。 |
--projectId | string | false | 使用するプロジェクトを識別する 16 進数の string。 このオプションは、構成ファイルまたは環境変数の 設定を上書きします。 |
継承されたオプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
-P, --profile | string | false | 構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。 |
出力
コマンドが成功すると、CLI は次のサンプルのような出力を返します。 括弧内の値は 値を表します。
Index <Name> updated.
例
# Modify the search index with the ID 5f2099cd683fc55fbb30bef6 for the cluster named myCluster: atlas clusters search indexes update 5f2099cd683fc55fbb30bef6 --clusterName myCluster --output json