Atlas クラスター検索インデックス作成
クラスターの検索インデックスを作成します。
このコマンドを使用するには、プロジェクト データアクセス管理者ロールのユーザー アカウントまたは API キーで認証する必要があります。
構文
コマンド構文
atlas clusters search indexes create [indexName] [options]
Arguments
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
indexName | string | false | インデックスの名前。 |
オプション
名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
--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> created.
例
# Create a search index for the cluster named myCluster using a JSON index configuration file named search-config.json: atlas clusters search indexes create --clusterName myCluster --file search-config.json --output json