|
| 1 | +import logging |
| 2 | +from contextlib import contextmanager |
| 3 | + |
| 4 | +import mysql.connector as mysql |
| 5 | +import numpy as np |
| 6 | + |
| 7 | +from ..api import VectorDB |
| 8 | +from .config import AliSQLConfigDict, AliSQLIndexConfig |
| 9 | + |
| 10 | +log = logging.getLogger(__name__) |
| 11 | + |
| 12 | + |
| 13 | +class AliSQL(VectorDB): |
| 14 | + def __init__( |
| 15 | + self, |
| 16 | + dim: int, |
| 17 | + db_config: AliSQLConfigDict, |
| 18 | + db_case_config: AliSQLIndexConfig, |
| 19 | + collection_name: str = "vec_collection", |
| 20 | + drop_old: bool = False, |
| 21 | + **kwargs, |
| 22 | + ): |
| 23 | + self.name = "AliSQL" |
| 24 | + self.db_config = db_config |
| 25 | + self.case_config = db_case_config |
| 26 | + self.db_name = "vectordbbench" |
| 27 | + self.table_name = collection_name |
| 28 | + self.dim = dim |
| 29 | + |
| 30 | + # construct basic units |
| 31 | + self.conn, self.cursor = self._create_connection() |
| 32 | + |
| 33 | + if drop_old: |
| 34 | + self._drop_db() |
| 35 | + self._create_db_table(dim) |
| 36 | + |
| 37 | + self.cursor.close() |
| 38 | + self.conn.close() |
| 39 | + self.cursor = None |
| 40 | + self.conn = None |
| 41 | + |
| 42 | + def _create_connection(self): |
| 43 | + conn = mysql.connect( |
| 44 | + host=self.db_config["host"], |
| 45 | + user=self.db_config["user"], |
| 46 | + port=self.db_config["port"], |
| 47 | + password=self.db_config["password"], |
| 48 | + buffered=True, |
| 49 | + ) |
| 50 | + cursor = conn.cursor() |
| 51 | + |
| 52 | + assert conn is not None, "Connection is not initialized" |
| 53 | + assert cursor is not None, "Cursor is not initialized" |
| 54 | + |
| 55 | + return conn, cursor |
| 56 | + |
| 57 | + def _drop_db(self): |
| 58 | + assert self.conn is not None, "Connection is not initialized" |
| 59 | + assert self.cursor is not None, "Cursor is not initialized" |
| 60 | + log.info(f"{self.name} client drop db : {self.db_name}") |
| 61 | + |
| 62 | + # flush tables before dropping database to avoid some locking issue |
| 63 | + self.cursor.execute("FLUSH TABLES") |
| 64 | + self.cursor.execute(f"DROP DATABASE IF EXISTS {self.db_name}") |
| 65 | + self.cursor.execute("COMMIT") |
| 66 | + self.cursor.execute("FLUSH TABLES") |
| 67 | + |
| 68 | + def _create_db_table(self, dim: int): |
| 69 | + assert self.conn is not None, "Connection is not initialized" |
| 70 | + assert self.cursor is not None, "Cursor is not initialized" |
| 71 | + |
| 72 | + index_param = self.case_config.index_param() |
| 73 | + |
| 74 | + try: |
| 75 | + log.info(f"{self.name} client create database : {self.db_name}") |
| 76 | + self.cursor.execute(f"CREATE DATABASE {self.db_name}") |
| 77 | + |
| 78 | + log.info(f"{self.name} client create table : {self.table_name}") |
| 79 | + self.cursor.execute(f"USE {self.db_name}") |
| 80 | + |
| 81 | + self.cursor.execute( |
| 82 | + f""" |
| 83 | + CREATE TABLE {self.table_name} ( |
| 84 | + id INT PRIMARY KEY, |
| 85 | + v VECTOR({self.dim}) NOT NULL |
| 86 | + ) |
| 87 | + """ |
| 88 | + ) |
| 89 | + self.cursor.execute("COMMIT") |
| 90 | + |
| 91 | + except Exception as e: |
| 92 | + log.warning(f"Failed to create table: {self.table_name} error: {e}") |
| 93 | + raise e from None |
| 94 | + |
| 95 | + @contextmanager |
| 96 | + def init(self): |
| 97 | + """create and destory connections to database. |
| 98 | +
|
| 99 | + Examples: |
| 100 | + >>> with self.init(): |
| 101 | + >>> self.insert_embeddings() |
| 102 | + """ |
| 103 | + self.conn, self.cursor = self._create_connection() |
| 104 | + |
| 105 | + index_param = self.case_config.index_param() |
| 106 | + search_param = self.case_config.search_param() |
| 107 | + |
| 108 | + # maximize allowed package size |
| 109 | + self.cursor.execute("SET GLOBAL max_allowed_packet = 1073741824") |
| 110 | + |
| 111 | + if index_param["index_type"] == "HNSW": |
| 112 | + if index_param["cache_size"] is not None: |
| 113 | + self.cursor.execute(f"SET GLOBAL vidx_hnsw_cache_size = {index_param['cache_size']}") |
| 114 | + if search_param["ef_search"] is not None: |
| 115 | + self.cursor.execute(f"SET GLOBAL vidx_hnsw_ef_search = {search_param['ef_search']}") |
| 116 | + self.cursor.execute("COMMIT") |
| 117 | + |
| 118 | + self.insert_sql = f"INSERT INTO {self.db_name}.{self.table_name} (id, v) VALUES (%s, %s)" # noqa: S608 |
| 119 | + self.select_sql = ( |
| 120 | + f"SELECT id FROM {self.db_name}.{self.table_name} " # noqa: S608 |
| 121 | + f"ORDER by vec_distance_{search_param['metric_type']}(v, %s) LIMIT %s" |
| 122 | + ) |
| 123 | + self.select_sql_with_filter = ( |
| 124 | + f"SELECT id FROM {self.db_name}.{self.table_name} WHERE id >= %s " # noqa: S608 |
| 125 | + f"ORDER by vec_distance_{search_param['metric_type']}(v, %s) LIMIT %s" |
| 126 | + ) |
| 127 | + |
| 128 | + try: |
| 129 | + yield |
| 130 | + finally: |
| 131 | + self.cursor.close() |
| 132 | + self.conn.close() |
| 133 | + self.cursor = None |
| 134 | + self.conn = None |
| 135 | + |
| 136 | + def ready_to_load(self) -> bool: |
| 137 | + pass |
| 138 | + |
| 139 | + def optimize(self, data_size: int) -> None: |
| 140 | + assert self.conn is not None, "Connection is not initialized" |
| 141 | + assert self.cursor is not None, "Cursor is not initialized" |
| 142 | + |
| 143 | + index_param = self.case_config.index_param() |
| 144 | + |
| 145 | + try: |
| 146 | + index_options = f"DISTANCE={index_param['metric_type']}" |
| 147 | + if index_param["index_type"] == "HNSW" and index_param["M"] is not None: |
| 148 | + index_options += f" M={index_param['M']}" |
| 149 | + |
| 150 | + self.cursor.execute( |
| 151 | + f""" |
| 152 | + ALTER TABLE {self.db_name}.{self.table_name} |
| 153 | + ADD VECTOR KEY v(v) {index_options} |
| 154 | + """ |
| 155 | + ) |
| 156 | + self.cursor.execute("COMMIT") |
| 157 | + |
| 158 | + except Exception as e: |
| 159 | + log.warning(f"Failed to create index: {self.table_name} error: {e}") |
| 160 | + raise e from None |
| 161 | + |
| 162 | + @staticmethod |
| 163 | + def vector_to_hex(v): # noqa: ANN001 |
| 164 | + return np.array(v, "float32").tobytes() |
| 165 | + |
| 166 | + def insert_embeddings( |
| 167 | + self, |
| 168 | + embeddings: list[list[float]], |
| 169 | + metadata: list[int], |
| 170 | + **kwargs, |
| 171 | + ) -> tuple[int, Exception]: |
| 172 | + """Insert embeddings into the database. |
| 173 | + Should call self.init() first. |
| 174 | + """ |
| 175 | + assert self.conn is not None, "Connection is not initialized" |
| 176 | + assert self.cursor is not None, "Cursor is not initialized" |
| 177 | + |
| 178 | + try: |
| 179 | + metadata_arr = np.array(metadata) |
| 180 | + embeddings_arr = np.array(embeddings) |
| 181 | + |
| 182 | + batch_data = [] |
| 183 | + for i, row in enumerate(metadata_arr): |
| 184 | + batch_data.append((int(row), self.vector_to_hex(embeddings_arr[i]))) |
| 185 | + |
| 186 | + self.cursor.executemany(self.insert_sql, batch_data) |
| 187 | + self.cursor.execute("COMMIT") |
| 188 | + self.cursor.execute("FLUSH TABLES") |
| 189 | + |
| 190 | + return len(metadata), None |
| 191 | + except Exception as e: |
| 192 | + log.warning(f"Failed to insert data into Vector table ({self.table_name}), error: {e}") |
| 193 | + return 0, e |
| 194 | + |
| 195 | + def search_embedding( |
| 196 | + self, |
| 197 | + query: list[float], |
| 198 | + k: int = 100, |
| 199 | + filters: dict | None = None, |
| 200 | + timeout: int | None = None, |
| 201 | + **kwargs, |
| 202 | + ) -> list[int]: |
| 203 | + assert self.conn is not None, "Connection is not initialized" |
| 204 | + assert self.cursor is not None, "Cursor is not initialized" |
| 205 | + |
| 206 | + search_param = self.case_config.search_param() # noqa: F841 |
| 207 | + |
| 208 | + try: |
| 209 | + if filters: |
| 210 | + self.cursor.execute(self.select_sql_with_filter, (filters.get("id"), self.vector_to_hex(query), k)) |
| 211 | + else: |
| 212 | + self.cursor.execute(self.select_sql, (self.vector_to_hex(query), k)) |
| 213 | + return [row[0] for row in self.cursor.fetchall()] |
| 214 | + |
| 215 | + except mysql.Error: |
| 216 | + log.exception("Failed to execute search query") |
| 217 | + raise |
0 commit comments