Skip to main content

SDKs and client libraries

Use an SDK when you want typed helpers for HTTP, SQL requests, key/value operations, and realtime subscriptions. Use PostgreSQL or RESP clients when you want to keep an existing driver and protocol in your application.

JavaScript and TypeScript​

Install @rymelabs/rymedb:

npm install @rymelabs/rymedb

Create a RymeHttpClient with the server URL and API key, then use its kvPut, kvGet, sql, and ready methods. Realtime helpers include subscribeTable, subscribeQuery, subscribeBroadcast, and presence APIs. See the JavaScript SDK guide for examples and options.

Rust​

Add rymedb-client and a Tokio runtime to your application. RymeClient provides async HTTP operations and WebSocket subscriptions. See the Rust SDK guide for a complete quickstart.

Direct protocol clients​

Connect PostgreSQL drivers to port 5433 and RESP/Redis-compatible clients to port 6380 by default. HTTP and WebSocket clients use port 8080. The PostgreSQL, RESP, and REST API guides describe supported behavior and compatibility boundaries.