Установка и API за 5 минут

Шаг 1 — установка. Скачайте бинарник для вашей платформы и проверьте целостность контрольной суммой SHA-256 из релиза v3.4.2:

curl -fsSL https://get.syncops.dev | sh
syncops --version # syncops 3.4.2 (build 2025-03-14)

Шаг 2 — инициализация кластера. Создайте конфиг и запустите мастер инициализации. Мастер сгенерирует ключи, настроит WAL-журнал и поднимет контроллеры:

syncops init --region ru-central --nodes 3
syncops up --config syncops.yaml

Шаг 3 — первый пайплайн. Опишите источник и цель, укажите гарантию доставки. После syncops apply данные пойдут, а метрики появятся в :9090/metrics.

Базовый URL: https://api.syncops.dev/v3 · Auth: Authorization: Bearer <token>

GET /pipelines — список пайплайнов с текущим lag и статусом. Query-параметры: ?region=ru-central&status=lagging. Ответ содержит total, page и items[].

POST /pipelines — создание пайплайна из JSON-манифеста. Валидация схемы до применения; при ошибке возвращается 422 с полем errors[].

GET /pipelines/{id}/metrics — метрики конкретного пайплайна за период. Форматы: JSON, CSV, Prometheus exposition format.

POST /checkpoints — принудительный снимок. Тело: {"pipeline":"pg-ch-01","label":"pre-deploy"}. Возвращает 201 с идентификатором чекпоинта.

DELETE /pipelines/{id} — удаление с опциональным ?purge=true для полного стирания WAL-записей. Без purge — мягкое удаление с 30-дневным окном.

Go:

client := syncops.New("https://api.syncops.dev/v3", token)
manifest := syncops.Pipeline{
  Name: "pg-to-ch",
  Source: "postgres://prod-ru-central",
  Target: "clickhouse://analytics",
  Guarantee: syncops.ExactlyOnce,
}
if err := client.Apply(ctx, manifest); err != nil { log.Fatal(err) }

Python:

from syncops import Client, Pipeline

async with Client("https://api.syncops.dev/v3", token) as c:
  pipe = await c.pipelines.create(
    name="pg-to-ch",
    source="postgres://prod-ru-central",
    target="clickhouse://analytics",
    guarantee="exactly-once",
  )
  print(await pipe.metrics.lag())