If you’ve previously created an encrypted index, you can connect to it to add, query or delete data from it. You will need to know the index’s name as well as its key to do so:
import cyborg_vector_search_py as cvs# Using `memory` storage for this exampleindex_location = cvs.DBConfig("memory") config_location = cvs.DBConfig("memory")# Create a clientclient = cvs.Client(index_location, config_location)# Provide the index key used when creating the index# Example key (32 bytes)index_key = bytes(32)# Create an encrypted indexindex = client.load_index("my_index", index_key)
#include "cyborg_vector_search/client.hpp"#include "cyborg_vector_search/encrypted_index.hpp"#include <array>// Using `memory` storage for this examplecyborg::LocationConfig index_location(Location::kMemory); cyborg::LocationConfig config_location(Location::kMemory);// Create a clientcyborg::Client client(index_location, config_location);// Provide the index key used when creating the index// Example key (32 bytes)std::array<uint8_t, 32> index_key;// Create an encrypted indexcyborg::EncryptedIndex index = client.LoadIndex("my_index", index_key);
This creates a new encrypted index with the IVFFlat type. For more details on IVFFlat and other index options, see Configure an Encrypted Index.
You will need to replace index_key with your own index encryption key.
For production use, we recommend that you use an HSM or KMS solution.
For improved query performance, you can enable encrypted index caching by setting a max_cache_size:
import cyborg_vector_search_py as cvsimport secrets# Using `memory` storage for this exampleindex_location = cvs.DBConfig("memory") config_location = cvs.DBConfig("memory")# Create a clientclient = cvs.Client(index_location, config_location)# Generate an encryption key for the indexindex_key = secrets.token_bytes(32)# Set max cache size at 1MBmax_cache_size = 1000000# Create an encrypted indexindex = client.load_index("my_index", index_key, max_cache_size)
#include "cyborg_vector_search/client.hpp"#include "cyborg_vector_search/encrypted_index.hpp"#include <array>#include <random>// Using `memory` storage for this examplecyborg::LocationConfig index_location(Location::kMemory); cyborg::LocationConfig config_location(Location::kMemory);// Create a clientcyborg::Client client(index_location, config_location);// Generate a 32-byte random encryption keystd::array<uint8_t, 32> index_key;std::random_device rd;std::generate(index_key.begin(), index_key.end(), [&]() { return rd() % 256; });// Set max cache size at 1MBstd::size_t max_cache_size = 1000000;// Create an encrypted indexcyborg::EncryptedIndex index = client.LoadIndex("my_index", index_key, max_cache_size);
