PulseSocketDB Docs

Developer Documentation

Complete guide to install the SDK, connect your VPS, and build real-time applications with PulseSocketDB.

Getting Started

How PulseSocketDB Works — Control Plane Architecture

PulseSocketDB operates on a "Control Plane" model. The PulseSocketDB Cloud manages authentication, project management, quotas, billing, and the real-time sync engine. Your actual database (Redis) runs 100% on your own VPS. This means zero vendor lock-in and complete LGPD/GDPR data sovereignty.

text

┌─────────────────┐     ┌────────────────────────┐     ┌─────────────────┐
│   Your App      │────▶│  PulseSocketDB Cloud  │────▶│   Your VPS      │
│  (Frontend)     │      │   (Control Plane)     │     │   (Redis DB)    │
│                 │◀───  │  Auth · Quotas · Sync  │◀─── │  100% Your Data │
└─────────────────┘     └────────────────────────┘     └─────────────────┘
   SDK / REST API          api.pulsesocketdb.com        YOUR_VPS_IP:6379

PulseSocketDB resolves database namespaces dynamically. You do not need to pre-create or structure schemas. Simply send a request to a collection name, and the database engine automatically structures the keys in memory.

Quick Start in 4 Steps

Create an Account

Create a Project

Go to "Projects" → "Create Project". You receive 3 API Keys (dev, staging, prod).

Install the SDK

npm install pulsesocketdb

Start Building!

Initialize the client and start reading/writing data in real-time.

Environment API Keys

Environment	Key Prefix	Use Case
Development	pk_dev_...	Local testing and sandbox development. Data is isolated per environment.
Staging	pk_staging_...	QA and pre-production testing. Connects to staging Redis on your VPS.
Production	pk_prod_...	Live customer data. Connects to production Redis on your VPS with AOF persistence.