Referência da API¶
Gerada automaticamente do código (docstrings e assinaturas).
Tap¶
tap_ixc.tap.IXCTap
¶
Tap IXC — sincroniza streams de uma API IXC para Postgres.
Streams disponíveis por padrão: clientes, contratos, titulos.
Source code in tap_ixc/tap.py
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
check_connection()
¶
Verifica se as credenciais são válidas antes de rodar. Retorna (True, None) se ok, (False, mensagem) se falhar.
discover()
¶
Retorna o Catalog com todos os streams disponíveis. sync_mode padrão: INCREMENTAL se o stream tem replication_key, FULL caso contrário.
Source code in tap_ixc/tap.py
sync(destination, catalog=None, from_checkpoint=False, client_id='default')
¶
Sincroniza streams para o destino.
catalog=None → sincroniza todos os streams disponíveis. client_id → identificador gravado nos logs de observabilidade.
Source code in tap_ixc/tap.py
tap_ixc.tap.Destination
dataclass
¶
Configuração do destino Postgres.
Source code in tap_ixc/tap.py
tap_ixc.tap.TapResult
dataclass
¶
Catálogo¶
tap_ixc.catalog.Catalog
dataclass
¶
Conjunto de streams a sincronizar.
Source code in tap_ixc/catalog.py
select(*names)
¶
Retorna novo Catalog apenas com os streams indicados.
Source code in tap_ixc/catalog.py
tap_ixc.catalog.CatalogEntry
dataclass
¶
Configura como um stream é sincronizado para o destino.
Source code in tap_ixc/catalog.py
tap_ixc.catalog.SyncMode
¶
Stream¶
tap_ixc.streams.base.Stream
¶
Representa um stream de dados da API IXC.
Para criar um novo stream, basta herdar e definir os atributos:
class MeuStream(Stream):
name = "meu_stream"
api_endpoint = "meu_endpoint"
replication_key = "ultima_atualizacao" # para modo incremental
Source code in tap_ixc/streams/base.py
get_records(client, sync_mode, since=None, page_size=None)
¶
Retorna registros da API. Delega paginação ao IXCClient.
Source code in tap_ixc/streams/base.py
Cliente HTTP¶
tap_ixc.extractors.api.IXCClient
¶
HTTP client para APIs IXC.
A API usa GET com body JSON (não query string). Circuit breaker por endpoint — um endpoint falhando não afeta os outros.
Source code in tap_ixc/extractors/api.py
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | |
check_connection()
¶
Verifica se as credenciais são válidas. Retorna (True, None) se ok, (False, mensagem_erro) se falhar.
Source code in tap_ixc/extractors/api.py
paginate(endpoint, strategy='full', incremental_since=None, page_size=None)
¶
Pagina um endpoint IXC, yielding um registro por vez.
Source code in tap_ixc/extractors/api.py
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | |
Configuração¶
tap_ixc.config.settings.ApiConfig
¶
Bases: BaseModel
Source code in tap_ixc/config/settings.py
tap_ixc.config.settings.ClientConfig
¶
Bases: BaseModel
Source code in tap_ixc/config/settings.py
tap_ixc.config.settings.EndpointConfig
¶
Bases: BaseModel
Source code in tap_ixc/config/settings.py
tap_ixc.config.settings.get_client(name, path=None)
¶
Source code in tap_ixc/config/settings.py
tap_ixc.config.settings.load_clients(path=None)
¶
Source code in tap_ixc/config/settings.py
Core¶
tap_ixc.core.pipeline.PipelineRun
¶
Executa stages em ordem, respeitando checkpoints.
Source code in tap_ixc/core/pipeline.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | |
tap_ixc.core.checkpoint.Checkpoint
¶
Source code in tap_ixc/core/checkpoint.py
tap_ixc.core.events.EventStore
¶
Source code in tap_ixc/core/events.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
write_dead_letters(run_id, stream, dead)
¶
Grava linhas reprovadas na validação. dead = [{record, errors}, ...].
Source code in tap_ixc/core/events.py
tap_ixc.core.contracts.sanitize(record)
¶
Substitui strings vazias e datas inválidas (0000-00-00, 2024-03-00, etc.) por None. Migrado do sistema legado.
Source code in tap_ixc/core/contracts.py
tap_ixc.core.contracts.validate_batch(records, schema=None)
¶
Sanitiza e valida um batch. Retorna (válidos, dead_letter). Se schema=None, apenas sanitiza.
Source code in tap_ixc/core/contracts.py
Loaders¶
tap_ixc.loaders.staging.StagingLoader
¶
Consome um Iterator de records, grava NDJSON e carrega no DuckDB persistente.
Se fields for fornecido, o DuckDB só mantém essas colunas.
Se transform_sql for fornecido, substitui qualquer SELECT automático.
Source code in tap_ixc/loaders/staging.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | |
load(records)
¶
Consome o iterador, grava NDJSON sanitizado e carrega no DuckDB. Retorna (ndjson_path, total_records).
Source code in tap_ixc/loaders/staging.py
read_all()
¶
Lê todas as linhas da tabela DuckDB como dicts (para validação).
Source code in tap_ixc/loaders/staging.py
replace(rows)
¶
Reescreve a tabela DuckDB apenas com rows (subset pós-validação).
Source code in tap_ixc/loaders/staging.py
tap_ixc.loaders.postgres.PostgresLoader
¶
Source code in tap_ixc/loaders/postgres.py
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | |
drop_staging()
¶
Remove a staging __stg_<table> do Postgres (idempotente).
Para teardown: garante limpeza mesmo se o LOAD falhar antes do swap. Só fala com o Postgres → roda em qualquer worker.
Source code in tap_ixc/loaders/postgres.py
stage()
¶
Empurra a tabela DuckDB local para a staging compartilhada no Postgres
(__stg_<table>). Roda no worker que tem o DuckDB (o do EXTRACT). Retorna count.
Source code in tap_ixc/loaders/postgres.py
swap()
¶
Troca a staging do Postgres (__stg_<table>) para a tabela final, atômico.
Só fala com o Postgres (DuckDB em memória) → roda em QUALQUER worker. Retorna count.
Source code in tap_ixc/loaders/postgres.py
Runner¶
tap_ixc.runner.run(client_name, streams=None, from_checkpoint=False, duckdb_path=None)
¶
Roda o tap para um cliente definido no clients.yml. streams=None → todos os streams configurados no YAML. duckdb_path → sobrescreve o staging DuckDB (útil p/ isolar por stream em execuções paralelas, ex: uma task Airflow por stream).