Skip to content

quick-start.md

Latest commit

 

History

History
102 lines (77 loc) · 3.31 KB

quick-start.md

File metadata and controls

102 lines (77 loc) · 3.31 KB

Quick Start

This guide walks you through a minimal working example in under 60 seconds.

Minimal Example (In-Memory)

<?php

use Lemric\BatchProcessing\BatchProcessing;
use Lemric\BatchProcessing\Domain\JobParameters;
use Lemric\BatchProcessing\Item\Reader\IteratorItemReader;
use Lemric\BatchProcessing\Item\Processor\FilteringItemProcessor;
use Lemric\BatchProcessing\Testing\InMemoryItemWriter;

// 1. Bootstrap — wires repository, transaction manager, factories, launcher
$env = BatchProcessing::inMemoryEnvironment();

// 2. Define components
$reader    = new IteratorItemReader(range(1, 10));
$processor = new FilteringItemProcessor(fn (int $i): bool => $i % 2 === 0);
$writer    = new InMemoryItemWriter();

// 3. Build a step
$step = $env->stepBuilderFactory->get('filterEvenNumbers')
    ->chunk(3, $reader, $processor, $writer)
    ->build();

// 4. Build a job
$job = $env->jobBuilderFactory->get('demoJob')
    ->start($step)
    ->build();

// 5. Launch
$execution = $env->launcher->run($job, JobParameters::of(['run.id' => 1]));

echo $execution->getStatus()->value, PHP_EOL; // COMPLETED
print_r($writer->getWrittenItems());          // [2, 4, 6, 8, 10]

Fault-Tolerant Example

Add retry and skip policies to handle transient failures:

$step = $env->stepBuilderFactory->get('importStep')
    ->chunk(500, $reader, $processor, $writer)
    ->faultTolerant()
    ->retry(\RuntimeException::class, maxAttempts: 3)
    ->skip(\Lemric\BatchProcessing\Exception\SkippableException::class)
    ->skipLimit(50)
    ->build();

Production Example (PDO)

For production workloads, use a real database:

use Lemric\BatchProcessing\BatchProcessing;
use Lemric\BatchProcessing\Repository\PdoJobRepositorySchema;

$pdo = new PDO('mysql:host=127.0.0.1;dbname=myapp', 'user', 'pass');

// Provision the metadata schema (run once, e.g. in a migration)
foreach (PdoJobRepositorySchema::sqlForPdo($pdo, prefix: 'batch_') as $sql) {
    $pdo->exec($sql);
}

// Bootstrap the environment
$env = BatchProcessing::pdoEnvironment($pdo, tablePrefix: 'batch_');

// Build and launch jobs as shown above
$execution = $env->launcher->run($job, $parameters);

The bootstrap environment returned by BatchProcessing::inMemoryEnvironment(), BatchProcessing::pdoEnvironment() and BatchProcessing::asyncEnvironment() is an immutable BatchEnvironment object with:

Property Type
repository JobRepositoryInterface
transactionManager TransactionManagerInterface
stepBuilderFactory StepBuilderFactory
jobBuilderFactory JobBuilderFactory
launcher JobLauncherInterface
registry JobRegistryInterface
operator JobOperatorInterface
explorer JobExplorerInterface

Next Steps