Skip to content
DBX – Minimal, Blazing-Fast API Proxy

DBX

Minimal, blazing-fast API proxy for edge and embedded systems.

npm install @0dbx/redis

DBX is a minimal, blazing-fast Redis API proxy designed for edge and embedded systems. Built in Rust with TypeScript SDK support, providing REST and WebSocket APIs for Redis operations.

Get started

GitHub

DBX Documentation

Welcome to the DBX documentation! DBX is a lightweight, high-performance Redis API proxy designed for edge and embedded systems.

What is DBX?

DBX is a minimal and portable HTTP/WebSocket proxy that exposes Redis through a unified API layer. Built in Rust, DBX is optimized for edge runtimes like Cloudflare Workers, Raspberry Pi, and RISC-V boards.

Key Features

  • 🚀 Lightweight: Minimal footprint, perfect for edge computing
  • 🔌 Redis-Focused: Optimized Redis operations with connection pooling
  • 🌐 Dual Interface: HTTP REST API + WebSocket real-time updates
  • 📱 TypeScript SDK: Full client library with type safety via NAPI bindings
  • ⚡ High Performance: Built in Rust for maximum efficiency
  • 🔧 Pluggable: Easy to extend with new database backends

Quick Start

Using Docker

# Run with Docker
docker run -d --name dbx -p 3000:3000 \
  -e REDIS_URL=redis://localhost:6379 \
  effortlesslabs/0dbx_redis:latest

Using TypeScript SDK

# Install SDK
npm install @0dbx/redis
 
# Use in your code
import { DbxRedisClient } from "@0dbx/redis";
 
const client = new DbxRedisClient("http://localhost:3000");
await client.string.set("key", "value");
const value = await client.string.get("key");

Documentation Sections

Getting Started

API Reference

REST API

WebSocket API

SDK Documentation

TypeScript SDK

Deployment

Development

API Endpoints Overview

REST API Endpoints

EndpointMethodDescription
/redis/string/{key}GETGet string value
/redis/string/{key}POSTSet string value
/redis/string/{key}DELETEDelete string value
/redis/hash/{key}/field/{field}GETGet hash field
/redis/hash/{key}/field/{field}POSTSet hash field
/redis/set/{key}/membersGETGet set members
/redis/set/{key}/membersPOSTAdd set members
/redis/admin/healthGETHealth check
/redis/admin/pingGETPing server

WebSocket Endpoints

EndpointDescription
ws://localhost:3000/redis_ws/string/wsString operations
ws://localhost:3000/redis_ws/hash/wsHash operations
ws://localhost:3000/redis_ws/set/wsSet operations
ws://localhost:3000/redis_ws/admin/wsAdmin operations

Use Cases

Edge Computing

Deploy DBX on edge nodes to provide local database access with cloud synchronization capabilities.

IoT Applications

Use DBX in embedded systems to provide a standardized API for various database backends.

Microservices

Integrate DBX as a database proxy layer in microservice architectures for consistent data access patterns.

Real-time Applications

Leverage WebSocket connections for real-time data synchronization and event streaming.

Community

License

DBX is open source and available under the MIT License.

Features

🚀 Performance

Ultra-low latency optimized for edge computing environments with high throughput and minimal overhead.

🔧 Redis Operations

String, Hash, and Set operations with batch support and connection pooling.

🌐 Connectivity

REST API and WebSocket connections with a full-featured TypeScript SDK.

🛡️ Edge-Optimized

~50MB Docker image designed for Cloudflare Workers, IoT devices, and microservices.

Quick Start

# Run with Docker
docker run -d --name dbx -p 3000:3000 \
  -e REDIS_URL=redis://localhost:6379 \
  effortlesslabs/0dbx_redis:latest
 
# Use the TypeScript SDK
npm install @0dbx/redis

Community

Sponsors