Csv.md

CSV

Extracts data from a character-separated values file.

/** @var \Wizaplace\Etl\Extractors\Csv $csv */
$etl->extract(
    $csv,
    'path/to/file.csv',
    $options
);

Options

Columns

Columns that will be extracted. If null, all columns will be extracted and the first line will be used as the columns names.

Type	Default value
array	null

To select which columns will be extracted, use an array with the columns list:

$options = [
    Csv::COLUMNS => [
        'id',
        'name',
        'email',
    ]
];

To rename the columns, use an associative array where the key is the name of the column in the file and the value is the name that will be used in the etl process:

$options = [
    Csv::COLUMNS => [
        'id' => 'id',
        'full_name' => 'name',
        'email_address' => 'email',
    ]
];

If your file does not contains the columns names, you may set the name and the index of the columns to extract starting at 1:

$options = [
    Csv::COLUMNS' => [
        'id' => 1,
        'name' => 2,
        'email' => 3,
    ]
];

Delimiter

Field delimiter (one character only).

Type	Default value
string	,

$options = [Csv::DELIMITER => ';'];

Enclosure

Field enclosure character (one character only).

Type	Default value
string

$options = [Csv::ENCLOSURE => '"'];

Throw error

If the extractor need to throw an exception if it encounters any input issue during the data processing. Default value is set to false to keep backward compatibility.

Type	Default value
boolean	false

$options = [Csv::THROW_ERROR => true];