Camel.storages.vectordb storages.tidb

​

EnumEncoder

class EnumEncoder(JSONEncoder):

​

default

def default(self, obj):

​

TiDBStorage

class TiDBStorage(BaseVectorStorage):

• vector_dim (int): The dimension of storing vectors.
• url_and_api_key (Optional[Union[Tuple[str, str], str]]): A tuple containing the database url and API key for connecting to a TiDB cluster. The URL should be in the format: “mysql+pymysql://<username>:<password>@<host>:<port>/<db_name>”. TiDB will not use the API Key, but retains the definition for interface compatible.
• collection_name (Optional[str]): Name of the collection. The collection name will be used as the table name in TiDB. If not provided, set it to the current time with iso format. **kwargs (Any): Additional keyword arguments for initializing TiDB connection.

​

init

def __init__(
    self,
    vector_dim: int,
    collection_name: Optional[str] = None,
    url_and_api_key: Optional[Union[Tuple[str, str], str]] = None,
    **kwargs: Any
):

​

_create_client

def _create_client(self, database_url: Optional[str] = None, **kwargs: Any):

• database_url (Optional[str]): The database connection string for the TiDB server. **kwargs: Additional keyword arguments passed to the TiDB client.

​

_get_table_model

def _get_table_model(self, collection_name: str):

​

_open_and_create_table

def _open_and_create_table(self):

​

_check_table

def _check_table(self):

​

_generate_table_name

def _generate_table_name(self):

​

_get_table_info

def _get_table_info(self):

​

_validate_and_convert_vectors

def _validate_and_convert_vectors(self, records: List[VectorRecord]):

• records (List[VectorRecord]): List of vector records to validate and convert.

​

add

def add(self, records: List[VectorRecord], **kwargs):

• records (List[VectorRecord]): List of vectors to be added. **kwargs (Any): Additional keyword arguments pass to insert.

​

delete

def delete(self, ids: List[str], **kwargs: Any):

• ids (List[str]): List of unique identifiers for the vectors to be deleted. **kwargs (Any): Additional keyword arguments passed to delete.

​

status

def status(self):

​

query

def query(self, query: VectorDBQuery, **kwargs: Any):

• query (VectorDBQuery): The query object containing the search vector and the number of top similar vectors to retrieve. **kwargs (Any): Additional keyword arguments passed to search.

​

clear

def clear(self):

​

load

def load(self):

​

client

def client(self):