Szybki start

1 min czytania

Szybki start

Uruchom działające API JSON-RPC z bazy PostgreSQL w mniej niż minutę. Twoja baza danych jest twoim backendem — bez frameworka, bez boilerplate.

1. Instalacja

Pobierz binarkę

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

# lub pobierz najnowsze wydanie dla swojego systemu:
#   https://github.com/heptau/pgarachne/releases/latest

2. Przygotuj bazę danych

Utwórz bazę i załaduj schemat PgArachne:

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

3. Skonfiguruj i uruchom

Utwórz plik pgarachne.env (serwer znajdzie go w bieżącym katalogu):

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

Uruchom serwer:

./pgarachne

4. Zdefiniuj funkcję

W bazie utwórz rolę i funkcję. Komentarz SQL funkcji dokumentuje ją dla modeli 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. Wywołaj ją

Twój endpoint API działa:

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. Podłącz agenta AI (MCP)

Udostępnij te same funkcje Claude Desktop lub Cursorowi jako narzędzia przez endpoint MCP:

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

Pełne instrukcje podłączenia: MCP (Model Context Protocol).

To wszystko. Przeczytaj przewodnik Hello World dla przepływu JWT lub porównanie z PostgREST, aby zrozumieć, gdzie pasuje PgArachne.

Powiązana dokumentacja

← Porównanie z PostgREST Instalacja →