Démarrage rapide

2 min de lecture

Obtenez une API JSON-RPC depuis votre base PostgreSQL en moins d’une minute. Votre base de données est votre backend — sans framework, sans boilerplate.

1. Installation

Téléchargez un binaire

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

# ou téléchargez la dernière version pour votre OS :
#   https://github.com/heptau/pgarachne/releases/latest

2. Préparez votre base de données

Créez une base et chargez le schéma PgArachne :

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

3. Configurez et démarrez

Créez un fichier pgarachne.env (le serveur le trouve dans le répertoire courant) :

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

Démarrez le serveur :

./pgarachne

4. Définissez une fonction

Dans votre base, créez un rôle et une fonction. Le commentaire SQL de la fonction la documente pour les LLM.

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. Appelez-la

Votre endpoint API est en ligne :

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. Connectez un agent IA (MCP)

Exposez les mêmes fonctions à Claude Desktop ou Cursor comme outils via l’endpoint MCP :

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

Voir MCP (Model Context Protocol) pour les instructions complètes de connexion.

Voilà. Lisez le guide Hello World pour le flux JWT, ou la comparaison avec PostgREST pour comprendre où PgArachne se situe.

← Comparaison avec PostgREST Installation →

Démarrage rapide