Added more examples

[norberttech]

Change Log

Added

• jsonl writing example
• csv writing example
• xml writing example

Fixed

Changed

• Improved contributing md

Removed

Deprecated

Security

---

Description

[github-actions]

Flow PHP - Benchmarks

^{_{Results of the benchmarks from this PR are compared with the results from 1.x branch.}}

Extractors

+-----------------------+-------------------+------+-----+-----------------+------------------+-----------------+
| benchmark             | subject           | revs | its | mem_peak        | mode             | rstdev          |
+-----------------------+-------------------+------+-----+-----------------+------------------+-----------------+
| CSVExtractorBench     | bench_extract_10k | 1    | 3   | 4.799mb +0.01%  | 555.684ms -0.12% | ±2.10% +614.31% |
| JsonExtractorBench    | bench_extract_10k | 1    | 3   | 4.872mb +0.01%  | 1.060s -0.12%    | ±0.17% -84.50%  |
| ParquetExtractorBench | bench_extract_10k | 1    | 3   | 86.315mb +0.00% | 903.223ms -1.12% | ±0.61% +9.84%   |
| TextExtractorBench    | bench_extract_10k | 1    | 3   | 4.529mb +0.01%  | 35.321ms -0.02%  | ±2.31% +161.76% |
| XmlExtractorBench     | bench_extract_10k | 1    | 3   | 4.503mb +0.01%  | 605.770ms +0.67% | ±0.60% -46.65%  |
+-----------------------+-------------------+------+-----+-----------------+------------------+-----------------+

Transformers

+-----------------------------+--------------------------+------+-----+------------------+-----------------+-----------------+
| benchmark                   | subject                  | revs | its | mem_peak         | mode            | rstdev          |
+-----------------------------+--------------------------+------+-----+------------------+-----------------+-----------------+
| RenameEntryTransformerBench | bench_transform_10k_rows | 1    | 3   | 127.325mb +0.00% | 72.426ms +4.23% | ±0.94% +203.31% |
+-----------------------------+--------------------------+------+-----+------------------+-----------------+-----------------+

Loaders

+--------------------+----------------+------+-----+------------------+------------------+-----------------+
| benchmark          | subject        | revs | its | mem_peak         | mode             | rstdev          |
+--------------------+----------------+------+-----+------------------+------------------+-----------------+
| CSVLoaderBench     | bench_load_10k | 1    | 3   | 63.998mb +0.00%  | 103.447ms -0.80% | ±1.05% +25.87%  |
| JsonLoaderBench    | bench_load_10k | 1    | 3   | 84.345mb +0.00%  | 99.591ms +2.59%  | ±0.75% +207.93% |
| ParquetLoaderBench | bench_load_10k | 1    | 3   | 161.186mb +0.00% | 20.755s +0.72%   | ±0.67% -30.53%  |
| TextLoaderBench    | bench_load_10k | 1    | 3   | 17.995mb +0.00%  | 31.395ms -0.32%  | ±0.34% -71.70%  |
+--------------------+----------------+------+-----+------------------+------------------+-----------------+

Building Blocks

+-------------------+----------------------------+------+-----+------------------+------------------+-----------------+
| benchmark         | subject                    | revs | its | mem_peak         | mode             | rstdev          |
+-------------------+----------------------------+------+-----+------------------+------------------+-----------------+
| EntryFactoryBench | bench_entry_factory        | 1    | 3   | 105.968mb +0.00% | 459.824ms +1.18% | ±1.21% +221.07% |
| EntryFactoryBench | bench_entry_factory        | 1    | 3   | 55.159mb +0.00%  | 231.872ms +1.53% | ±1.37% +7.58%   |
| EntryFactoryBench | bench_entry_factory        | 1    | 3   | 14.681mb +0.00%  | 50.485ms +0.63%  | ±0.70% -20.47%  |
| RowsBench         | bench_chunk_10_on_10k      | 2    | 3   | 97.012mb +0.00%  | 3.317ms -4.63%   | ±1.45% -30.93%  |
| RowsBench         | bench_diff_left_1k_on_10k  | 2    | 3   | 114.295mb +0.00% | 185.442ms +0.38% | ±0.28% -15.71%  |
| RowsBench         | bench_diff_right_1k_on_10k | 2    | 3   | 97.015mb +0.00%  | 18.790ms +1.92%  | ±0.99% +9.12%   |
| RowsBench         | bench_drop_1k_on_10k       | 2    | 3   | 97.886mb +0.00%  | 1.708ms +3.80%   | ±2.80% -16.78%  |
| RowsBench         | bench_drop_right_1k_on_10k | 2    | 3   | 97.886mb +0.00%  | 1.605ms -16.09%  | ±2.51% -2.78%   |
| RowsBench         | bench_entries_on_10k       | 2    | 3   | 96.047mb +0.00%  | 4.604ms -4.01%   | ±2.38% +66.04%  |
| RowsBench         | bench_filter_on_10k        | 2    | 3   | 96.576mb +0.00%  | 16.674ms +2.75%  | ±0.80% -41.89%  |
| RowsBench         | bench_find_on_10k          | 2    | 3   | 96.576mb +0.00%  | 16.901ms -0.67%  | ±0.26% -68.88%  |
| RowsBench         | bench_find_one_on_10k      | 10   | 3   | 95.267mb +0.00%  | 1.994μs +5.28%   | ±2.40% -5.08%   |
| RowsBench         | bench_first_on_10k         | 10   | 3   | 95.267mb +0.00%  | 0.400μs 0.00%    | ±0.00% 0.00%    |
| RowsBench         | bench_flat_map_on_1k       | 2    | 3   | 104.486mb +0.00% | 14.756ms -0.37%  | ±1.07% -1.04%   |
| RowsBench         | bench_map_on_10k           | 2    | 3   | 134.553mb +0.00% | 75.474ms +3.70%  | ±1.26% -34.13%  |
| RowsBench         | bench_merge_1k_on_10k      | 2    | 3   | 97.096mb +0.00%  | 1.493ms -0.78%   | ±2.89% -6.62%   |
| RowsBench         | bench_partition_by_on_10k  | 2    | 3   | 100.394mb +0.00% | 64.529ms +0.34%  | ±0.42% -46.11%  |
| RowsBench         | bench_remove_on_10k        | 2    | 3   | 98.149mb +0.00%  | 3.953ms -3.99%   | ±1.97% +27.93%  |
| RowsBench         | bench_sort_asc_on_1k       | 2    | 3   | 95.557mb +0.00%  | 41.900ms -0.42%  | ±0.59% -39.36%  |
| RowsBench         | bench_sort_by_on_1k        | 2    | 3   | 95.557mb +0.00%  | 41.529ms +1.37%  | ±0.78% +98.11%  |
| RowsBench         | bench_sort_desc_on_1k      | 2    | 3   | 95.557mb +0.00%  | 41.394ms -0.67%  | ±0.35% -6.59%   |
| RowsBench         | bench_sort_entries_on_1k   | 2    | 3   | 97.708mb +0.00%  | 8.207ms -1.65%   | ±1.57% +120.94% |
| RowsBench         | bench_sort_on_1k           | 2    | 3   | 95.458mb +0.00%  | 29.646ms +0.05%  | ±0.58% -67.00%  |
| RowsBench         | bench_take_1k_on_10k       | 10   | 3   | 95.267mb +0.00%  | 13.412μs -2.60%  | ±0.70% -59.50%  |
| RowsBench         | bench_take_right_1k_on_10k | 10   | 3   | 95.267mb +0.00%  | 15.566μs -5.66%  | ±2.73% -23.21%  |
| RowsBench         | bench_unique_on_1k         | 2    | 3   | 114.296mb +0.00% | 186.626ms +0.64% | ±0.52% -46.48%  |
| TypeDetectorBench | bench_type_detector        | 1    | 3   | 43.804mb +0.00%  | 361.525ms -0.18% | ±0.12% -31.95%  |
| TypeDetectorBench | bench_type_detector        | 1    | 3   | 11.613mb +0.00%  | 72.899ms +0.39%  | ±0.16% -78.68%  |
+-------------------+----------------------------+------+-----+------------------+------------------+-----------------+

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.04%. Comparing base (7de3d8c) to head (f53e122).
Report is 4 commits behind head on 1.x.

Additional details and impacted files

@@            Coverage Diff             @@
##              1.x    #1465      +/-   ##
==========================================
- Coverage   83.05%   83.04%   -0.01%     
==========================================
  Files         663      663              
  Lines       17853    17853              
==========================================
- Hits        14827    14826       -1     
- Misses       3026     3027       +1     

Components	Coverage Δ
etl	85.77% <ø> (ø)
cli	86.73% <ø> (ø)
lib-array-dot	94.53% <ø> (ø)
lib-azure-sdk	62.56% <ø> (ø)
lib-doctrine-dbal-bulk	97.36% <ø> (ø)
lib-filesystem	76.75% <ø> (ø)
lib-parquet	84.33% <ø> (ø)
lib-parquet-viewer	82.02% <ø> (ø)
lib-rdsl	87.09% <ø> (ø)
lib-snappy	90.69% <ø> (-0.47%)	⬇️
bridge-filesystem-async-aws	90.38% <ø> (ø)
bridge-filesystem-azure	89.92% <ø> (ø)
bridge-monolog-http	96.38% <ø> (ø)
symfony-http-foundation	77.10% <ø> (ø)
adapter-chartjs	86.45% <ø> (ø)
adapter-csv	89.57% <ø> (ø)
adapter-doctrine	88.68% <ø> (ø)
adapter-elasticsearch	97.19% <ø> (ø)
adapter-google-sheet	78.04% <ø> (ø)
adapter-http	59.15% <ø> (ø)
adapter-json	90.90% <ø> (ø)
adapter-logger	53.84% <ø> (ø)
adapter-meilisearch	97.75% <ø> (ø)
adapter-parquet	80.85% <ø> (ø)
adapter-text	84.44% <ø> (ø)
adapter-xml	83.15% <ø> (ø)