Add qdrant cli

Author: s-h-a-d-o-w

vectordb_bench/backend/clients/qdrant_cloud/cli.py

@@ -0,0 +1,43 @@
+from typing import Annotated, Unpack
+
+import click
+from pydantic import SecretStr
+
+from ....cli.cli import (
+    CommonTypedDict,
+    cli,
+    click_parameter_decorators_from_typed_dict,
+    run,
+)
+from .. import DB
+
+
+class QdrantTypedDict(CommonTypedDict):
+    url: Annotated[
+        str,
+        click.option("--url", type=str, help="URL connection string", required=True),
+    ]
+    api_key: Annotated[
+        str | None,
+        click.option("--api-key", type=str, help="API key for authentication", required=False),
+    ]
+
+
+@cli.command()
+@click_parameter_decorators_from_typed_dict(QdrantTypedDict)
+def QdrantCloud(**parameters: Unpack[QdrantTypedDict]):
+    from .config import QdrantConfig, QdrantIndexConfig
+
+    config_params = {
+        "db_label": parameters["db_label"],
+        "url": SecretStr(parameters["url"]),
+    }
+
+    config_params["api_key"] = SecretStr(parameters["api_key"]) if parameters["api_key"] else None
+
+    run(
+        db=DB.QdrantCloud,
+        db_config=QdrantConfig(**config_params),
+        db_case_config=QdrantIndexConfig(),
+        **parameters,
+    )

vectordb_bench/backend/clients/qdrant_cloud/config.py

@@ -6,14 +6,14 @@
 # Allowing `api_key` to be left empty, to ensure compatibility with the open-source Qdrant.
 class QdrantConfig(DBConfig):
     url: SecretStr
-    api_key: SecretStr
+    api_key: SecretStr | None = None
 
     def to_dict(self) -> dict:
-        api_key = self.api_key.get_secret_value()
-        if len(api_key) > 0:
+        api_key_value = self.api_key.get_secret_value() if self.api_key else None
+        if api_key_value:
             return {
                 "url": self.url.get_secret_value(),
-                "api_key": self.api_key.get_secret_value(),
+                "api_key": api_key_value,
                 "prefer_grpc": True,
             }
         return {

vectordb_bench/cli/vectordbbench.py

@@ -9,6 +9,7 @@
 from ..backend.clients.pgvecto_rs.cli import PgVectoRSHNSW, PgVectoRSIVFFlat
 from ..backend.clients.pgvector.cli import PgVectorHNSW
 from ..backend.clients.pgvectorscale.cli import PgVectorScaleDiskAnn
+from ..backend.clients.qdrant_cloud.cli import QdrantCloud
 from ..backend.clients.redis.cli import Redis
 from ..backend.clients.test.cli import Test
 from ..backend.clients.tidb.cli import TiDB
@@ -35,6 +36,7 @@
 cli.add_command(Clickhouse)
 cli.add_command(Vespa)
 cli.add_command(LanceDB)
+cli.add_command(QdrantCloud)
 
 
 if __name__ == "__main__":

vectordb_bench/frontend/components/run_test/dbConfigSetting.py

@@ -36,21 +36,27 @@ def dbConfigSettingItem(st, activeDb: DB):
     columns = st.columns(DB_CONFIG_SETTING_COLUMNS)
 
     dbConfigClass = activeDb.config_cls
-    properties = dbConfigClass.schema().get("properties")
+    schema = dbConfigClass.schema()
+    property_items = schema.get("properties").items()
+    required_fields = set(schema.get("required", []))
     dbConfig = {}
     idx = 0
 
     # db config (unique)
-    for key, property in properties.items():
+    for key, property in property_items:
         if key not in dbConfigClass.common_short_configs() and key not in dbConfigClass.common_long_configs():
             column = columns[idx % DB_CONFIG_SETTING_COLUMNS]
             idx += 1
-            dbConfig[key] = column.text_input(
+            input_value = column.text_input(
                 key,
-                key="%s-%s" % (activeDb.name, key),
+                key=f"{activeDb.name}-{key}",
                 value=property.get("default", ""),
                 type="password" if inputIsPassword(key) else "default",
+                placeholder="optional" if key not in required_fields else None,
             )
+            if key in required_fields or input_value:
+                dbConfig[key] = input_value
+
     # db config (common short labels)
     for key in dbConfigClass.common_short_configs():
         column = columns[idx % DB_CONFIG_SETTING_COLUMNS]