Repository navigation
feat!: 3.0 — RushDB Cloud and self-hosted engine (direct mode) - #1
Merged
Merged
Conversation
One SDK, two modes. In direct mode a local router answers every SDK route from a standalone rushdbd over Protocol v1; nothing is ever sent to RushDB Cloud. - Cloud-only features (managed embeddings, ai.search, relationship patterns, settings) throw CloudOnlyError before sending anything; CLOUD_ONLY_METHODS / CLOUD_ONLY_FORMS / isCloudOnlyMethod list them. - Transactions stage record creates, update, set, deleteById, attach and JSON/CSV imports; writes the engine cannot stage throw DirectModeError. - records.detach without typeOrTypes/direction removes every type both ways; untyped links use __RUSHDB__RELATION__DEFAULT__. - New scope option for a multitenant engine; engineToken removed; direct: true requires engineUrl. - Fixed: direct mode never sent a request body; findById([...ids]) posted to the create endpoint. - Node ESM build and exports map (import RushDB from ... gets the class). - Text search, text indexes, hybrid fusion and named embedding indexes.
From 3.0 the self-hostable part of RushDB is the engine (rushdbd), reached in direct mode. The dashboard, managed embeddings and the AI features are part of RushDB Cloud. Remove the remaining mentions of a self-hosted platform: mode tables, the `url` option (a RushDB Cloud API endpoint), RUSHDB_API_URL, and the traversal notes (an omitted hops.max means up to 10 hops; there is no unbounded traversal).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RushDB 3.0: RushDB Cloud and a self-hosted engine
The SDK works with RushDB Cloud (API key) or a self-hosted RushDB engine (
rushdbd) in direct mode (direct: true,engineUrl). In direct mode a local router answers every SDK route from the engine over Protocol v1; nothing is ever sent to RushDB Cloud.ai.search, relationship patterns, settings) throwCloudOnlyErrorbefore sending anything.CLOUD_ONLY_METHODS,CLOUD_ONLY_FORMS,isCloudOnlyMethodlist them.update,set,deleteById,attach,importJson,importCsv; writes the engine cannot stage throwDirectModeError.typeOrTypes/directionremoves every type both ways; untyped links use__RUSHDB__RELATION__DEFAULT__.scopeoption (multitenant engine);engineTokenremoved;direct: truerequiresengineUrl.exportsmap (import RushDB fromgets the class).findById([...ids])posted to the create endpoint.Changesets:
major→ 3.0.0.Release order
This is step 1: merge, then merge the Version Packages PR to publish 3.0.0.
@rushdb/mcp-server,@rushdb/agent-memory-contractand@rushdb/openclaw-memorydepend on^3.0.0and refresh their lockfiles after this is published.Tests
65+ unit tests (every SDK method classified and checked in direct mode) and 11 live tests against a real engine (
RUSHDB_TEST_ENGINE_URL).