Início rápido

2 min de leitura

Início rápido

Obtenha uma API JSON-RPC funcionando a partir do seu banco PostgreSQL em menos de um minuto. Seu banco de dados é seu backend — sem framework, sem boilerplate.

1. Instalação

Baixe um binário

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

# ou baixe o lançamento mais recente para seu sistema:
#   https://github.com/heptau/pgarachne/releases/latest

2. Prepare seu banco de dados

Crie um banco de dados e carregue o schema do PgArachne:

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

3. Configure e inicie

Crie um arquivo pgarachne.env (o servidor o encontra no diretório atual):

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

Inicie o servidor:

./pgarachne

4. Defina uma função

No seu banco, crie um papel e uma função. O comentário SQL da função a documenta para 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. Chame-a

Seu endpoint de API está no ar:

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. Conecte um agente de IA (MCP)

Exponha as mesmas funções ao Claude Desktop ou Cursor como ferramentas via endpoint MCP:

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

Veja MCP (Model Context Protocol) para instruções completas de conexão.

Pronto. Leia o guia Hello World para o fluxo de autenticação JWT, ou a comparação com o PostgREST para entender onde o PgArachne se encaixa.

Documentação relacionada

← Comparação com PostgREST Instalação →