Camel.storages.vectordb storages.surreal

​

SurrealStorage

class SurrealStorage(BaseVectorStorage):

• url (str): WebSocket URL for connecting to SurrealDB (default: “ws://localhost:8000/rpc”).
• table (str): Name of the table used for storing vectors (default: “vector_store”).
• vector_dim (int): Dimensionality of the stored vectors.
• distance (VectorDistance): Distance metric used for similarity comparisons (default: VectorDistance.COSINE).
• namespace (str): SurrealDB namespace to use (default: “default”). (default: "default")
• database (str): SurrealDB database name (default: “demo”). (default: "demo")
• user (str): Username for authentication (default: “root”). (default: "root")
• password (str): Password for authentication (default: “root”). (default: "root")

• SurrealDB supports flexible schema and powerful querying capabilities via SQL-like syntax over WebSocket.
• This implementation manages connection setup and ensures the target table exists.
• Suitable for applications requiring distributed vector storage and search with real-time updates.

​

init

def __init__(self):

• url (str): WebSocket URL for connecting to SurrealDB. (default: :obj:"ws://localhost:8000/rpc")
• table (str): Name of the table used for vector storage. (default: :obj:"vector_store")
• vector_dim (int): Dimensionality of the stored vectors. (default: :obj:786)
• distance (VectorDistance): Distance metric for similarity searches. (default: :obj:VectorDistance.COSINE)
• namespace (str): SurrealDB namespace to use. (default: :obj:"default")
• database (str): SurrealDB database name. (default: :obj:"demo")
• user (str): Username for authentication. (default: :obj:"root")
• password (str): Password for authentication. (default: :obj:"root")

​

_table_exists

def _table_exists(self):

​

_get_table_info

def _get_table_info(self):

​

_create_table

def _create_table(self):

​

_drop_table

def _drop_table(self):

​

_check_and_create_table

def _check_and_create_table(self):

​

_validate_and_convert_records

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

• records (List[VectorRecord]): List of vector records to insert.

​

query

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

• query (VectorDBQuery): Query containing the query vector and top_k value.

​

add

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

• records (List[VectorRecord]): List of vector records to add.

​

delete

def delete(
    self,
    ids: Optional[List[str]] = None,
    if_all: bool = False,
    **kwargs
):

• ids (Optional[List[str]]): List of record IDs to delete.
• if_all (bool): Whether to delete all records in the table.

​

status

def status(self):

​

clear

def clear(self):

​

load

def load(self):

​

client

def client(self):