File size: 19,345 Bytes
60e3a80 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 |
from functools import cached_property
import json
from chromadb.api.configuration import (
ConfigurationParameter,
EmbeddingsQueueConfigurationInternal,
)
from chromadb.db.base import SqlDB, ParameterValue, get_sql
from chromadb.errors import BatchSizeExceededError
from chromadb.ingest import (
Producer,
Consumer,
ConsumerCallbackFn,
decode_vector,
encode_vector,
)
from chromadb.types import (
OperationRecord,
LogRecord,
ScalarEncoding,
SeqId,
Operation,
)
from chromadb.config import System
from chromadb.telemetry.opentelemetry import (
OpenTelemetryClient,
OpenTelemetryGranularity,
trace_method,
)
from overrides import override
from collections import defaultdict
from typing import Sequence, Optional, Dict, Set, Tuple, cast
from uuid import UUID
from pypika import Table, functions
import uuid
import logging
from chromadb.ingest.impl.utils import create_topic_name
logger = logging.getLogger(__name__)
_operation_codes = {
Operation.ADD: 0,
Operation.UPDATE: 1,
Operation.UPSERT: 2,
Operation.DELETE: 3,
}
_operation_codes_inv = {v: k for k, v in _operation_codes.items()}
# Set in conftest.py to rethrow errors in the "async" path during testing
# https://doc.pytest.org/en/latest/example/simple.html#detect-if-running-from-within-a-pytest-run
_called_from_test = False
class SqlEmbeddingsQueue(SqlDB, Producer, Consumer):
"""A SQL database that stores embeddings, allowing a traditional RDBMS to be used as
the primary ingest queue and satisfying the top level Producer/Consumer interfaces.
Note that this class is only suitable for use cases where the producer and consumer
are in the same process.
This is because notification of new embeddings happens solely in-process: this
implementation does not actively listen to the the database for new records added by
other processes.
"""
class Subscription:
id: UUID
topic_name: str
start: int
end: int
callback: ConsumerCallbackFn
def __init__(
self,
id: UUID,
topic_name: str,
start: int,
end: int,
callback: ConsumerCallbackFn,
):
self.id = id
self.topic_name = topic_name
self.start = start
self.end = end
self.callback = callback
_subscriptions: Dict[str, Set[Subscription]]
_max_batch_size: Optional[int]
_tenant: str
_topic_namespace: str
# How many variables are in the insert statement for a single record
VARIABLES_PER_RECORD = 6
def __init__(self, system: System):
self._subscriptions = defaultdict(set)
self._max_batch_size = None
self._opentelemetry_client = system.require(OpenTelemetryClient)
self._tenant = system.settings.require("tenant_id")
self._topic_namespace = system.settings.require("topic_namespace")
super().__init__(system)
@trace_method("SqlEmbeddingsQueue.reset_state", OpenTelemetryGranularity.ALL)
@override
def reset_state(self) -> None:
super().reset_state()
self._subscriptions = defaultdict(set)
# Invalidate the cached property
try:
del self.config
except AttributeError:
# Cached property hasn't been accessed yet
pass
@trace_method("SqlEmbeddingsQueue.delete_topic", OpenTelemetryGranularity.ALL)
@override
def delete_log(self, collection_id: UUID) -> None:
topic_name = create_topic_name(
self._tenant, self._topic_namespace, collection_id
)
t = Table("embeddings_queue")
q = (
self.querybuilder()
.from_(t)
.where(t.topic == ParameterValue(topic_name))
.delete()
)
with self.tx() as cur:
sql, params = get_sql(q, self.parameter_format())
cur.execute(sql, params)
@trace_method("SqlEmbeddingsQueue.purge_log", OpenTelemetryGranularity.ALL)
@override
def purge_log(self, collection_id: UUID) -> None:
# (We need to purge on a per topic/collection basis, because the maximum sequence ID is tracked on a per topic/collection basis.)
segments_t = Table("segments")
segment_ids_q = (
self.querybuilder()
.from_(segments_t)
# This coalesce prevents a correctness bug when > 1 segments exist and:
# - > 1 has written to the max_seq_id table
# - > 1 has not never written to the max_seq_id table
# In that case, we should not delete any WAL entries as we can't be sure that the all segments are caught up.
.select(functions.Coalesce(Table("max_seq_id").seq_id, -1))
.where(
segments_t.collection == ParameterValue(self.uuid_to_db(collection_id))
)
.left_join(Table("max_seq_id"))
.on(segments_t.id == Table("max_seq_id").segment_id)
)
topic_name = create_topic_name(
self._tenant, self._topic_namespace, collection_id
)
with self.tx() as cur:
sql, params = get_sql(segment_ids_q, self.parameter_format())
cur.execute(sql, params)
results = cur.fetchall()
if results:
min_seq_id = min(self.decode_seq_id(row[0]) for row in results)
else:
return
t = Table("embeddings_queue")
q = (
self.querybuilder()
.from_(t)
.where(t.seq_id < ParameterValue(min_seq_id))
.where(t.topic == ParameterValue(topic_name))
.delete()
)
sql, params = get_sql(q, self.parameter_format())
cur.execute(sql, params)
@trace_method("SqlEmbeddingsQueue.submit_embedding", OpenTelemetryGranularity.ALL)
@override
def submit_embedding(
self, collection_id: UUID, embedding: OperationRecord
) -> SeqId:
if not self._running:
raise RuntimeError("Component not running")
return self.submit_embeddings(collection_id, [embedding])[0]
@trace_method("SqlEmbeddingsQueue.submit_embeddings", OpenTelemetryGranularity.ALL)
@override
def submit_embeddings(
self, collection_id: UUID, embeddings: Sequence[OperationRecord]
) -> Sequence[SeqId]:
if not self._running:
raise RuntimeError("Component not running")
if len(embeddings) == 0:
return []
if len(embeddings) > self.max_batch_size:
raise BatchSizeExceededError(
f"""
Cannot submit more than {self.max_batch_size:,} embeddings at once.
Please submit your embeddings in batches of size
{self.max_batch_size:,} or less.
"""
)
# This creates the persisted configuration if it doesn't exist.
# It should be run as soon as possible (before any WAL mutations) since the default configuration depends on the WAL size.
# (We can't run this in __init__()/start() because the migrations have not been run at that point and the table may not be available.)
_ = self.config
topic_name = create_topic_name(
self._tenant, self._topic_namespace, collection_id
)
t = Table("embeddings_queue")
insert = (
self.querybuilder()
.into(t)
.columns(t.operation, t.topic, t.id, t.vector, t.encoding, t.metadata)
)
id_to_idx: Dict[str, int] = {}
for embedding in embeddings:
(
embedding_bytes,
encoding,
metadata,
) = self._prepare_vector_encoding_metadata(embedding)
insert = insert.insert(
ParameterValue(_operation_codes[embedding["operation"]]),
ParameterValue(topic_name),
ParameterValue(embedding["id"]),
ParameterValue(embedding_bytes),
ParameterValue(encoding),
ParameterValue(metadata),
)
id_to_idx[embedding["id"]] = len(id_to_idx)
with self.tx() as cur:
sql, params = get_sql(insert, self.parameter_format())
# The returning clause does not guarantee order, so we need to do reorder
# the results. https://www.sqlite.org/lang_returning.html
sql = f"{sql} RETURNING seq_id, id" # Pypika doesn't support RETURNING
results = cur.execute(sql, params).fetchall()
# Reorder the results
seq_ids = [cast(SeqId, None)] * len(
results
) # Lie to mypy: https://stackoverflow.com/questions/76694215/python-type-casting-when-preallocating-list
embedding_records = []
for seq_id, id in results:
seq_ids[id_to_idx[id]] = seq_id
submit_embedding_record = embeddings[id_to_idx[id]]
# We allow notifying consumers out of order relative to one call to
# submit_embeddings so we do not reorder the records before submitting them
embedding_record = LogRecord(
log_offset=seq_id,
record=OperationRecord(
id=id,
embedding=submit_embedding_record["embedding"],
encoding=submit_embedding_record["encoding"],
metadata=submit_embedding_record["metadata"],
operation=submit_embedding_record["operation"],
),
)
embedding_records.append(embedding_record)
self._notify_all(topic_name, embedding_records)
if self.config.get_parameter("automatically_purge").value:
self.purge_log(collection_id)
return seq_ids
@trace_method("SqlEmbeddingsQueue.subscribe", OpenTelemetryGranularity.ALL)
@override
def subscribe(
self,
collection_id: UUID,
consume_fn: ConsumerCallbackFn,
start: Optional[SeqId] = None,
end: Optional[SeqId] = None,
id: Optional[UUID] = None,
) -> UUID:
if not self._running:
raise RuntimeError("Component not running")
topic_name = create_topic_name(
self._tenant, self._topic_namespace, collection_id
)
subscription_id = id or uuid.uuid4()
start, end = self._validate_range(start, end)
subscription = self.Subscription(
subscription_id, topic_name, start, end, consume_fn
)
# Backfill first, so if it errors we do not add the subscription
self._backfill(subscription)
self._subscriptions[topic_name].add(subscription)
return subscription_id
@trace_method("SqlEmbeddingsQueue.unsubscribe", OpenTelemetryGranularity.ALL)
@override
def unsubscribe(self, subscription_id: UUID) -> None:
for topic_name, subscriptions in self._subscriptions.items():
for subscription in subscriptions:
if subscription.id == subscription_id:
subscriptions.remove(subscription)
if len(subscriptions) == 0:
del self._subscriptions[topic_name]
return
@override
def min_seqid(self) -> SeqId:
return -1
@override
def max_seqid(self) -> SeqId:
return 2**63 - 1
@property
@trace_method("SqlEmbeddingsQueue.max_batch_size", OpenTelemetryGranularity.ALL)
@override
def max_batch_size(self) -> int:
if self._max_batch_size is None:
with self.tx() as cur:
cur.execute("PRAGMA compile_options;")
compile_options = cur.fetchall()
for option in compile_options:
if "MAX_VARIABLE_NUMBER" in option[0]:
# The pragma returns a string like 'MAX_VARIABLE_NUMBER=999'
self._max_batch_size = int(option[0].split("=")[1]) // (
self.VARIABLES_PER_RECORD
)
if self._max_batch_size is None:
# This value is the default for sqlite3 versions < 3.32.0
# It is the safest value to use if we can't find the pragma for some
# reason
self._max_batch_size = 999 // self.VARIABLES_PER_RECORD
return self._max_batch_size
@trace_method(
"SqlEmbeddingsQueue._prepare_vector_encoding_metadata",
OpenTelemetryGranularity.ALL,
)
def _prepare_vector_encoding_metadata(
self, embedding: OperationRecord
) -> Tuple[Optional[bytes], Optional[str], Optional[str]]:
if embedding["embedding"] is not None:
encoding_type = cast(ScalarEncoding, embedding["encoding"])
encoding = encoding_type.value
embedding_bytes = encode_vector(embedding["embedding"], encoding_type)
else:
embedding_bytes = None
encoding = None
metadata = json.dumps(embedding["metadata"]) if embedding["metadata"] else None
return embedding_bytes, encoding, metadata
@trace_method("SqlEmbeddingsQueue._backfill", OpenTelemetryGranularity.ALL)
def _backfill(self, subscription: Subscription) -> None:
"""Backfill the given subscription with any currently matching records in the
DB"""
t = Table("embeddings_queue")
q = (
self.querybuilder()
.from_(t)
.where(t.topic == ParameterValue(subscription.topic_name))
.where(t.seq_id > ParameterValue(subscription.start))
.where(t.seq_id <= ParameterValue(subscription.end))
.select(t.seq_id, t.operation, t.id, t.vector, t.encoding, t.metadata)
.orderby(t.seq_id)
)
with self.tx() as cur:
sql, params = get_sql(q, self.parameter_format())
cur.execute(sql, params)
rows = cur.fetchall()
for row in rows:
if row[3]:
encoding = ScalarEncoding(row[4])
vector = decode_vector(row[3], encoding)
else:
encoding = None
vector = None
self._notify_one(
subscription,
[
LogRecord(
log_offset=row[0],
record=OperationRecord(
operation=_operation_codes_inv[row[1]],
id=row[2],
embedding=vector,
encoding=encoding,
metadata=json.loads(row[5]) if row[5] else None,
),
)
],
)
@trace_method("SqlEmbeddingsQueue._validate_range", OpenTelemetryGranularity.ALL)
def _validate_range(
self, start: Optional[SeqId], end: Optional[SeqId]
) -> Tuple[int, int]:
"""Validate and normalize the start and end SeqIDs for a subscription using this
impl."""
start = start or self._next_seq_id()
end = end or self.max_seqid()
if not isinstance(start, int) or not isinstance(end, int):
raise TypeError("SeqIDs must be integers for sql-based EmbeddingsDB")
if start >= end:
raise ValueError(f"Invalid SeqID range: {start} to {end}")
return start, end
@trace_method("SqlEmbeddingsQueue._next_seq_id", OpenTelemetryGranularity.ALL)
def _next_seq_id(self) -> int:
"""Get the next SeqID for this database."""
t = Table("embeddings_queue")
q = self.querybuilder().from_(t).select(functions.Max(t.seq_id))
with self.tx() as cur:
cur.execute(q.get_sql())
return int(cur.fetchone()[0]) + 1
@trace_method("SqlEmbeddingsQueue._notify_all", OpenTelemetryGranularity.ALL)
def _notify_all(self, topic: str, embeddings: Sequence[LogRecord]) -> None:
"""Send a notification to each subscriber of the given topic."""
if self._running:
for sub in self._subscriptions[topic]:
self._notify_one(sub, embeddings)
@trace_method("SqlEmbeddingsQueue._notify_one", OpenTelemetryGranularity.ALL)
def _notify_one(self, sub: Subscription, embeddings: Sequence[LogRecord]) -> None:
"""Send a notification to a single subscriber."""
# Filter out any embeddings that are not in the subscription range
should_unsubscribe = False
filtered_embeddings = []
for embedding in embeddings:
if embedding["log_offset"] <= sub.start:
continue
if embedding["log_offset"] > sub.end:
should_unsubscribe = True
break
filtered_embeddings.append(embedding)
# Log errors instead of throwing them to preserve async semantics
# for consistency between local and distributed configurations
try:
if len(filtered_embeddings) > 0:
sub.callback(filtered_embeddings)
if should_unsubscribe:
self.unsubscribe(sub.id)
except BaseException as e:
logger.error(
f"Exception occurred invoking consumer for subscription {sub.id.hex}"
+ f"to topic {sub.topic_name} %s",
str(e),
)
if _called_from_test:
raise e
@cached_property
def config(self) -> EmbeddingsQueueConfigurationInternal:
t = Table("embeddings_queue_config")
q = self.querybuilder().from_(t).select(t.config_json_str).limit(1)
with self.tx() as cur:
cur.execute(q.get_sql())
result = cur.fetchone()
if result is None:
is_fresh_system = self._get_wal_size() == 0
config = EmbeddingsQueueConfigurationInternal(
[ConfigurationParameter("automatically_purge", is_fresh_system)]
)
self.set_config(config)
return config
return EmbeddingsQueueConfigurationInternal.from_json_str(result[0])
def set_config(self, config: EmbeddingsQueueConfigurationInternal) -> None:
with self.tx() as cur:
cur.execute(
"""
INSERT OR REPLACE INTO embeddings_queue_config (id, config_json_str)
VALUES (?, ?)
""",
(
1,
config.to_json_str(),
),
)
# Invalidate the cached property
try:
del self.config
except AttributeError:
# Cached property hasn't been accessed yet
pass
def _get_wal_size(self) -> int:
t = Table("embeddings_queue")
q = self.querybuilder().from_(t).select(functions.Count("*"))
with self.tx() as cur:
cur.execute(q.get_sql())
return int(cur.fetchone()[0])
|