Load an Existing Encrypted Index

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:

Python

import cyborgdb_core as cyborgdb
# or import cyborgdb_lite as cyborgdb
import secrets

# Using `memory` storage for this example
index_location = cyborgdb.DBConfig("memory") 
config_location = cyborgdb.DBConfig("memory")

# Get your API key
api_key = "your_api_key_here"  # Replace with your actual API key

# Create a client
client = cyborgdb.Client(
    api_key=api_key, 
    index_location=index_location, 
    config_location=config_location
)

# Provide the index key used when creating the index
index_key = secrets.token_bytes(32)

# Create an encrypted index
index = client.load_index(
    index_name="my_index", 
    index_key=index_key
)

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 more details, see Managing Encryption Keys.

Encrypted Index Caching

For improved query performance, you can enable encrypted index caching by setting a max_cache_size:

Python

import cyborgdb_core as cyborgdb
# or import cyborgdb_lite as cyborgdb
import secrets

# Using `memory` storage for this example
index_location = cyborgdb.DBConfig("memory") 
config_location = cyborgdb.DBConfig("memory")

# Get your API key
api_key = "your_api_key_here"  # Replace with your actual API key

# Create a client
client = cyborgdb.Client(
    api_key=api_key, 
    index_location=index_location, 
    config_location=config_location
)

# Generate an encryption key for the index
index_key = secrets.token_bytes(32)

# Set max cache size at 1MB
max_cache_size = 1000000

# Create an encrypted index
index = client.load_index(
    index_name="my_index", 
    index_key=index_key, 
    max_cache_size=max_cache_size
)

The maximum cache size is specified in megabytes. When the cache reaches this size, the least recently used entries will be evicted.

API Reference

For more information on loading an encrypted index, refer to the API reference:

Python API Reference

API reference for load_index() in Python

C++ API Reference

API reference for LoadIndex() in C++