Rotas do Módulo de Coleta
Tutoriais passo a passo para gerenciar pipelines via API
Rotas do Módulo de Coleta
Tutoriais passo a passo para cenários comuns de gerenciamento de pipelines via API.
Casos de Uso
| Cenário | Descrição | Guia |
|---|---|---|
| Nova coluna na origem | Adicionar coluna a pipeline incremental com backfill | Caso 1 |
| Registros duplicados | Migrar de incremental para incremental_with_qualify | Caso 2 |
| Job falhando com OOM | Aumentar memória de job que falha por falta de recursos | Caso 3 |
| Personalizar nomes de tabelas | Customizar nomes de tabelas raw e qualify no Snowflake | Caso 4 |
Conceitos Rápidos
Pipeline e Jobs
Pipeline (postgres_vendas)
├── Job 0: clientes
├── Job 1: pedidos
└── Job 2: produtos
Uma pipeline contém um ou mais jobs. Cada job sincroniza uma tabela.
Job ID
O jobId segue o formato: {pipeline_id}-{job_index}
Exemplo: f47ac10b-58cc-4372-a567-0e02b2c3d479-0 (primeiro job)
Nota: Nas respostas da API, o
job_idpode aparecer normalizado com_(underscores), mas nos endpoints deve-se usar-(hífens).
Modos de Sincronização (JDBC)
| Modo | Comportamento |
|---|---|
full_load | Extrai tudo a cada execução |
incremental | Extrai apenas novos/modificados |
incremental_with_qualify | Incremental + deduplicação por primary key |
Endpoints Principais
| Ação | Endpoint |
|---|---|
| Listar pipelines | GET /platform/pipelines |
| Consultar job JDBC | GET /platform/jobs/jdbc/{jobId} |
| Adicionar colunas | PATCH /platform/jobs/{jobId}/input |
| Migrar sync mode | POST /platform/jobs/jdbc/{jobId}/sync-mode |
| Alterar memória job | PUT /platform/jobs/{jobId}/memory |
| Alterar memória pipeline | PUT /platform/pipeline/{pipelineId}/memory |
| Resetar estado | POST /platform/jobs/{jobId}/reset-state |
| Executar pipeline | POST /platform/pipeline/execute |
| Monitorar execuções | GET /platform/pipeline/{pipelineId}/runs |
Referência Completa
Para documentação detalhada de cada endpoint, consulte a documentação de referência da API.
Updated 11 minutes ago
