Skip to content

json_stream_reader_task.md

Latest commit

 

History

History
59 lines (45 loc) · 2.73 KB

json_stream_reader_task.md

File metadata and controls

59 lines (45 loc) · 2.73 KB
Raw

JsonStreamReaderTask

Reads a JSON Lines file (one JSON document per line), whose path is given as input, and iterates over its lines, outputting each decoded line.

Task reference

  • Service: CleverAge\ProcessBundle\Task\File\JsonStream\JsonStreamReaderTask
  • Iterable task

Accepted inputs

string: path of the file to read.

Possible outputs

array: for each line, the decoded JSON as an associative array. Underlying methods are SplFileObject::fgets and json_decode.

When a line is empty or decodes to null, no output is produced and the task is skipped for this iteration. Each line must be a JSON object or array: a line decoding to a scalar (e.g. 42 or "foo") raises a \TypeError.

Options

Code Type Required Default Description
spl_file_object_flags array|null null List of SplFileObject flags, summed and passed to SplFileObject::setFlags.
null means DROP_NEW_LINE, READ_AHEAD and SKIP_EMPTY; an empty array means no flag
json_flags array|null null List of JSON flags, summed and passed to json_decode.
null means JSON_THROW_ON_ERROR; an empty array means no flag (invalid lines are then skipped instead of throwing an exception)

Examples

# Task configuration level
entry:
  service: '@CleverAge\ProcessBundle\Task\ConstantOutputTask'
  options:
    output: '%kernel.project_dir%/var/data/json_stream_reader.json'
  outputs: [read]
read:
  service: '@CleverAge\ProcessBundle\Task\File\JsonStream\JsonStreamReaderTask'
  options:
    json_flags:
      - !php/const JSON_THROW_ON_ERROR
      - !php/const JSON_BIGINT_AS_STRING
  outputs: [dump]

Notes

  • Files written by JsonStreamWriterTask can be read by this task, as long as no flag producing multi-line JSON (like JSON_PRETTY_PRINT) was used.