langchain-rushdb 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,9 @@
1
+ .venv/
2
+ __pycache__/
3
+ *.pyc
4
+ .pytest_cache/
5
+ .mypy_cache/
6
+ .ruff_cache/
7
+ dist/
8
+ node_modules/
9
+ *.tsbuildinfo
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 Collect Software Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,133 @@
1
+ Metadata-Version: 2.5
2
+ Name: langchain-rushdb
3
+ Version: 0.1.0
4
+ Summary: LangChain and LangGraph integration for RushDB: vector store, hybrid retriever, long-term memory store and checkpointer, on RushDB Cloud or self-hosted
5
+ Project-URL: Homepage, https://github.com/rush-db/langchain-rushdb
6
+ Project-URL: Repository, https://github.com/rush-db/langchain-rushdb
7
+ Project-URL: Documentation, https://docs.rushdb.com/connect/langchain
8
+ Author-email: RushDB Team <hi@rushdb.com>
9
+ License: Apache-2.0
10
+ License-File: LICENSE
11
+ Keywords: agent memory,checkpointer,hybrid search,langchain,langgraph,rag,rushdb,self-hosted,vector store
12
+ Requires-Python: >=3.10
13
+ Requires-Dist: langchain-core<2,>=1.0
14
+ Requires-Dist: langgraph-checkpoint<5,>=4.0
15
+ Requires-Dist: langgraph<2,>=1.0
16
+ Requires-Dist: rushdb<4,>=3.2.1
17
+ Description-Content-Type: text/markdown
18
+
19
+ # langchain-rushdb
20
+
21
+ LangChain and LangGraph integration for [RushDB](https://rushdb.com). It works the same
22
+ on RushDB Cloud and on a self-hosted RushDB engine.
23
+
24
+ | Component | LangChain / LangGraph interface | What it does |
25
+ |---|---|---|
26
+ | `RushDBVectorStore` | `VectorStore` | Documents with filterable metadata and vector search; the filter is applied before ranking |
27
+ | `RushDBHybridRetriever` | `BaseRetriever` | Vector + BM25 keyword search fused in the engine (RRF or DBSF) |
28
+ | `RushDBStore` | LangGraph `BaseStore` | Long-term agent memory: namespaces, filters, semantic search, TTL |
29
+ | `RushDBSaver` | LangGraph `BaseCheckpointSaver` | Thread checkpoints and pending writes (human-in-the-loop, time travel) |
30
+
31
+ ```bash
32
+ pip install langchain-rushdb
33
+ ```
34
+
35
+ ## Connect
36
+
37
+ Every class takes a `rushdb.RushDB` client, or builds one from the environment.
38
+
39
+ ```python
40
+ from rushdb import RushDB
41
+
42
+ # RushDB Cloud
43
+ client = RushDB("RUSHDB_API_KEY")
44
+
45
+ # Self-hosted engine (docker run -e RUSHDB_TOKEN=... -p 127.0.0.1:3000:3000 rushdb/rushdb)
46
+ client = RushDB("ENGINE_TOKEN", direct=True, engine_url="http://127.0.0.1:3000")
47
+ ```
48
+
49
+ From the environment (`client_from_env()`, used when `client` is omitted):
50
+
51
+ | Mode | Variables |
52
+ |---|---|
53
+ | RushDB Cloud | `RUSHDB_API_KEY`, optional `RUSHDB_URL` |
54
+ | Self-hosted | `RUSHDB_ENGINE_URL`, `RUSHDB_ENGINE_TOKEN`, optional `RUSHDB_SCOPE` (multitenant engine) |
55
+
56
+ The rest of this page is identical for both modes.
57
+
58
+ ## Vector store and hybrid retrieval
59
+
60
+ ```python
61
+ from langchain_openai import OpenAIEmbeddings
62
+ from langchain_rushdb import RushDBVectorStore, RushDBHybridRetriever
63
+
64
+ store = RushDBVectorStore(
65
+ OpenAIEmbeddings(model="text-embedding-3-small"), client=client, hybrid=True
66
+ )
67
+ store.add_texts(
68
+ ["RushDB stores JSON as a graph", "LangGraph persists agent state"],
69
+ metadatas=[{"topic": "db", "year": 2026}, {"topic": "agents", "year": 2025}],
70
+ )
71
+
72
+ store.similarity_search("graph database", k=2, filter={"year": {"$gte": 2026}})
73
+
74
+ retriever = RushDBHybridRetriever(vectorstore=store, k=5, fusion="rrf")
75
+ retriever.invoke("how are agent checkpoints stored?")
76
+ ```
77
+
78
+ Filters use the LangChain/MongoDB form on metadata: equality, `$eq $ne $gt $gte $lt $lte`,
79
+ `$in $nin`, `$exists`, `$contains $startsWith $endsWith`, `$and $or $not`. An
80
+ unsupported filter raises `FilterError`; it is never ignored. `where=` takes a raw
81
+ RushDB filter, which can also match related records.
82
+
83
+ Only top-level metadata values that are strings, numbers, booleans or flat arrays of
84
+ one of those are filterable. The full metadata, nested values included, is always
85
+ returned.
86
+
87
+ ## Long-term memory store
88
+
89
+ ```python
90
+ from langchain_rushdb import RushDBStore
91
+
92
+ store = RushDBStore(
93
+ client=client,
94
+ index={"dims": 1536, "embed": "openai:text-embedding-3-small", "fields": ["text"]},
95
+ ttl={"default_ttl": 60 * 24 * 30, "refresh_on_read": True},
96
+ )
97
+ store.put(("users", "u1", "memories"), "m1", {"text": "Prefers dark mode", "kind": "pref"})
98
+ store.search(("users", "u1"), query="ui preferences", filter={"kind": "pref"})
99
+ ```
100
+
101
+ RushDB records have no native TTL. Expired items are hidden from every read.
102
+ `store.sweep()` deletes them, and `store.start_ttl_sweeper()` runs `sweep()`
103
+ periodically.
104
+
105
+ ## Checkpointer
106
+
107
+ ```python
108
+ from langgraph.graph import StateGraph
109
+ from langchain_rushdb import RushDBSaver
110
+
111
+ graph = builder.compile(checkpointer=RushDBSaver(client=client))
112
+ graph.invoke(inputs, {"configurable": {"thread_id": "t-1"}})
113
+ ```
114
+
115
+ ## Embeddings: the one mode difference
116
+
117
+ The default is the same everywhere: you pass a LangChain `Embeddings` object and the
118
+ connector stores and searches with the vectors it produces. On RushDB Cloud you can
119
+ instead let RushDB compute embeddings:
120
+
121
+ ```python
122
+ RushDBVectorStore("managed", client=cloud_client)
123
+ ```
124
+
125
+ A self-hosted engine never computes embeddings, so `"managed"` raises a `ValueError`
126
+ there.
127
+
128
+ ## Data layout
129
+
130
+ The records the connector writes (labels `LC_DOCUMENT`, `LG_STORE_ITEM`,
131
+ `LG_STORE_VECTOR`, `LG_CHECKPOINT*`) are specified in
132
+ [`spec/README.md`](https://github.com/rush-db/langchain-rushdb/blob/main/spec/README.md).
133
+ The JavaScript package `@rushdb/langchain` uses the same layout.
@@ -0,0 +1,115 @@
1
+ # langchain-rushdb
2
+
3
+ LangChain and LangGraph integration for [RushDB](https://rushdb.com). It works the same
4
+ on RushDB Cloud and on a self-hosted RushDB engine.
5
+
6
+ | Component | LangChain / LangGraph interface | What it does |
7
+ |---|---|---|
8
+ | `RushDBVectorStore` | `VectorStore` | Documents with filterable metadata and vector search; the filter is applied before ranking |
9
+ | `RushDBHybridRetriever` | `BaseRetriever` | Vector + BM25 keyword search fused in the engine (RRF or DBSF) |
10
+ | `RushDBStore` | LangGraph `BaseStore` | Long-term agent memory: namespaces, filters, semantic search, TTL |
11
+ | `RushDBSaver` | LangGraph `BaseCheckpointSaver` | Thread checkpoints and pending writes (human-in-the-loop, time travel) |
12
+
13
+ ```bash
14
+ pip install langchain-rushdb
15
+ ```
16
+
17
+ ## Connect
18
+
19
+ Every class takes a `rushdb.RushDB` client, or builds one from the environment.
20
+
21
+ ```python
22
+ from rushdb import RushDB
23
+
24
+ # RushDB Cloud
25
+ client = RushDB("RUSHDB_API_KEY")
26
+
27
+ # Self-hosted engine (docker run -e RUSHDB_TOKEN=... -p 127.0.0.1:3000:3000 rushdb/rushdb)
28
+ client = RushDB("ENGINE_TOKEN", direct=True, engine_url="http://127.0.0.1:3000")
29
+ ```
30
+
31
+ From the environment (`client_from_env()`, used when `client` is omitted):
32
+
33
+ | Mode | Variables |
34
+ |---|---|
35
+ | RushDB Cloud | `RUSHDB_API_KEY`, optional `RUSHDB_URL` |
36
+ | Self-hosted | `RUSHDB_ENGINE_URL`, `RUSHDB_ENGINE_TOKEN`, optional `RUSHDB_SCOPE` (multitenant engine) |
37
+
38
+ The rest of this page is identical for both modes.
39
+
40
+ ## Vector store and hybrid retrieval
41
+
42
+ ```python
43
+ from langchain_openai import OpenAIEmbeddings
44
+ from langchain_rushdb import RushDBVectorStore, RushDBHybridRetriever
45
+
46
+ store = RushDBVectorStore(
47
+ OpenAIEmbeddings(model="text-embedding-3-small"), client=client, hybrid=True
48
+ )
49
+ store.add_texts(
50
+ ["RushDB stores JSON as a graph", "LangGraph persists agent state"],
51
+ metadatas=[{"topic": "db", "year": 2026}, {"topic": "agents", "year": 2025}],
52
+ )
53
+
54
+ store.similarity_search("graph database", k=2, filter={"year": {"$gte": 2026}})
55
+
56
+ retriever = RushDBHybridRetriever(vectorstore=store, k=5, fusion="rrf")
57
+ retriever.invoke("how are agent checkpoints stored?")
58
+ ```
59
+
60
+ Filters use the LangChain/MongoDB form on metadata: equality, `$eq $ne $gt $gte $lt $lte`,
61
+ `$in $nin`, `$exists`, `$contains $startsWith $endsWith`, `$and $or $not`. An
62
+ unsupported filter raises `FilterError`; it is never ignored. `where=` takes a raw
63
+ RushDB filter, which can also match related records.
64
+
65
+ Only top-level metadata values that are strings, numbers, booleans or flat arrays of
66
+ one of those are filterable. The full metadata, nested values included, is always
67
+ returned.
68
+
69
+ ## Long-term memory store
70
+
71
+ ```python
72
+ from langchain_rushdb import RushDBStore
73
+
74
+ store = RushDBStore(
75
+ client=client,
76
+ index={"dims": 1536, "embed": "openai:text-embedding-3-small", "fields": ["text"]},
77
+ ttl={"default_ttl": 60 * 24 * 30, "refresh_on_read": True},
78
+ )
79
+ store.put(("users", "u1", "memories"), "m1", {"text": "Prefers dark mode", "kind": "pref"})
80
+ store.search(("users", "u1"), query="ui preferences", filter={"kind": "pref"})
81
+ ```
82
+
83
+ RushDB records have no native TTL. Expired items are hidden from every read.
84
+ `store.sweep()` deletes them, and `store.start_ttl_sweeper()` runs `sweep()`
85
+ periodically.
86
+
87
+ ## Checkpointer
88
+
89
+ ```python
90
+ from langgraph.graph import StateGraph
91
+ from langchain_rushdb import RushDBSaver
92
+
93
+ graph = builder.compile(checkpointer=RushDBSaver(client=client))
94
+ graph.invoke(inputs, {"configurable": {"thread_id": "t-1"}})
95
+ ```
96
+
97
+ ## Embeddings: the one mode difference
98
+
99
+ The default is the same everywhere: you pass a LangChain `Embeddings` object and the
100
+ connector stores and searches with the vectors it produces. On RushDB Cloud you can
101
+ instead let RushDB compute embeddings:
102
+
103
+ ```python
104
+ RushDBVectorStore("managed", client=cloud_client)
105
+ ```
106
+
107
+ A self-hosted engine never computes embeddings, so `"managed"` raises a `ValueError`
108
+ there.
109
+
110
+ ## Data layout
111
+
112
+ The records the connector writes (labels `LC_DOCUMENT`, `LG_STORE_ITEM`,
113
+ `LG_STORE_VECTOR`, `LG_CHECKPOINT*`) are specified in
114
+ [`spec/README.md`](https://github.com/rush-db/langchain-rushdb/blob/main/spec/README.md).
115
+ The JavaScript package `@rushdb/langchain` uses the same layout.
@@ -0,0 +1,18 @@
1
+ """LangChain and LangGraph integration for RushDB, Cloud or self-hosted."""
2
+
3
+ from ._connection import client_from_env
4
+ from .checkpoint import RushDBSaver
5
+ from .filters import FilterError, translate_filter
6
+ from .retrievers import RushDBHybridRetriever
7
+ from .store import RushDBStore
8
+ from .vectorstores import RushDBVectorStore
9
+
10
+ __all__ = [
11
+ "FilterError",
12
+ "RushDBHybridRetriever",
13
+ "RushDBSaver",
14
+ "RushDBStore",
15
+ "RushDBVectorStore",
16
+ "client_from_env",
17
+ "translate_filter",
18
+ ]
@@ -0,0 +1,202 @@
1
+ """Client construction and the record helpers every component shares."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import base64
6
+ import json
7
+ import logging
8
+ import math
9
+ import os
10
+ import random
11
+ import time
12
+ from collections.abc import Iterator, Mapping
13
+ from datetime import datetime, timezone
14
+ from typing import Any
15
+
16
+ from rushdb import RushDB, RushDBError
17
+
18
+ logger = logging.getLogger("langchain_rushdb")
19
+
20
+ PAGE_SIZE = 1000
21
+ """Records fetched per request when reading every match."""
22
+
23
+ FAR_FUTURE = "9999-12-31T23:59:59.000Z"
24
+
25
+
26
+ def client_from_env(env: Mapping[str, str] | None = None) -> RushDB:
27
+ """Build a RushDB client from the environment.
28
+
29
+ RushDB Cloud: ``RUSHDB_API_KEY`` (and optionally ``RUSHDB_URL``).
30
+ Self-hosted engine: ``RUSHDB_ENGINE_URL`` and ``RUSHDB_ENGINE_TOKEN``
31
+ (and ``RUSHDB_SCOPE`` on a multitenant engine). Setting both is an error.
32
+ """
33
+ env = os.environ if env is None else env
34
+ api_key = env.get("RUSHDB_API_KEY")
35
+ engine_url = env.get("RUSHDB_ENGINE_URL")
36
+ if api_key and engine_url:
37
+ raise ValueError(
38
+ "Both RUSHDB_API_KEY (RushDB Cloud) and RUSHDB_ENGINE_URL (self-hosted) are set; "
39
+ "set the variables of one mode only."
40
+ )
41
+ if engine_url:
42
+ token = env.get("RUSHDB_ENGINE_TOKEN")
43
+ if not token:
44
+ raise ValueError("RUSHDB_ENGINE_URL is set but RUSHDB_ENGINE_TOKEN is not.")
45
+ return RushDB(
46
+ token,
47
+ direct=True,
48
+ engine_url=engine_url,
49
+ scope=env.get("RUSHDB_SCOPE") or None,
50
+ )
51
+ if api_key:
52
+ return RushDB(api_key, url=env.get("RUSHDB_URL") or None)
53
+ raise ValueError(
54
+ "No RushDB connection configured: set RUSHDB_API_KEY for RushDB Cloud, or "
55
+ "RUSHDB_ENGINE_URL and RUSHDB_ENGINE_TOKEN for a self-hosted engine."
56
+ )
57
+
58
+
59
+ def is_self_hosted(client: RushDB) -> bool:
60
+ return bool(getattr(client, "direct", False))
61
+
62
+
63
+ def find_all(client: RushDB, search: dict[str, Any]) -> Iterator[dict[str, Any]]:
64
+ """Yield the data of every record ``search`` matches, page by page."""
65
+ skip = 0
66
+ while True:
67
+ page = client.records.find({**search, "skip": skip, "limit": PAGE_SIZE})
68
+ rows = [record.data for record in page.data]
69
+ yield from rows
70
+ if len(rows) < PAGE_SIZE:
71
+ return
72
+ skip += PAGE_SIZE
73
+
74
+
75
+ def create_rows(
76
+ client: RushDB,
77
+ label: str,
78
+ rows: list[dict[str, Any]],
79
+ vectors: list[list[dict[str, Any]]] | None = None,
80
+ transaction: Any = None,
81
+ ) -> None:
82
+ """Create ``rows`` in one engine commit, each with its inline ``vectors``.
83
+
84
+ ``records.import_json`` rather than ``create_many``: rows may hold flat
85
+ arrays, which the engine stores as array properties.
86
+ """
87
+ if not rows:
88
+ return
89
+ data = [
90
+ {**row, "$vectors": vectors[i]} if vectors and vectors[i] else row
91
+ for i, row in enumerate(rows)
92
+ ]
93
+ client.records.import_json(
94
+ data,
95
+ label=label,
96
+ options={"returnResult": False, "suggestTypes": True},
97
+ transaction=transaction,
98
+ )
99
+
100
+
101
+ CONFLICT_RETRIES = 10
102
+ CONFLICT_BACKOFF_CAP = 2.0
103
+
104
+
105
+ def transact(
106
+ client: RushDB,
107
+ delete: list[str],
108
+ create: list[tuple[str, list[dict[str, Any]]]],
109
+ ) -> None:
110
+ """Delete records by id and create rows in one transaction.
111
+
112
+ Concurrent transactions can conflict; the engine reports that as
113
+ retryable, so the transaction is replayed with backoff.
114
+ """
115
+ if not delete and not any(rows for _, rows in create):
116
+ return
117
+ for attempt in range(CONFLICT_RETRIES):
118
+ tx = client.tx.begin()
119
+ committing = False
120
+ try:
121
+ for record in delete:
122
+ client.records.delete_by_id(record, transaction=tx)
123
+ for label, rows in create:
124
+ create_rows(client, label, rows, transaction=tx)
125
+ committing = True
126
+ client.tx.commit(tx)
127
+ return
128
+ except BaseException as exc:
129
+ # A failed commit has already ended the transaction.
130
+ if not committing:
131
+ _rollback(client, tx, exc)
132
+ if (
133
+ not isinstance(exc, RushDBError)
134
+ or "transaction_conflict" not in str(exc)
135
+ or attempt == CONFLICT_RETRIES - 1
136
+ ):
137
+ raise
138
+ time.sleep(min(CONFLICT_BACKOFF_CAP, 0.05 * 2**attempt) * (1 + random.random()))
139
+
140
+
141
+ def _rollback(client: RushDB, tx: Any, cause: BaseException) -> None:
142
+ try:
143
+ client.tx.rollback(tx)
144
+ except RushDBError as exc:
145
+ logger.warning("rollback after %r also failed: %s", cause, exc)
146
+
147
+
148
+ def delete_ids(client: RushDB, ids: list[str]) -> None:
149
+ if ids:
150
+ client.records.delete_by_id(ids)
151
+
152
+
153
+ def is_scalar(value: Any) -> bool:
154
+ if isinstance(value, bool) or isinstance(value, str):
155
+ return True
156
+ return isinstance(value, (int, float)) and math.isfinite(value)
157
+
158
+
159
+ def _kind(value: Any) -> type:
160
+ return bool if isinstance(value, bool) else str if isinstance(value, str) else float
161
+
162
+
163
+ def mirror(prefix: str, obj: Mapping[str, Any]) -> dict[str, Any]:
164
+ """The filterable properties of ``obj``: top-level scalars and flat arrays."""
165
+ out: dict[str, Any] = {}
166
+ for key, value in obj.items():
167
+ if is_scalar(value):
168
+ out[f"{prefix}.{key}"] = value
169
+ elif (
170
+ isinstance(value, list)
171
+ and value
172
+ and all(is_scalar(v) for v in value)
173
+ and len({_kind(v) for v in value}) == 1
174
+ ):
175
+ out[f"{prefix}.{key}"] = list(value)
176
+ return out
177
+
178
+
179
+ def to_json(value: Any) -> str:
180
+ return json.dumps(value, ensure_ascii=False, separators=(",", ":"), default=str)
181
+
182
+
183
+ def b64(data: bytes) -> str:
184
+ return base64.b64encode(data).decode("ascii")
185
+
186
+
187
+ def unb64(data: str) -> bytes:
188
+ return base64.b64decode(data)
189
+
190
+
191
+ def iso(dt: datetime) -> str:
192
+ return dt.astimezone(timezone.utc).isoformat(timespec="milliseconds").replace("+00:00", "Z")
193
+
194
+
195
+ def parse_iso(value: str) -> datetime:
196
+ """Parse an engine datetime; the engine may echo midnight as a bare date."""
197
+ parsed = datetime.fromisoformat(value.replace("Z", "+00:00"))
198
+ return parsed if parsed.tzinfo else parsed.replace(tzinfo=timezone.utc)
199
+
200
+
201
+ def now_iso() -> str:
202
+ return iso(datetime.now(timezone.utc))