@grafema/rfdb-client

TypeScript client for RFDB (Rega Flow Database)

Named after the author's wife Regina (Rega for short). The Hebrew word רגע (rega, "moment") conveniently fits the concept — a flow of discrete moments captured in the graph.

Warning: This package is in beta stage and the API may change between minor versions.

Installation

npm install @grafema/rfdb-client

Overview

High-performance TypeScript client for RFDB — a graph database optimized for code analysis. Communicates with RFDB server via Unix socket using MessagePack protocol.

Features

• Socket-based client for out-of-process communication
• MessagePack binary protocol for efficiency
• Batch operations for high-throughput ingestion
• Full graph operations: nodes, edges, queries
• Datalog query support
• Streaming support for large result sets

Quick Start

import { RFDBClient } from '@grafema/rfdb-client';

const client = new RFDBClient('/tmp/rfdb.sock');
await client.connect();

// Add nodes
await client.addNode({
  id: 'func-1',
  nodeType: 'FUNCTION',
  name: 'getUserById',
  file: 'src/api/users.ts'
});

// Batch add for performance
await client.addNodes([node1, node2, node3]);

// Query nodes
const functions = await client.findByType('FUNCTION');

// Execute Datalog query
const results = await client.queryDatalog('node(X, "FUNCTION"), attr(X, "name", "getUserById")');

await client.close();

API

Connection

• connect() — Connect to RFDB server
• close() — Close connection

Nodes

• addNode(node) — Add a single node
• addNodes(nodes) — Batch add nodes
• getNode(id) — Get node by ID
• findByType(type) — Find nodes by type
• queryNodes(query) — Query nodes with filters

Edges

• addEdge(edge) — Add a single edge
• addEdges(edges) — Batch add edges
• getOutgoingEdges(nodeId, types?) — Get outgoing edges
• getIncomingEdges(nodeId, types?) — Get incoming edges

Queries

• queryDatalog(query) — Execute Datalog query

Database Management

• createDatabase(name) — Create a new database
• useDatabase(name) — Switch to a database
• clear() — Clear all data

License

Apache-2.0