Skip to content

Le schede di una sub-pipeline ​

Ogni sub-pipeline che una pipeline del catalogo istanzia ha una scheda, docs/sub-pipelines/<nome>.md nel repo che la contiene, creata insieme alla sub-pipeline e aggiornata nello stesso commit di ogni modifica al comportamento. etl docs build non costruisce il sito se ne manca una, cioè una pagina con <SubPipelineDag name="<nome>" />.

Il corpo, gli scopi dei suoi nodi e la sezione «Dove si usa» non si scrivono a mano: <SubPipelineDag> disegna il corpo di un'istanza rappresentativa con la tabella «Lo scopo dei nodi» sotto, <SubPipelineUsage> elenca le istanze, entrambi dai piani delle root del catalogo etl.config.ts.

Una sub-pipeline è un grafo riusabile che una pipeline root istanzia col nodo pipeline. Il codice sta in src/sub-pipelines/<nome>/, e la scheda allo stesso modo. Il nome è unico fra pipeline e sub-pipeline. Fra gli esempi di questa guida c'è riepilogo-ordini.

Template scheda ​

markdown
---
pageClass: etl-wide
---

# Sub-pipeline: <nome>

- **Scopo:** ...
- **Codice:** `src/sub-pipelines/<nome>/sub-pipeline.ts`

## Corpo

<SubPipelineDag name="<nome>" />

Il componente disegna il corpo dell'istanza rappresentativa, la prima nell'ordine del catalogo,
dal piano della sua root, seguito dalla tabella generata degli scopi dei nodi interni. Dopo il
componente, la tabella dei nodi con l'id qualificato e quello locale.

## Parametri

| Parametro | Tipo | Default | Significato |
| --------- | ---- | ------- | ----------- |

Oppure «Nessun parametro». Un parametro compare in chiaro nel piano: mai un segreto.

## Dipendenze

| Slot | Tipo (`lookupDep` / `actionDep`) | A cosa serve nel corpo |
| ---- | -------------------------------- | ---------------------- |

Oppure «Nessuna dipendenza». Le credenziali restano nel connettore che passa la root. Nel piano
ogni dipendenza mostra il descriptor di quel connettore, con variabile e origine per riga come un
nodo: la scheda non le ripete, perché dipendono dall'istanza di connettore scelta dalla root.

## Contratti

| Lato     | Nome     | Schema |
| -------- | -------- | ------ |
| Ingresso | —        | ...    |
| Uscita   | <uscita> | ...    |

## Errori

- Cosa rifiutano i nodi di confine e i nodi interni, con gli id qualificati.

## Dove si usa

<SubPipelineUsage name="<nome>" />

Si ricava dai piani delle root: non si scrive a mano.

## Test

- `src/sub-pipelines/<nome>/sub-pipeline.test.ts`, con `runSubPipeline` e `recordIds` acceso e
  spento; con i default dei parametri e con valori espliciti, e con doppi senza rete per le
  dipendenze.

Noeva è un marchio registrato di 4D S.R.L.