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árioDescriçãoGuia
Nova coluna na origemAdicionar coluna a pipeline incremental com backfillCaso 1
Registros duplicadosMigrar de incremental para incremental_with_qualifyCaso 2
Job falhando com OOMAumentar memória de job que falha por falta de recursosCaso 3
Personalizar nomes de tabelasCustomizar nomes de tabelas raw e qualify no SnowflakeCaso 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_id pode aparecer normalizado com _ (underscores), mas nos endpoints deve-se usar - (hífens).

Modos de Sincronização (JDBC)

ModoComportamento
full_loadExtrai tudo a cada execução
incrementalExtrai apenas novos/modificados
incremental_with_qualifyIncremental + deduplicação por primary key

Endpoints Principais

AçãoEndpoint
Listar pipelinesGET /platform/pipelines
Consultar job JDBCGET /platform/jobs/jdbc/{jobId}
Adicionar colunasPATCH /platform/jobs/{jobId}/input
Migrar sync modePOST /platform/jobs/jdbc/{jobId}/sync-mode
Alterar memória jobPUT /platform/jobs/{jobId}/memory
Alterar memória pipelinePUT /platform/pipeline/{pipelineId}/memory
Resetar estadoPOST /platform/jobs/{jobId}/reset-state
Executar pipelinePOST /platform/pipeline/execute
Monitorar execuçõesGET /platform/pipeline/{pipelineId}/runs

Referência Completa

Para documentação detalhada de cada endpoint, consulte a documentação de referência da API.