Schnellstart

2 Min. Lesezeit

Schnellstart

Erhalten Sie in weniger als einer Minute eine laufende JSON-RPC-API aus Ihrer PostgreSQL-Datenbank. Ihre Datenbank ist Ihr Backend — ohne Framework, ohne Boilerplate.

1. Installieren

Binärdatei herunterladen

# macOS (Homebrew)
brew install heptau/tap/pgarachne

# oder laden Sie das neueste Release für Ihr OS herunter:
#   https://github.com/heptau/pgarachne/releases/latest

2. Datenbank einrichten

Erstellen Sie eine Datenbank und laden Sie das PgArachne-Schema:

createdb my_database
psql -d my_database -f sql/schema.sql

3. Konfigurieren und starten

Erstellen Sie eine pgarachne.env-Datei (der Server findet sie im aktuellen Verzeichnis):

DB_HOST=localhost
DB_PORT=5432
DB_USER=pgarachne
JWT_SECRET=$(openssl rand -hex 32)

Starten Sie den Server:

./pgarachne

4. Funktion definieren

Erstellen Sie in Ihrer Datenbank eine Rolle und eine Funktion. Der SQL-Kommentar der Funktion dokumentiert sie für LLMs.

CREATE ROLE demo_user WITH LOGIN PASSWORD 'user_password';
GRANT USAGE ON SCHEMA api TO demo_user;

CREATE OR REPLACE FUNCTION api.hello_world(payload jsonb)
RETURNS json LANGUAGE sql AS $$
    SELECT '"Hello World"'::json;
$$;
GRANT EXECUTE ON FUNCTION api.hello_world(jsonb) TO demo_user;

5. Aufrufen

Ihr API-Endpoint ist live:

curl -X POST http://localhost:8080/db/my_database/jsonrpc \
  -u demo_user:user_password \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"api.hello_world","params":{},"id":1}'
# → {"jsonrpc":"2.0","result":"Hello World","id":1}

6. KI-Agent verbinden (MCP)

Stellen Sie dieselben Funktionen Claude Desktop oder Cursor als Tools über den MCP-Endpoint bereit:

POST http://localhost:8080/db/my_database/mcp

Vollständige Verbindungsanleitung: MCP (Model Context Protocol).

Das war’s. Lesen Sie den Hello World-Leitfaden für den JWT-Authentifizierungsfluss oder den Vergleich mit PostgREST, um zu verstehen, wo PgArachne einzuordnen ist.

Verwandte Doku

← Vergleich mit PostgREST Installation →