rushdb 2.2.0__tar.gz → 2.6.0__tar.gz

{rushdb-2.2.0 → rushdb-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rushdb
-Version: 2.2.0
+Version: 2.6.0
 Summary: RushDB Python SDK — memory layer for AI agents and modern apps
 Project-URL: Homepage, https://github.com/rush-db/rushdb-python
 Project-URL: Repository, https://github.com/rush-db/rushdb-python
@@ -138,7 +138,17 @@ authored_posts = db.records.find({
 # Manage relationships explicitly
 user = db.records.find_uniq({'labels': ['USER'], 'where': {'name': 'Alice'}})
 company = db.records.find_uniq({'labels': ['COMPANY'], 'where': {'name': 'Acme Corp'}})
-user.attach(target=company, options={'type': 'WORKS_AT', 'direction': 'out'})
+user.attach(
+    target=company,
+    options={'type': 'WORKS_AT', 'direction': 'out', 'properties': {'source': 'profile'}},
+)
+
+# Relationship search: where filters edge type/properties, source/target filter endpoint records
+relationships = db.relationships.find({
+    'source': {'labels': ['USER'], 'where': {'name': 'Alice'}},
+    'target': {'labels': ['COMPANY']},
+    'where': {'type': 'WORKS_AT', 'source': 'profile'},
+})
 ```
 
 ---
@@ -151,7 +161,8 @@ csv_data = "name,email,age\nJohn,john@example.com,30\nJane,jane@example.com,25"
 db.records.import_csv(
     label='USER',
     data=csv_data,
-    options={'returnResult': True, 'suggestTypes': True},
+    # skipEmptyValues: treat empty cells ("" / []) as unset instead of storing them (0/False are kept)
+    options={'returnResult': True, 'suggestTypes': True, 'skipEmptyValues': True},
     parse_config={'header': True, 'skipEmptyLines': True, 'dynamicTyping': True},
 )
 ```

{rushdb-2.2.0 → rushdb-2.6.0}/README.md

@@ -113,7 +113,17 @@ authored_posts = db.records.find({
 # Manage relationships explicitly
 user = db.records.find_uniq({'labels': ['USER'], 'where': {'name': 'Alice'}})
 company = db.records.find_uniq({'labels': ['COMPANY'], 'where': {'name': 'Acme Corp'}})
-user.attach(target=company, options={'type': 'WORKS_AT', 'direction': 'out'})
+user.attach(
+    target=company,
+    options={'type': 'WORKS_AT', 'direction': 'out', 'properties': {'source': 'profile'}},
+)
+
+# Relationship search: where filters edge type/properties, source/target filter endpoint records
+relationships = db.relationships.find({
+    'source': {'labels': ['USER'], 'where': {'name': 'Alice'}},
+    'target': {'labels': ['COMPANY']},
+    'where': {'type': 'WORKS_AT', 'source': 'profile'},
+})
 ```
 
 ---
@@ -126,7 +136,8 @@ csv_data = "name,email,age\nJohn,john@example.com,30\nJane,jane@example.com,25"
 db.records.import_csv(
     label='USER',
     data=csv_data,
-    options={'returnResult': True, 'suggestTypes': True},
+    # skipEmptyValues: treat empty cells ("" / []) as unset instead of storing them (0/False are kept)
+    options={'returnResult': True, 'suggestTypes': True, 'skipEmptyValues': True},
     parse_config={'header': True, 'skipEmptyLines': True, 'dynamicTyping': True},
 )
 ```

{rushdb-2.2.0 → rushdb-2.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "rushdb"
-version = "2.2.0"
+version = "2.6.0"
 description = "RushDB Python SDK — memory layer for AI agents and modern apps"
 authors = [
     {name = "RushDB Team", email = "hi@rushdb.com"}
@@ -81,8 +81,6 @@ line-length = 120
 
 [tool.isort]
 profile = "black"
-multi_line_output = 3
-line_length = 120
 
 [dependency-groups]
 dev = [

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/__init__.py

@@ -13,8 +13,18 @@ from .common import NonUniqueResultError, RushDBError
 from .models.api_response import ApiResponse
 from .models.property import Property
 from .models.record import Record, RecordTarget, RelationTarget
-from .models.relationship import RelationshipDetachOptions, RelationshipOptions
+from .models.relationship import (
+    Relationship,
+    RelationshipDetachOptions,
+    RelationshipDirection,
+    RelationshipOptions,
+)
 from .models.result import RecordSearchResult, SearchResult
+from .models.search_query import (
+    RelationshipEndpointQuery,
+    RelationshipSearchQuery,
+    SearchQuery,
+)
 from .models.transaction import Transaction
 
 __all__ = [
@@ -29,8 +39,13 @@ __all__ = [
     "SearchResult",
     "Transaction",
     "Property",
+    "Relationship",
+    "RelationshipDirection",
     "RelationshipOptions",
     "RelationshipDetachOptions",
+    "SearchQuery",
+    "RelationshipEndpointQuery",
+    "RelationshipSearchQuery",
     "QueryAPI",
     "RelationsAPI",
     "RelationshipPatternsAPI",

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/api/ai.py

@@ -1,6 +1,6 @@
 """AI API for RushDB Python SDK.
 
-Provides methods for graph ontology exploration, semantic vector search,
+Provides methods for graph schema exploration, semantic vector search,
 and embedding index management.
 """
 
@@ -123,7 +123,7 @@ class AIAPI(BaseAPI):
     Example::
 
         >>> db = RushDB(api_key="...")
-        >>> ontology = db.ai.get_ontology()
+        >>> schema = db.ai.get_schema()
         >>> results = db.ai.search({"query": "fast cars", "propertyName": "description"})
         >>> db.ai.indexes.create({"propertyName": "description", "label": "Book"})
     """
@@ -132,12 +132,12 @@ class AIAPI(BaseAPI):
         super().__init__(client)
         self.indexes = _AIIndexesNamespace(client)
 
-    def get_ontology(
+    def get_schema(
         self,
         params: Optional[Dict[str, Any]] = None,
         transaction: Optional[Union[Transaction, str]] = None,
     ) -> ApiResponse:
-        """Return the full graph ontology as structured JSON.
+        """Return the full graph schema as structured JSON.
 
         Each item contains the label name, record count, properties with value
         ranges/samples, and cross-label relationships with direction.
@@ -149,13 +149,13 @@ class AIAPI(BaseAPI):
 
         Args:
             params: Optional filter. Pass ``{"labels": ["Label1"]}`` to scope
-                the ontology to specific labels only. Pass ``{"force": True}``
-                to bypass the 1-hour ontology cache and trigger a full
+                the schema to specific labels only. Pass ``{"force": True}``
+                to bypass the 1-hour schema cache and trigger a full
                 recalculation.
             transaction: Optional transaction context.
 
         Returns:
-            ApiResponse: Response whose ``data`` is a list of ontology items.
+            ApiResponse: Response whose ``data`` is a list of schema items.
         """
         headers: Dict[str, str] = {}
         if transaction is not None:
@@ -165,7 +165,7 @@ class AIAPI(BaseAPI):
             headers["x-transaction-id"] = tx_id
 
         response = self.client._make_request(
-            "POST", "/ai/ontology", params or {}, headers=headers or None
+            "POST", "/ai/schema", params or {}, headers=headers or None
         )
         return ApiResponse(
             data=response.get("data"),
@@ -173,12 +173,12 @@ class AIAPI(BaseAPI):
             total=response.get("total"),
         )
 
-    def get_ontology_markdown(
+    def get_schema_markdown(
         self,
         params: Optional[Dict[str, Any]] = None,
         transaction: Optional[Union[Transaction, str]] = None,
     ) -> ApiResponse:
-        """Return the full graph ontology as compact Markdown tables.
+        """Return the full graph schema as compact Markdown tables.
 
         Token-efficient representation intended for direct LLM consumption.
         Includes labels with counts, properties with types and value
@@ -191,7 +191,7 @@ class AIAPI(BaseAPI):
         Args:
             params: Optional filter. Pass ``{"labels": ["Label1"]}`` to scope
                 the output to specific labels only. Pass ``{"force": True}``
-                to bypass the 1-hour ontology cache and trigger a full
+                to bypass the 1-hour schema cache and trigger a full
                 recalculation.
             transaction: Optional transaction context.
 
@@ -206,7 +206,7 @@ class AIAPI(BaseAPI):
             headers["x-transaction-id"] = tx_id
 
         response = self.client._make_request(
-            "POST", "/ai/ontology/md", params or {}, headers=headers or None
+            "POST", "/ai/schema/md", params or {}, headers=headers or None
         )
         return ApiResponse(
             data=response.get("data"),

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/api/records.py

@@ -172,6 +172,8 @@ class RecordsAPI(BaseAPI):
                 Available options:
                 - returnResult (bool): Whether to return the created record data. Defaults to True.
                 - suggestTypes (bool): Whether to automatically suggest data types. Defaults to True.
+                - skipEmptyValues (bool): Treat empty strings ("") and empty arrays ([]) as unset —
+                  no property is created. 0 and False are kept. Defaults to False.
             vectors (Optional[List[Dict[str, Any]]]): Optional pre-computed embedding vectors
                 to write alongside the record. Each entry must contain at least
                 ``propertyName`` and ``vector``; ``similarityFunction`` is required when
@@ -231,7 +233,9 @@ class RecordsAPI(BaseAPI):
                 record. Nested objects/arrays are not supported here — raises
                 ``ValueError`` if any item contains a nested object or list.
             options: Optional write options forwarded as-is to the server
-                (e.g. ``suggestTypes``, ``mergeBy``, ``mergeStrategy``, etc.).
+                (e.g. ``suggestTypes``, ``skipEmptyValues``, ``mergeBy``,
+                ``mergeStrategy``, etc.). ``skipEmptyValues`` treats empty strings
+                and empty arrays as unset (``0``/``False`` are kept); defaults to False.
             vectors: Optional per-row inline vectors for external embedding indexes.
                 ``vectors[i]`` is applied to ``data[i]``. Each element is a list of
                 vector entry dicts: ``[{"propertyName": str, "vector": List[float],
@@ -446,6 +450,17 @@ class RecordsAPI(BaseAPI):
             >>>
             >>> # Attach using Record objects
             >>> response = records_api.attach(source_record, target_records)
+            >>>
+            >>> # Attach with a typed relationship carrying edge properties
+            >>> response = records_api.attach(
+            ...     movie,
+            ...     actor,
+            ...     options={
+            ...         "type": "STARS_IN",
+            ...         "direction": "out",
+            ...         "properties": {"role": "lead", "billing": 1},
+            ...     },
+            ... )
         """
         headers = Transaction._build_transaction_header(transaction)
 

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/api/relationship_patterns.py

@@ -10,7 +10,7 @@ if TYPE_CHECKING:
 
 
 class RelationshipPatternsAPI(BaseAPI):
-    """Review and manage relationship patterns inferred from project ontology.
+    """Review and manage relationship patterns inferred from project schema.
 
     Accessed via ``db.relationships.patterns``.
     """
@@ -27,12 +27,12 @@ class RelationshipPatternsAPI(BaseAPI):
         )
 
     def list(self) -> ApiResponse:
-        """List inferred patterns, ontology relationships, and analysis status."""
+        """List inferred patterns, schema relationships, and analysis status."""
         response = self.client._make_request("GET", "/relationships/patterns")
         return self._wrap(response)
 
     def analyze(self) -> ApiResponse:
-        """Queue ontology analysis to generate relationship pattern suggestions."""
+        """Queue schema analysis to generate relationship pattern suggestions."""
         response = self.client._make_request(
             "POST", "/relationships/patterns/analyze", {}
         )

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/api/relationships.py

@@ -1,9 +1,9 @@
 import typing
-from typing import TYPE_CHECKING, List, Optional, TypedDict, Union
-from urllib.parse import urlencode
+from typing import TYPE_CHECKING, Optional, TypedDict, Union
 
 from ..models.relationship import Relationship
-from ..models.search_query import SearchQuery
+from ..models.result import SearchResult
+from ..models.search_query import RelationshipSearchQuery
 from ..models.transaction import Transaction
 from .base import BaseAPI
 from .relationship_patterns import RelationshipPatternsAPI
@@ -47,21 +47,19 @@ class RelationsAPI(BaseAPI):
     Attributes:
         client: The underlying RushDB client instance for making HTTP requests.
 
-    Note:
-        This API currently contains async methods. Ensure you're using it in an
-        async context or consider updating to sync methods if needed.
-
     Example:
         >>> from rushdb import RushDB
         >>> client = RushDB(api_key="your_api_key")
         >>> relations_api = client.relationships
         >>>
         >>> # Find all relationships
-        >>> relationships = await relations_api.find()
+        >>> relationships = relations_api.find()
+        >>>
+        >>> # Filter by edge type and properties
+        >>> leads = relations_api.find({"where": {"type": "STARS_IN", "role": "lead"}})
         >>>
         >>> # Find relationships with pagination
-        >>> pagination = {"limit": 50, "skip": 0}
-        >>> page_1 = await relations_api.find(pagination=pagination)
+        >>> page_1 = relations_api.find(pagination={"limit": 50, "skip": 0})
     """
 
     def __init__(self, client: "RushDB"):
@@ -70,40 +68,57 @@ class RelationsAPI(BaseAPI):
 
     def find(
         self,
-        search_query: Optional[SearchQuery] = None,
+        search_query: Optional[RelationshipSearchQuery] = None,
         pagination: Optional[PaginationParams] = None,
         transaction: Optional[Union[Transaction, str]] = None,
-    ) -> List[Relationship]:
+    ) -> SearchResult[Relationship]:
         """Search for and retrieve relationships matching the specified criteria.
 
         Args:
-            search_query: The search criteria to filter relationships.
+            search_query: Relationship-edge criteria. ``where`` filters the edge —
+                ``type`` maps to the relationship type, ``direction`` constrains
+                direction, and every other key matches a user-defined edge property
+                (full operator set: ``$gte``, ``$contains``, ``$in``, ``$exists``,
+                logical grouping, ...). Use top-level ``source`` and ``target``
+                (``{"labels": [...], "where": {...}}``) to filter endpoint records.
+                ``limit``/``skip`` inside the query control pagination.
                 If None, returns all relationships (subject to pagination limits).
-            pagination: Pagination options (``limit`` and ``skip``).
+            pagination: Pagination options (``limit`` and ``skip``). Merged into the
+                search query body, overriding any ``limit``/``skip`` already inside
+                ``search_query`` — useful for paginating a stored query object
+                without mutating it.
             transaction: Optional transaction context.
 
         Returns:
-            List[Relationship]: Relationships matching the search criteria.
+            SearchResult[Relationship]: Matching relationships with ``total`` count.
+                Iterable and indexable like a list; each item includes ``sourceId``,
+                ``sourceLabel``, ``targetId``, ``targetLabel``, ``type``,
+                ``direction``, and user-defined edge ``properties``.
 
         Raises:
             RushDBError: If the server request fails.
 
         Example:
             >>> relations_api = RelationsAPI(client)
-            >>> all_rels = relations_api.find()
-            >>> page = relations_api.find(pagination={"limit": 50, "skip": 0})
+            >>> result = relations_api.find({
+            ...     "source": {"labels": ["MOVIE"], "where": {"title": "Inception"}},
+            ...     "target": {"labels": ["ACTOR"]},
+            ...     "where": {"type": "STARS_IN", "role": "lead"},
+            ...     "limit": 50,
+            ... })
+            >>> result.total
+            1
+            >>> result[0]["properties"]["role"]
+            'lead'
         """
-        # Build query string for pagination
-        query_params = {}
+        # Pagination lives in the body, same as records search. The `pagination`
+        # argument overrides limit/skip inside `search_query` without mutating it.
+        payload: typing.Dict[str, typing.Any] = dict(search_query or {})
         if pagination:
             if pagination.get("limit") is not None:
-                query_params["limit"] = str(pagination["limit"])
+                payload["limit"] = pagination["limit"]
             if pagination.get("skip") is not None:
-                query_params["skip"] = str(pagination["skip"])
-
-        # Construct path with query string
-        query_string = f"?{urlencode(query_params)}" if query_params else ""
-        path = f"/relationships/search{query_string}"
+                payload["skip"] = pagination["skip"]
 
         # Build headers with transaction if present
         headers = Transaction._build_transaction_header(transaction)
@@ -111,12 +126,17 @@ class RelationsAPI(BaseAPI):
         # Make request
         response = self.client._make_request(
             method="POST",
-            path=path,
-            data=typing.cast(typing.Dict[str, typing.Any], search_query or {}),
+            path="/relationships/search",
+            data=payload,
             headers=headers,
         )
 
-        return response.get("data", [])
+        data = response.get("data", [])
+        return SearchResult(
+            data=data,
+            total=response.get("total"),
+            search_query=typing.cast(typing.Any, payload),
+        )
 
     def create_many(
         self,
@@ -125,6 +145,7 @@ class RelationsAPI(BaseAPI):
         target: dict,
         type: Optional[str] = None,
         direction: Optional[str] = None,
+        properties: Optional[dict] = None,
         many_to_many: Optional[bool] = None,
         transaction: Optional[Union[Transaction, str]] = None,
     ) -> dict:
@@ -139,6 +160,7 @@ class RelationsAPI(BaseAPI):
             target (dict): { label: str, key?: str, where?: dict }
             type (str, optional): Relationship type override.
             direction (str, optional): 'in' | 'out'. Defaults to 'out' server-side when omitted.
+            properties (dict, optional): Shared user-defined properties to store on created edges.
             many_to_many (bool, optional): Enable cartesian mode (requires filters, disallows keys).
             transaction (Transaction|str, optional): Transaction context.
 
@@ -151,6 +173,8 @@ class RelationsAPI(BaseAPI):
             payload["type"] = type
         if direction:
             payload["direction"] = direction
+        if properties is not None:
+            payload["properties"] = properties
         if many_to_many is not None:
             payload["manyToMany"] = many_to_many
         return self.client._make_request(

rushdb-2.6.0/src/rushdb/models/__init__.py

@@ -0,0 +1,30 @@
+from .property import Property
+from .record import Record
+from .relationship import (
+    Relationship,
+    RelationshipDetachOptions,
+    RelationshipDirection,
+    RelationshipOptions,
+)
+from .result import RecordSearchResult, SearchResult
+from .search_query import (
+    RelationshipEndpointQuery,
+    RelationshipSearchQuery,
+    SearchQuery,
+)
+from .transaction import Transaction
+
+__all__ = [
+    "Property",
+    "Record",
+    "Relationship",
+    "RelationshipDetachOptions",
+    "RelationshipDirection",
+    "RelationshipOptions",
+    "RecordSearchResult",
+    "SearchResult",
+    "SearchQuery",
+    "RelationshipEndpointQuery",
+    "RelationshipSearchQuery",
+    "Transaction",
+]

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/models/api_response.py

@@ -19,7 +19,7 @@ class ApiResponse(Generic[T]):
         total: Optional total count (e.g. for list endpoints).
 
     Example:
-        >>> response = db.ai.get_ontology_markdown()
+        >>> response = db.ai.get_schema_markdown()
         >>> schema_md = response.data          # str
         >>> response = db.ai.indexes.find()
         >>> indexes = response.data            # list[dict]

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/models/property.py

@@ -21,8 +21,9 @@ BooleanValue = bool
 NumberValue = Union[float, int]
 StringValue = str
 
-# Property types
-PropertyType = Literal["boolean", "datetime", "null", "number", "string"]
+# Property types. A None/null value means the field is unset; `None` is still accepted as an
+# input value in `PropertyWithValue.value` below.
+PropertyType = Literal["boolean", "datetime", "number", "string"]
 
 
 class Property(TypedDict):

{rushdb-2.2.0 → rushdb-2.6.0}/src/rushdb/models/relationship.py

@@ -1,4 +1,4 @@
-from typing import List, Literal, Optional, TypedDict, Union
+from typing import Any, Dict, List, Literal, Optional, TypedDict, Union
 
 RelationshipDirection = Literal["in", "out"]
 
@@ -7,8 +7,10 @@ class Relationship(TypedDict, total=False):
     targetLabel: str
     targetId: str
     type: str
+    direction: RelationshipDirection
     sourceId: str
     sourceLabel: str
+    properties: Dict[str, Any]
 
 
 class RelationshipOptions(TypedDict, total=False):
@@ -16,6 +18,7 @@ class RelationshipOptions(TypedDict, total=False):
 
     direction: Optional[RelationshipDirection]
     type: Optional[str]
+    properties: Optional[Dict[str, Any]]
 
 
 class RelationshipDetachOptions(TypedDict, total=False):

rushdb-2.6.0/src/rushdb/models/search_query.py

@@ -0,0 +1,37 @@
+from enum import Enum
+from typing import Any, Dict, List, Optional, TypedDict, Union
+
+
+class OrderDirection(str, Enum):
+    ASC = "asc"
+    DESC = "desc"
+
+
+class SearchQuery(TypedDict, total=False):
+    """TypedDict representing the query structure for finding records."""
+
+    where: Optional[Dict[str, Any]]
+    labels: Optional[List[str]]
+    skip: Optional[int]
+    limit: Optional[int]
+    orderBy: Optional[Union[Dict[str, OrderDirection], OrderDirection]]
+    select: Optional[Dict[str, Any]]
+    groupBy: Optional[List[str]]
+
+
+class RelationshipEndpointQuery(TypedDict, total=False):
+    """Endpoint record predicates for relationship search."""
+
+    where: Optional[Dict[str, Any]]
+    labels: Optional[List[str]]
+
+
+class RelationshipSearchQuery(TypedDict, total=False):
+    """TypedDict representing the query structure for finding relationship edges."""
+
+    where: Optional[Dict[str, Any]]
+    source: Optional[RelationshipEndpointQuery]
+    target: Optional[RelationshipEndpointQuery]
+    skip: Optional[int]
+    limit: Optional[int]
+    orderBy: Optional[Union[Dict[str, OrderDirection], OrderDirection]]

{rushdb-2.2.0 → rushdb-2.6.0}/tests/test_create_import.py

@@ -153,6 +153,53 @@ class TestCreateImport(TestBase):
             source=project, target=employee, options=detach_options
         )
 
+    def test_attach_with_edge_properties_and_find(self):
+        """Test attaching with edge properties and searching edges by them"""
+        movie = self.client.records.create("MOVIE", {"title": "Inception"})
+        actor = self.client.records.create("ACTOR", {"name": "Leonardo DiCaprio"})
+
+        self.client.records.attach(
+            source=movie,
+            target=actor,
+            options=RelationshipOptions(
+                type="STARS_IN",
+                direction="out",
+                properties={"role": "lead", "billing": 1},
+            ),
+        )
+
+        # where filters the edge (type + edge properties);
+        # source/target filter the endpoint records
+        result = self.client.relationships.find(
+            {
+                "source": {"labels": ["MOVIE"], "where": {"title": "Inception"}},
+                "target": {"labels": ["ACTOR"]},
+                "where": {"type": "STARS_IN", "role": "lead", "billing": {"$lte": 3}},
+            }
+        )
+
+        self.assertGreaterEqual(result.total, 1)
+        edge = next(
+            rel
+            for rel in result
+            if rel["sourceId"] == movie.id and rel["targetId"] == actor.id
+        )
+        self.assertEqual(edge["type"], "STARS_IN")
+        self.assertEqual(edge["properties"]["role"], "lead")
+        self.assertEqual(edge["properties"]["billing"], 1)
+
+        # Edge-property mismatch excludes the relationship
+        no_match = self.client.relationships.find(
+            {
+                "source": {"labels": ["MOVIE"], "where": {"title": "Inception"}},
+                "where": {"type": "STARS_IN", "role": "extra"},
+            }
+        )
+        self.assertNotIn(
+            (movie.id, actor.id),
+            [(rel["sourceId"], rel["targetId"]) for rel in no_match],
+        )
+
     def test_create_with_nested_data(self):
         """Test creating records with nested data structure"""
         data = {

rushdb-2.6.0/tests/test_relationship_patterns.py

@@ -0,0 +1,160 @@
+from unittest.mock import Mock
+
+from src.rushdb.api.records import RecordsAPI
+from src.rushdb.api.relationship_patterns import RelationshipPatternsAPI
+from src.rushdb.api.relationships import RelationsAPI
+
+
+def test_relationships_exposes_patterns_namespace():
+    client = Mock()
+
+    relationships = RelationsAPI(client)
+
+    assert isinstance(relationships.patterns, RelationshipPatternsAPI)
+
+
+def test_list_relationship_patterns():
+    client = Mock()
+    client._make_request.return_value = {
+        "data": {"patterns": [], "relationships": [], "analysis": {"status": "idle"}},
+        "success": True,
+    }
+
+    response = RelationsAPI(client).patterns.list()
+
+    client._make_request.assert_called_once_with("GET", "/relationships/patterns")
+    assert response.data["patterns"] == []
+    assert response.data["analysis"]["status"] == "idle"
+
+
+def test_mutate_relationship_patterns():
+    client = Mock()
+    client._make_request.return_value = {"data": {"deleted": True}, "success": True}
+    patterns = RelationsAPI(client).patterns
+
+    patterns.analyze()
+    client._make_request.assert_called_with(
+        "POST", "/relationships/patterns/analyze", {}
+    )
+
+    patterns.approve("pattern-id")
+    client._make_request.assert_called_with(
+        "POST", "/relationships/patterns/pattern-id/approve", {}
+    )
+
+    patterns.ignore("pattern-id")
+    client._make_request.assert_called_with(
+        "POST", "/relationships/patterns/pattern-id/ignore", {}
+    )
+
+    patterns.delete("pattern-id", delete_existing=True)
+    client._make_request.assert_called_with(
+        "DELETE",
+        "/relationships/patterns/pattern-id",
+        params={"deleteExisting": "true"},
+    )
+
+
+def test_relationships_find_uses_edge_where_and_endpoint_filters():
+    client = Mock()
+    edge = {
+        "sourceId": "user-1",
+        "sourceLabel": "USER",
+        "targetId": "order-1",
+        "targetLabel": "ORDER",
+        "type": "ORDERED",
+        "direction": "out",
+        "properties": {"confidence": 0.9},
+    }
+    client._make_request.return_value = {"data": [edge], "total": 1}
+
+    search_query = {
+        "source": {"labels": ["USER"], "where": {"status": "active"}},
+        "target": {"labels": ["ORDER"]},
+        "where": {"type": "ORDERED", "confidence": {"$gte": 0.8}},
+        "limit": 25,
+    }
+
+    response = RelationsAPI(client).find(search_query)
+
+    # Pagination travels in the body, same as records search.
+    client._make_request.assert_called_once_with(
+        method="POST",
+        path="/relationships/search",
+        data=search_query,
+        headers=None,
+    )
+    assert response.total == 1
+    assert list(response) == [edge]
+    assert response[0]["properties"]["confidence"] == 0.9
+
+
+def test_relationships_find_explicit_pagination_wins_over_query_limit():
+    client = Mock()
+    client._make_request.return_value = {"data": [], "total": 0}
+
+    search_query = {"where": {"type": "ORDERED"}, "limit": 25}
+    RelationsAPI(client).find(search_query, pagination={"limit": 10, "skip": 5})
+
+    # The pagination argument overrides limit/skip in the body, leaving the
+    # caller's search_query object untouched.
+    client._make_request.assert_called_once_with(
+        method="POST",
+        path="/relationships/search",
+        data={"where": {"type": "ORDERED"}, "limit": 10, "skip": 5},
+        headers=None,
+    )
+    assert search_query == {"where": {"type": "ORDERED"}, "limit": 25}
+
+
+def test_relationships_create_many_forwards_edge_properties():
+    client = Mock()
+    client._make_request.return_value = {"success": True}
+
+    RelationsAPI(client).create_many(
+        source={"label": "USER", "key": "id"},
+        target={"label": "ORDER", "key": "userId"},
+        type="ORDERED",
+        direction="out",
+        properties={"source": "import", "confidence": 0.9},
+    )
+
+    client._make_request.assert_called_once_with(
+        "POST",
+        "/relationships/create-many",
+        {
+            "source": {"label": "USER", "key": "id"},
+            "target": {"label": "ORDER", "key": "userId"},
+            "type": "ORDERED",
+            "direction": "out",
+            "properties": {"source": "import", "confidence": 0.9},
+        },
+        None,
+    )
+
+
+def test_records_attach_forwards_edge_properties():
+    client = Mock()
+    client._make_request.return_value = {"success": True}
+
+    RecordsAPI(client).attach(
+        source="source-id",
+        target="target-id",
+        options={
+            "type": "RELATED_TO",
+            "direction": "out",
+            "properties": {"source": "test"},
+        },
+    )
+
+    client._make_request.assert_called_once_with(
+        "POST",
+        "/relationships/source-id",
+        {
+            "targetIds": ["target-id"],
+            "type": "RELATED_TO",
+            "direction": "out",
+            "properties": {"source": "test"},
+        },
+        None,
+    )

{rushdb-2.2.0 → rushdb-2.6.0}/uv.lock

@@ -15,13 +15,13 @@ resolution-markers = [
     "python_full_version < '3.9'",
 ]
 dependencies = [
-    { name = "click", version = "8.1.8", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
-    { name = "mypy-extensions", marker = "python_full_version < '3.9'" },
-    { name = "packaging", marker = "python_full_version < '3.9'" },
-    { name = "pathspec", marker = "python_full_version < '3.9'" },
-    { name = "platformdirs", version = "4.3.6", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
-    { name = "tomli", marker = "python_full_version < '3.9'" },
-    { name = "typing-extensions", version = "4.13.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
+    { name = "click", version = "8.1.8", source = { registry = "https://pypi.org/simple" } },
+    { name = "mypy-extensions" },
+    { name = "packaging" },
+    { name = "pathspec" },
+    { name = "platformdirs", version = "4.3.6", source = { registry = "https://pypi.org/simple" } },
+    { name = "tomli" },
+    { name = "typing-extensions", version = "4.13.2", source = { registry = "https://pypi.org/simple" } },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/04/b0/46fb0d4e00372f4a86a6f8efa3cb193c9f64863615e39010b1477e010578/black-24.8.0.tar.gz", hash = "sha256:2500945420b6784c38b9ee885af039f5e7471ef284ab03fa35ecdde4688cd83f", size = 644810, upload-time = "2024-08-02T17:43:18.405Z" }
 wheels = [
@@ -57,14 +57,14 @@ resolution-markers = [
     "python_full_version == '3.9.*'",
 ]
 dependencies = [
-    { name = "click", version = "8.1.8", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version == '3.9.*'" },
+    { name = "click", version = "8.1.8", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" },
     { name = "click", version = "8.2.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.10'" },
-    { name = "mypy-extensions", marker = "python_full_version >= '3.9'" },
-    { name = "packaging", marker = "python_full_version >= '3.9'" },
-    { name = "pathspec", marker = "python_full_version >= '3.9'" },
-    { name = "platformdirs", version = "4.3.8", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" },
-    { name = "tomli", marker = "python_full_version >= '3.9' and python_full_version < '3.11'" },
-    { name = "typing-extensions", version = "4.14.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9' and python_full_version < '3.11'" },
+    { name = "mypy-extensions" },
+    { name = "packaging" },
+    { name = "pathspec" },
+    { name = "platformdirs", version = "4.3.8", source = { registry = "https://pypi.org/simple" } },
+    { name = "tomli", marker = "python_full_version < '3.11'" },
+    { name = "typing-extensions", version = "4.14.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/94/49/26a7b0f3f35da4b5a65f081943b7bcd22d7002f5f0fb8098ec1ff21cb6ef/black-25.1.0.tar.gz", hash = "sha256:33496d5cd1222ad73391352b4ae8da15253c5de89b93a80b3e2c8d9a19ec2666", size = 649449, upload-time = "2025-01-29T04:15:40.373Z" }
 wheels = [
@@ -196,7 +196,7 @@ resolution-markers = [
     "python_full_version < '3.9'",
 ]
 dependencies = [
-    { name = "colorama", marker = "python_full_version < '3.10' and sys_platform == 'win32'" },
+    { name = "colorama", marker = "sys_platform == 'win32'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/b9/2e/0090cbf739cee7d23781ad4b89a9894a41538e4fcf4c31dcdd705b78eb8b/click-8.1.8.tar.gz", hash = "sha256:ed53c9d8990d83c2a27deae68e4ee337473f6330c040a31d4225c9574d16096a", size = 226593, upload-time = "2024-12-21T18:38:44.339Z" }
 wheels = [
@@ -211,7 +211,7 @@ resolution-markers = [
     "python_full_version >= '3.10'",
 ]
 dependencies = [
-    { name = "colorama", marker = "python_full_version >= '3.10' and sys_platform == 'win32'" },
+    { name = "colorama", marker = "sys_platform == 'win32'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/60/6c/8ca2efa64cf75a977a0d7fac081354553ebe483345c734fb6b6515d96bbc/click-8.2.1.tar.gz", hash = "sha256:27c491cc05d968d271d5a1db13e3b5a184636d9d930f148c50b038f0d0646202", size = 286342, upload-time = "2025-05-20T23:19:49.832Z" }
 wheels = [
@@ -311,7 +311,7 @@ wheels = [
 
 [package.optional-dependencies]
 toml = [
-    { name = "tomli", marker = "python_full_version < '3.9'" },
+    { name = "tomli" },
 ]
 
 [[package]]
@@ -394,7 +394,7 @@ wheels = [
 
 [package.optional-dependencies]
 toml = [
-    { name = "tomli", marker = "python_full_version >= '3.9' and python_full_version <= '3.11'" },
+    { name = "tomli", marker = "python_full_version <= '3.11'" },
 ]
 
 [[package]]
@@ -402,8 +402,8 @@ name = "exceptiongroup"
 version = "1.3.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "typing-extensions", version = "4.13.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
-    { name = "typing-extensions", version = "4.14.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9' and python_full_version < '3.13'" },
+    { name = "typing-extensions", version = "4.13.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9' or python_full_version >= '3.11'" },
+    { name = "typing-extensions", version = "4.14.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9' and python_full_version < '3.11'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/0b/9f/a65090624ecf468cdca03533906e7c69ed7588582240cfe7cc9e770b50eb/exceptiongroup-1.3.0.tar.gz", hash = "sha256:b241f5885f560bc56a59ee63ca4c6a8bfa46ae4ad651af316d4e81817bb9fd88", size = 29749, upload-time = "2025-05-10T17:42:51.123Z" }
 wheels = [
@@ -461,9 +461,9 @@ resolution-markers = [
     "python_full_version < '3.9'",
 ]
 dependencies = [
-    { name = "mypy-extensions", marker = "python_full_version < '3.9'" },
-    { name = "tomli", marker = "python_full_version < '3.9'" },
-    { name = "typing-extensions", version = "4.13.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
+    { name = "mypy-extensions" },
+    { name = "tomli" },
+    { name = "typing-extensions", version = "4.13.2", source = { registry = "https://pypi.org/simple" } },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/b9/eb/2c92d8ea1e684440f54fa49ac5d9a5f19967b7b472a281f419e69a8d228e/mypy-1.14.1.tar.gz", hash = "sha256:7ec88144fe9b510e8475ec2f5f251992690fcf89ccb4500b214b4226abcd32d6", size = 3216051, upload-time = "2024-12-30T16:39:07.335Z" }
 wheels = [
@@ -515,10 +515,10 @@ resolution-markers = [
     "python_full_version == '3.9.*'",
 ]
 dependencies = [
-    { name = "mypy-extensions", marker = "python_full_version >= '3.9'" },
-    { name = "pathspec", marker = "python_full_version >= '3.9'" },
-    { name = "tomli", marker = "python_full_version >= '3.9' and python_full_version < '3.11'" },
-    { name = "typing-extensions", version = "4.14.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" },
+    { name = "mypy-extensions" },
+    { name = "pathspec" },
+    { name = "tomli", marker = "python_full_version < '3.11'" },
+    { name = "typing-extensions", version = "4.14.0", source = { registry = "https://pypi.org/simple" } },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/81/69/92c7fa98112e4d9eb075a239caa4ef4649ad7d441545ccffbd5e34607cbb/mypy-1.16.1.tar.gz", hash = "sha256:6bd00a0a2094841c5e47e7374bb42b83d64c527a502e3334e1173a0c24437bab", size = 3324747, upload-time = "2025-06-16T16:51:35.145Z" }
 wheels = [
@@ -649,12 +649,12 @@ resolution-markers = [
     "python_full_version < '3.9'",
 ]
 dependencies = [
-    { name = "colorama", marker = "python_full_version < '3.9' and sys_platform == 'win32'" },
-    { name = "exceptiongroup", marker = "python_full_version < '3.9'" },
-    { name = "iniconfig", marker = "python_full_version < '3.9'" },
-    { name = "packaging", marker = "python_full_version < '3.9'" },
-    { name = "pluggy", version = "1.5.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
-    { name = "tomli", marker = "python_full_version < '3.9'" },
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+    { name = "exceptiongroup" },
+    { name = "iniconfig" },
+    { name = "packaging" },
+    { name = "pluggy", version = "1.5.0", source = { registry = "https://pypi.org/simple" } },
+    { name = "tomli" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/ae/3c/c9d525a414d506893f0cd8a8d0de7706446213181570cdbd766691164e40/pytest-8.3.5.tar.gz", hash = "sha256:f4efe70cc14e511565ac476b57c279e12a855b11f48f212af1080ef2263d3845", size = 1450891, upload-time = "2025-03-02T12:54:54.503Z" }
 wheels = [
@@ -670,13 +670,13 @@ resolution-markers = [
     "python_full_version == '3.9.*'",
 ]
 dependencies = [
-    { name = "colorama", marker = "python_full_version >= '3.9' and sys_platform == 'win32'" },
-    { name = "exceptiongroup", marker = "python_full_version >= '3.9' and python_full_version < '3.11'" },
-    { name = "iniconfig", marker = "python_full_version >= '3.9'" },
-    { name = "packaging", marker = "python_full_version >= '3.9'" },
-    { name = "pluggy", version = "1.6.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" },
-    { name = "pygments", marker = "python_full_version >= '3.9'" },
-    { name = "tomli", marker = "python_full_version >= '3.9' and python_full_version < '3.11'" },
+    { name = "colorama", marker = "sys_platform == 'win32'" },
+    { name = "exceptiongroup", marker = "python_full_version < '3.11'" },
+    { name = "iniconfig" },
+    { name = "packaging" },
+    { name = "pluggy", version = "1.6.0", source = { registry = "https://pypi.org/simple" } },
+    { name = "pygments" },
+    { name = "tomli", marker = "python_full_version < '3.11'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/08/ba/45911d754e8eba3d5a841a5ce61a65a685ff1798421ac054f85aa8747dfb/pytest-8.4.1.tar.gz", hash = "sha256:7c67fd69174877359ed9371ec3af8a3d2b04741818c51e5e99cc1742251fa93c", size = 1517714, upload-time = "2025-06-18T05:48:06.109Z" }
 wheels = [
@@ -691,8 +691,8 @@ resolution-markers = [
     "python_full_version < '3.9'",
 ]
 dependencies = [
-    { name = "coverage", version = "7.6.1", source = { registry = "https://pypi.org/simple" }, extra = ["toml"], marker = "python_full_version < '3.9'" },
-    { name = "pytest", version = "8.3.5", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
+    { name = "coverage", version = "7.6.1", source = { registry = "https://pypi.org/simple" }, extra = ["toml"] },
+    { name = "pytest", version = "8.3.5", source = { registry = "https://pypi.org/simple" } },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/74/67/00efc8d11b630c56f15f4ad9c7f9223f1e5ec275aaae3fa9118c6a223ad2/pytest-cov-5.0.0.tar.gz", hash = "sha256:5837b58e9f6ebd335b0f8060eecce69b662415b16dc503883a02f45dfeb14857", size = 63042, upload-time = "2024-03-24T20:16:34.856Z" }
 wheels = [
@@ -708,9 +708,9 @@ resolution-markers = [
     "python_full_version == '3.9.*'",
 ]
 dependencies = [
-    { name = "coverage", version = "7.9.1", source = { registry = "https://pypi.org/simple" }, extra = ["toml"], marker = "python_full_version >= '3.9'" },
-    { name = "pluggy", version = "1.6.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" },
-    { name = "pytest", version = "8.4.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" },
+    { name = "coverage", version = "7.9.1", source = { registry = "https://pypi.org/simple" }, extra = ["toml"] },
+    { name = "pluggy", version = "1.6.0", source = { registry = "https://pypi.org/simple" } },
+    { name = "pytest", version = "8.4.1", source = { registry = "https://pypi.org/simple" } },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/18/99/668cade231f434aaa59bbfbf49469068d2ddd945000621d3d165d2e7dd7b/pytest_cov-6.2.1.tar.gz", hash = "sha256:25cc6cc0a5358204b8108ecedc51a9b57b34cc6b8c967cc2c01a4e00d8a67da2", size = 69432, upload-time = "2025-06-12T10:47:47.684Z" }
 wheels = [
@@ -785,7 +785,7 @@ wheels = [
 
 [[package]]
 name = "rushdb"
-version = "2.2.0"
+version = "2.6.0"
 source = { editable = "." }
 dependencies = [
     { name = "python-dotenv", version = "1.0.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
@@ -930,7 +930,7 @@ resolution-markers = [
     "python_full_version < '3.9'",
 ]
 dependencies = [
-    { name = "urllib3", version = "2.2.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.9'" },
+    { name = "urllib3", version = "2.2.3", source = { registry = "https://pypi.org/simple" } },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/fa/3c/4f2a430c01a22abd49a583b6b944173e39e7d01b688190a5618bd59a2e22/types-requests-2.32.0.20241016.tar.gz", hash = "sha256:0d9cad2f27515d0e3e3da7134a1b6f28fb97129d86b867f24d9c726452634d95", size = 18065, upload-time = "2024-10-16T02:46:10.818Z" }
 wheels = [
@@ -946,7 +946,7 @@ resolution-markers = [
     "python_full_version == '3.9.*'",
 ]
 dependencies = [
-    { name = "urllib3", version = "2.5.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.9'" },
+    { name = "urllib3", version = "2.5.0", source = { registry = "https://pypi.org/simple" } },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/6d/7f/73b3a04a53b0fd2a911d4ec517940ecd6600630b559e4505cc7b68beb5a0/types_requests-2.32.4.20250611.tar.gz", hash = "sha256:741c8777ed6425830bf51e54d6abe245f79b4dcb9019f1622b773463946bf826", size = 23118, upload-time = "2025-06-11T03:11:41.272Z" }
 wheels = [

rushdb-2.2.0/src/rushdb/models/__init__.py

@@ -1,17 +0,0 @@
-from .property import Property
-from .record import Record
-from .relationship import RelationshipDetachOptions, RelationshipOptions
-from .result import RecordSearchResult, SearchResult
-from .search_query import SearchQuery
-from .transaction import Transaction
-
-__all__ = [
-    "Property",
-    "Record",
-    "RelationshipDetachOptions",
-    "RelationshipOptions",
-    "RecordSearchResult",
-    "SearchResult",
-    "SearchQuery",
-    "Transaction",
-]

rushdb-2.2.0/src/rushdb/models/search_query.py

@@ -1,19 +0,0 @@
-from enum import Enum
-from typing import Any, Dict, List, Optional, TypedDict, Union
-
-
-class OrderDirection(str, Enum):
-    ASC = "asc"
-    DESC = "desc"
-
-
-class SearchQuery(TypedDict, total=False):
-    """TypedDict representing the query structure for finding records."""
-
-    where: Optional[Dict[str, Any]]
-    labels: Optional[List[str]]
-    skip: Optional[int]
-    limit: Optional[int]
-    orderBy: Optional[Union[Dict[str, OrderDirection], OrderDirection]]
-    select: Optional[Dict[str, Any]]
-    groupBy: Optional[List[str]]

rushdb-2.2.0/tests/test_relationship_patterns.py

@@ -1,54 +0,0 @@
-from unittest.mock import Mock
-
-from src.rushdb.api.relationship_patterns import RelationshipPatternsAPI
-from src.rushdb.api.relationships import RelationsAPI
-
-
-def test_relationships_exposes_patterns_namespace():
-    client = Mock()
-
-    relationships = RelationsAPI(client)
-
-    assert isinstance(relationships.patterns, RelationshipPatternsAPI)
-
-
-def test_list_relationship_patterns():
-    client = Mock()
-    client._make_request.return_value = {
-        "data": {"patterns": [], "relationships": [], "analysis": {"status": "idle"}},
-        "success": True,
-    }
-
-    response = RelationsAPI(client).patterns.list()
-
-    client._make_request.assert_called_once_with("GET", "/relationships/patterns")
-    assert response.data["patterns"] == []
-    assert response.data["analysis"]["status"] == "idle"
-
-
-def test_mutate_relationship_patterns():
-    client = Mock()
-    client._make_request.return_value = {"data": {"deleted": True}, "success": True}
-    patterns = RelationsAPI(client).patterns
-
-    patterns.analyze()
-    client._make_request.assert_called_with(
-        "POST", "/relationships/patterns/analyze", {}
-    )
-
-    patterns.approve("pattern-id")
-    client._make_request.assert_called_with(
-        "POST", "/relationships/patterns/pattern-id/approve", {}
-    )
-
-    patterns.ignore("pattern-id")
-    client._make_request.assert_called_with(
-        "POST", "/relationships/patterns/pattern-id/ignore", {}
-    )
-
-    patterns.delete("pattern-id", delete_existing=True)
-    client._make_request.assert_called_with(
-        "DELETE",
-        "/relationships/patterns/pattern-id",
-        params={"deleteExisting": "true"},
-    )