Console commands

springbok:run

Standard command for running a pipeline.

Usage:

console springbok:run *pipeline_name*

springbok:display

Used for debugging. It utilizes the ->display() functionality from ETL. Works the same way as springbok:run does, with additional table showing the rows being displayed in the console.

Usage:

console springbok:display *pipeline_name* --limit 5 --truncate 20

parameters:

  • limit --limit or -l specifies the number of rows displayed. Default is 20

  • truncate --truncate or -t specifies the maximum length of rows. Default is 20, full length is 0

springbok:trace

Used to measure the performance of a pipeline. It displays console tables containing the measured times for:

  • extractor

  • transformers

  • loaders

It also displays tables for:

  • number rows written to DB

  • number of queries

Each table includes the average time/count and the last measurement

Usage:

console springbok:trace *pipeline_name

Expected outcome:

Pipeline

Last Time

Average Time

Extractor

6ms

7ms

Transformer 1

10ms

15ms

Transformer 2

20ms

12ms

Loader 1

4ms

4ms

Loader 2

3ms

3ms

Publish events

Last count

Average count

Publish event 1

10

10

Publish event 2

20

20

Database

Last

Average

Number Queries

2

2

Number Rows

26

194