Pipeline

• What is it for?
• Installation
• Basic Usage
• Advanced Usage
  • Using expressions
  • Using services
  • Adding logger
  • Adding rejection
  • Adding state
  • Setting environment variables

A pipeline is a series of processes, also called steps, that filter or transform data. The first process takes raw input data, uses it and then sends the results to the second process, and so on, ending with the final result produced by the last process in progress.

The different steps of our pipeline are extract, transform or load but the transformation step isn’t mandatory.

Tip : It’s possible to use multiple transformation steps in a pipeline.

What is it for?

This package allows you to create a microservice that will be operating a data pipeline.

Basic usage

To define your pipeline, you need to specify which steps will make up the pipeline using the steps option. Each step contains the configuration of a plugin. For more details, go to the documentation page of the plugin of your choice.

You must also set a code of your choosing, which will help identify the pipeline. This pipeline code should be unique within the satellite.

• YAML
• PHP

pipeline:
  code: 'my-example-pipeline'
  steps:
    - csv:
        extractor:
          file_path: path/to/file/input.csv
          delimiter: ';'
          enclosure: '"'
          escape: '\\'
    - csv:
        loader:
          file_path: path/to/file/output.csv
          delimiter: ','
          enclosure: '"'
          escape: '\\'

<?php

use Kiboko\Component\Pipeline\PipelineRunner;
use Kiboko\Component\Pipeline\Pipeline;
use Kiboko\Component\Flow\Csv\Safe\Extractor;
use Kiboko\Component\Flow\Csv\Safe\Loader;

/** @var Psr\Log\LoggerInterface $logger */ 
$runner = new PipelineRunner();
$pipeline = (new Pipeline($runner))
    ->extract((new Extractor('path/to/file/input.csv'))->setLogger($logger))
    ->load(new Loader('path/to/file/output.csv', delimiter: ','))
    ->run();

Advanced usage

Using expressions

It’s possible to use expressions in your pipeline using the expression_language option. To use these expressions, you need to use our customised Providers which provide the different expressions. For more information, please visit the detailed documentation of the language expressions.

pipeline:
  expression_language:
    - 'Kiboko\Component\Satellite\ExpressionLanguage\Provider'

Using services

You can use services in your pipeline in the same way as in a traditional Symfony application.

For more details, go to the detailed services documentation.

pipeline:
  services:
    App\Service\Bar:
      arguments:
        - 'my-file.csv'

Adding logger

It’s possible to add a logger at each step of the pipeline.

For more details, go to the detailed logger documentation.

satellite:
# ...
   pipeline:
      code: 'my-example-pipeline'
      steps:
      - akeneo:
        # ...
        logger:
          channel: pipeline
          destinations:
            - elasticsearch:
                level: warning
                hosts:
                  - http://user:password@elasticsearch.example.com:9200

Adding rejection

It’s possible to add a rejection at each step of the pipeline.

For more details, go to the detailed rejection documentation

satellite:
# ...
   pipeline:
      code: 'my-example-pipeline'
      steps:
      - akeneo:
        # ...
        rejection:
          destinations:
            - rabbitmq:
                host: rabbitmq.example.com
                vhost: /
                topic: foo.rejects

Adding state

It’s possible to add a state at each step of the pipeline.

For more details, go to the detailed state documentation

satellite:
# ...
   pipeline:
      code: 'my-example-pipeline'
      steps:
      - akeneo:
        # ...
        state:
          destinations:
            - rabbitmq:
                host: rabbitmq.example.com
                vhost: /
                topic: foo.rejects

Setting environment variables

It’s possible to set environment variables in a .env file, located in your working directory, to re-use those variables in the declaration of your pipeline.

Example of a .env file:

MY_SERVICE_API_KEY=abc123
SOME_SECRET_KEY=123456789

Then use the variables like this in the configuration:

# ...
  pipeline:
    code: 'my-example-pipeline'
    steps:
      - akeneo:
        # ...
        client:
          client_id: '@=env("MY_SERVICE_API_KEY")'
          secret: '@=env("SOME_SECRET_KEY")'

The .env file must be located in the working directory (next to the configuration file of your pipeline), as it will be symlinked inside the resulting build files.