Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/engine-binary-rushdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@rushdb/javascript-sdk": patch
---

Refer to the self-hosted engine binary as `rushdb` (`rushdb serve`) in the README, JSDoc, and generated docs.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ The SDK works with RushDB in one of two ways:

| | RushDB Cloud | Self-hosted RushDB engine (direct mode) |
| --- | --- | --- |
| What you run | nothing: the managed service at [app.rushdb.com](https://app.rushdb.com) | one `rushdbd` binary, on your own infrastructure |
| What you run | nothing: the managed service at [app.rushdb.com](https://app.rushdb.com) | one `rushdb` binary, on your own infrastructure |
| Connect with | an API key | the engine URL and the engine token |

The engine is what you can self-host. RushDB Cloud runs that engine for you and adds the dashboard,
Expand Down
10 changes: 5 additions & 5 deletions docs-reference.json
Original file line number Diff line number Diff line change
Expand Up @@ -10709,7 +10709,7 @@
},
{
"kind": "code",
"text": "`rushdbd`"
"text": "`rushdb`"
},
{
"kind": "text",
Expand Down Expand Up @@ -23302,7 +23302,7 @@
},
{
"kind": "code",
"text": "`rushdbd`"
"text": "`rushdb`"
},
{
"kind": "text",
Expand Down Expand Up @@ -47236,7 +47236,7 @@
},
{
"kind": "code",
"text": "`rushdbd`"
"text": "`rushdb`"
},
{
"kind": "text",
Expand Down Expand Up @@ -47480,7 +47480,7 @@
},
{
"kind": "code",
"text": "`rushdbd --multitenant`"
"text": "`rushdb serve --multitenant`"
},
{
"kind": "text",
Expand Down Expand Up @@ -51315,7 +51315,7 @@
},
{
"kind": "code",
"text": "`rushdbd`"
"text": "`rushdb`"
},
{
"kind": "text",
Expand Down
2 changes: 1 addition & 1 deletion docs-reference/classes/RestAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Optional smart-search context and transaction

Defined in: [api/api.ts:85](https://github.com/rush-db/javascript-sdk/blob/main/src/api/api.ts#L85)

Direct engine transport (standalone `rushdbd`) when `direct` mode is set.
Direct engine transport (standalone `rushdb`) when `direct` mode is set.
In direct mode every request is answered from the engine; nothing is sent
to RushDB Cloud.

Expand Down
2 changes: 1 addition & 1 deletion docs-reference/classes/RushDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ Optional smart-search context and transaction

Defined in: [api/api.ts:85](https://github.com/rush-db/javascript-sdk/blob/main/src/api/api.ts#L85)

Direct engine transport (standalone `rushdbd`) when `direct` mode is set.
Direct engine transport (standalone `rushdb`) when `direct` mode is set.
In direct mode every request is answered from the engine; nothing is sent
to RushDB Cloud.

Expand Down
4 changes: 2 additions & 2 deletions docs-reference/type-aliases/SDKConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Defined in: [sdk/types.ts:27](https://github.com/rush-db/javascript-sdk/blob/mai

> `optional` **direct?**: `boolean`

Direct mode: talk to a standalone RushDB engine (`rushdbd`) instead of
Direct mode: talk to a standalone RushDB engine (`rushdb`) instead of
RushDB Cloud. Requires `engineUrl`; the token is the engine token. The
methods listed in `CLOUD_ONLY_METHODS` throw `CloudOnlyError`, and no
request is ever sent to RushDB Cloud.
Expand Down Expand Up @@ -53,7 +53,7 @@ which results in deleting all Records in the project.

> `optional` **scope?**: `string`

Tenant on a multitenant engine (`rushdbd --multitenant`), sent as
Tenant on a multitenant engine (`rushdb serve --multitenant`), sent as
`X-RushDB-Tenant`. Omit for a single-tenant engine.

### timeout?
Expand Down
2 changes: 1 addition & 1 deletion docs-reference/variables/CLOUD_ONLY_METHODS.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ What RushDB Cloud adds over a standalone engine, as SDK methods. One list:
the direct-mode router refuses these with `CloudOnlyError`, the MCP server
hides the tools built on them, and the docs mark them.

Everything else the SDK offers runs against a standalone `rushdbd` too.
Everything else the SDK offers runs against a standalone `rushdb` too.

## Type Declaration

Expand Down
2 changes: 1 addition & 1 deletion src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export class RestAPI {
public options: SDKConfig['options']
public logger: SDKConfig['logger']
/**
* Direct engine transport (standalone `rushdbd`) when `direct` mode is set.
* Direct engine transport (standalone `rushdb`) when `direct` mode is set.
* In direct mode every request is answered from the engine; nothing is sent
* to RushDB Cloud.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/direct/capabilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* the direct-mode router refuses these with `CloudOnlyError`, the MCP server
* hides the tools built on them, and the docs mark them.
*
* Everything else the SDK offers runs against a standalone `rushdbd` too.
* Everything else the SDK offers runs against a standalone `rushdb` too.
*/
export const CLOUD_ONLY_METHODS = {
'ai.search': 'natural-language search turns the prompt into a query with an LLM',
Expand Down
2 changes: 1 addition & 1 deletion src/direct/engine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export type ProtocolResponse = {

/**
* Direct engine transport: executes protocol operations against a standalone
* `rushdbd` (`/protocol/v1/execute`) over HTTP. This is the SDK's "direct
* `rushdb` (`/protocol/v1/execute`) over HTTP. This is the SDK's "direct
* mode" — no RushDB Cloud. `scope` is the tenant on a multitenant engine
* (`X-RushDB-Tenant`); auth is the engine token.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/sdk/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export type SDKConfig = {
timeout?: number
logger?: Logger
/**
* Direct mode: talk to a standalone RushDB engine (`rushdbd`) instead of
* Direct mode: talk to a standalone RushDB engine (`rushdb`) instead of
* RushDB Cloud. Requires `engineUrl`; the token is the engine token. The
* methods listed in `CLOUD_ONLY_METHODS` throw `CloudOnlyError`, and no
* request is ever sent to RushDB Cloud.
Expand All @@ -38,7 +38,7 @@ export type SDKConfig = {
/** Standalone engine base URL when `direct` is enabled (e.g. `http://127.0.0.1:3000`). */
engineUrl?: string
/**
* Tenant on a multitenant engine (`rushdbd --multitenant`), sent as
* Tenant on a multitenant engine (`rushdb serve --multitenant`), sent as
* `X-RushDB-Tenant`. Omit for a single-tenant engine.
*/
scope?: string
Expand Down
4 changes: 2 additions & 2 deletions test/direct-engine.live.spec.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
/**
* Direct mode against a real standalone engine. Runs only when
* `RUSHDB_TEST_ENGINE_URL` (and `RUSHDB_TEST_ENGINE_TOKEN`, default
* `local-token`) point at a single-tenant `rushdbd` started with
* `local-token`) point at a single-tenant `rushdb` started with
* `--languages cypher`, e.g.
*
* rushdbd --data-dir /tmp/rushdb-test --port 3877 --languages cypher
* rushdb serve --data-dir /tmp/rushdb-test --port 3877 --languages cypher
* RUSHDB_TEST_ENGINE_URL=http://127.0.0.1:3877 pnpm test
*/
import { describe, it, expect, beforeAll } from 'vitest'
Expand Down
Loading