Database CLI

CLI commands for database operations in PraisonAI TypeScript

The praisonai-ts CLI provides the db command for database adapter management and testing.

Quick Start

1. Simple Usage

   praisonai-ts db connect sqlite:./data.db
   
2. With Configuration

   praisonai-ts db test postgres://user:pass@host:5432/db
   

---

Commands Overview

Command	Description
db connect <url>	Connect to a database
db test [url]	Test database operations
db adapters	List available adapters
db info	Show database information
db help	Show help

Connect to Database

Test database connectivity:

# Connect to SQLite
praisonai-ts db connect sqlite:./data.db

# Connect to PostgreSQL
praisonai-ts db connect postgres://user:pass@host:5432/db

# Connect to Redis
praisonai-ts db connect redis://localhost:6379

# JSON output
praisonai-ts db connect sqlite:./data.db --json

Example Output:

ℹ Connecting to: sqlite:./data.db
✓ Connected successfully (15ms)
  URL: sqlite:./data.db

JSON Output:

{
  "success": true,
  "data": {
    "url": "sqlite:./data.db",
    "connected": true,
    "latency_ms": 15
  }
}

Test Database Operations

Run a full database test:

# Test with in-memory SQLite (default)
praisonai-ts db test

# Test specific database
praisonai-ts db test sqlite:./test.db

# JSON output
praisonai-ts db test --json

Example Output:

ℹ Testing database: sqlite::memory:
✓ All tests passed (11ms)
  ✓ Initialize
  ✓ Create session
  ✓ Add message
  ✓ Get messages (1 retrieved)
  ✓ Delete session

List Adapters

View available database adapters:

praisonai-ts db adapters
praisonai-ts db adapters --json

Example Output:

Database Adapters

  ✓ sqlite          SQLite database
  ✓ postgres        PostgreSQL (Neon)
  ✓ redis           Redis (Upstash)

JSON Output:

{
  "success": true,
  "data": {
    "adapters": [
      { "name": "sqlite", "description": "SQLite database", "available": true },
      { "name": "redis", "description": "Redis (Upstash)", "available": true },
      { "name": "postgres", "description": "PostgreSQL (Neon)", "available": true }
    ]
  }
}

The listing shows which adapter factories exist — not which back the Agent’s session store. Only sqlite implements the full DbAdapter contract (sessions, messages, runs) and is durable across restarts. postgres and redis are remote-only key/value transports (Neon HTTP, Upstash REST); db("postgres://…") and db("redis://…") throw when used as an Agent session store. See Database.

Database Info

Show database feature information:

praisonai-ts db info

Supported Database URLs

Database	URL Format
SQLite	sqlite:./data.db or sqlite::memory:
PostgreSQL	postgres://user:pass@host:5432/db
Redis	redis://host:port or rediss://...

SDK Usage

db("sqlite:./data.db") returns a real, working SqliteDbAdapter that implements the full session/message/run contract. The createUpstashRedis / createNeonPostgres factories return remote-only key/value transports — not DbAdapters.

import { db, createUpstashRedis, createNeonPostgres } from 'praisonai';

// Durable Agent session store — a real SqliteDbAdapter
const adapter = db("sqlite:./data.db");
await adapter.connect();

// Remote key/value transports (query/get/set) — NOT Agent session stores
const redis = createUpstashRedis({
  url: process.env.UPSTASH_REDIS_URL,
  token: process.env.UPSTASH_REDIS_TOKEN
});
const pg = createNeonPostgres({
  connectionString: process.env.DATABASE_URL
});

For more details, see the Database SDK documentation.

Related

Database

SDK persistence

Cache CLI

Cache management