HPKV WebSocket Client SDK

This repository contains HPKV WebSocket client SDK implementations.

About HPKV

HPKV is a high-performance key-value store designed for applications that require ultra-fast data access with consistent performance. It provides:

• Ultra fast access times
• WebSocket API
• REST API
• AI-Powered queries
• Semantic search
• Pub-Sub capabilities for building real-time reactive applications
• Simple yet powerful interface for storing and retrieving data

Repository Structure

This repository contains WebSocket client SDKs for different programming languages:

websocket-client/
├── sdk/
│   └── node/      # NodeJS SDK
│       ├── src/       # Source code
│       ├── examples/  # Usage examples
|       ├── tests/     # integration tests
│       └── README.md  # NodeJS SDK documentation

Currently, only the NodeJS SDK is available, with more language implementations coming soon.

Available SDKs

NodeJS

• NodeJS SDK Documentation
• Installation: npm install @hpkv/websocket-client

HPKV WebSocket API

The WebSocket API provides a persistent connection for high-performance operations with HPKV. It's designed for applications that need to minimize latency and reduce overhead from multiple HTTP requests.

Key Features

• Persistent Connections: Maintain a single connection for multiple operations
• Lower Latency: Minimize round-trip delays compared to REST API
• Bidirectional Communication: Enable real-time data updates
• Key Monitoring (Pub-Sub): Get notified when specific keys change
• Atomic Operations: Perform atomic increments/decrements and JSON patching

Operations Supported

• Insert/Update records
• Get records by key
• JSON Patch/Append to records
• Delete records
• Range queries
• Atomic increments/decrements
• Real-time key monitoring (Pub-Sub)

Getting Started

1. Generate an API Key

To start using HPKV, you'll need an API key:

1. Sign up at hpkv.io
2. Go to the API Keys section in your Dashboard
3. Click "Generate API Key"
4. Select your preferred region
5. Add an optional description
6. Save your API key securely - you won't be able to see it again

2. Install the SDK for Your Preferred Language

Currently, only NodeJS is supported:

npm install @hpkv/websocket-client

Documentation

• HPKV Overview
• WebSocket API Documentation
• SDKs Documentation
• Real-time Pub-Sub Blog Post

License

This project is licensed under the MIT License - see the LICENSE file for details.