Overview
このページでは、 C++ドライバーを使用して一般的なタイプのインデックスを操作する方法を示すコピー可能なコード例があります。
Tip
このページに表示されているインデックスの詳細については、各セクションに提供されているリンクを参照してください。
このページの例を使用するには、コード サンプルをサンプル アプリケーションまたは独自のアプリケーションにコピーします。 <connection string>などのコード例にあるすべてのプレースホルダーを、MongoDB 配置に関連する値に置き換えてください。
サンプル アプリケーション
次のサンプルアプリケーションを使用して、このページのコード例をテストできます。 サンプル アプリケーションを使用するには、次の手順を実行します。
プロジェクトが C++ ドライバーをインポートできるロケーションにC++ドライバーがインストールされていることを確認してください。
次のコードをコピーし、プロジェクト内の新しい
.cppファイルに貼り付けます。このページからコード例をコピーし、ファイルのハイライトされたセクション内に貼り付けます。
<iostream>
<bsoncxx/builder/basic/document.hpp> <bsoncxx/json.hpp> <mongocxx/client.hpp> <mongocxx/exception/exception.hpp> <mongocxx/instance.hpp> <mongocxx/uri.hpp>
using bsoncxx::builder::basic::kvp;using bsoncxx::builder::basic::make_document;
int main() { try { mongocxx::instance instance;
mongocxx::uri uri("<connection string>"); mongocxx::client client(uri);
auto database = client["<database name>"]; auto collection = database["<collection name>"];
// Start example code here
// End example code here
} catch (const mongocxx::exception& e) { std::cout << "An exception occurred: " << e.what() << "\n"; return EXIT_FAILURE; } return EXIT_SUCCESS;}単一フィールド インデックス
次のコードは、昇順の単一フィールドインデックスの作成方法を示しています。
auto index_specification = make_document(kvp("<fieldName>", 1));auto result = collection.create_index(index_specification.view());
std::cout << "Index created: " << bsoncxx::to_json(result) << std::endl;単一フィールド インデックスの詳細については、「 単一フィールド インデックスガイド」を参照してください。
複合インデックス
次のコードは、降順の複合インデックスの作成方法を示しています。
auto index_specification = make_document(kvp("<fieldName1>", -1), kvp("<fieldName2>", -1));auto result = collection.create_index(index_specification.view());
std::cout << "Index created: " << bsoncxx::to_json(result) << std::endl;複合インデックスの詳細については、「複合インデックス」のガイドを参照してください。
インデックスを削除する
次のコードは、インデックスを削除する方法を示しています。
collection.indexes().drop_one("<indexName>");
std::cout << "Index dropped." << std::endl;すべてのインデックスを削除する
次のコードは、コレクション内のすべてのインデックスを削除する方法を示しています。
collection.indexes().drop_all();
std::cout << "All indexes removed." << std::endl;MongoDB Search とベクトル検索インデックス マネジメント
次のセクションには、 MongoDB Search およびベクトル検索インデックスを管理する方法を説明するコード例が含まれています。
MongoDB 検索インデックスについて詳しく学ぶには、MongoDB 検索インデックス ガイドを参照してください。
MongoDB Vector Search インデックスの詳細については、 MongoDB Vector Search インデックス のガイドを参照してください。
検索インデックスまたはベクトル検索インデックスの作成
次のコードは、指定されたコレクション内のすべてのサポートされているフィールドを動的にインデックス化するMongoDB 検索インデックスを作成する方法を示しています。
// Create a search index model with your index name and definitionauto siv = collection.search_indexes();auto name = "<searchIndexName>";auto definition = make_document(kvp("mappings", make_document(kvp("dynamic", true))));auto model = mongocxx::search_index_model(name, definition.view());
// Create the search indexauto result = siv.create_one(model);std::cout << "New index name: " << result << std::endl;次のコードは、指定されたフィールドにMongoDB ベクトル検索インデックスを作成する方法を示しています。
// Create a vector search index model with your index name and definitionauto model = mongocxx::search_index_model("<vectorSearchIndexName>",make_document( kvp("fields", make_array(make_document( kvp("type", "vector"), kvp("path", "<fieldName>"), kvp("numDimensions", 2048), kvp("similarity", "dotProduct"), kvp("quantization", "scalar"))))));model.type("vectorSearch");
// Create the vector search indexauto result = siv.create_one(model);std::cout << "New index name: " << result << std::endl;リスト検索とベクトル検索インデックス
次のコードを使用することで、指定されたコレクション内のMongoDB Search およびベクトル検索インデックスのリストが出力されます。
auto siv = collection.search_indexes();auto result = siv.list(); for (const auto &idx : result) { std::cout << bsoncxx::to_json(idx) << std::endl;}検索インデックスまたはベクトル検索インデックスの更新
次のコードは、指定された新しいインデックス定義で既存のMongoDB検索インデックスを更新します。
auto siv = collection.search_indexes();auto update_fields = make_document(kvp("<fieldName>", make_document(kvp("type", "<fieldType>"))));auto update_definition = make_document(kvp("mappings", make_document(kvp("dynamic", false), kvp("fields", update_fields))));siv.update_one("<searchIndexName>", update_definition.view());次のコードは、指定された新しいインデックス定義で既存のMongoDB ベクトル検索インデックスを更新します。
auto siv = collection.search_indexes();auto definition = make_document( kvp("fields", make_array(make_document( kvp("type", "vector"), kvp("path", "<fieldName>"), kvp("numDimensions", 2048), kvp("similarity", "euclidean"), kvp("quantization", "binary")))));siv.update_one("<vectorSearchIndexName>", definition.view());検索インデックスまたはベクトル検索インデックスの削除
次のコードを使用することで、指定された名前のMongoDB Searchインデックスが 1 つ削除されます。
auto siv = collection.search_indexes();siv.drop_one("<searchIndexName>");