Skip to content

Commit c443a93

Browse files
author
flow-php
committed
1 parent 003dd3b commit c443a93

File tree

10 files changed

+42
-37
lines changed

10 files changed

+42
-37
lines changed

changelog/index.html

Lines changed: 25 additions & 20 deletions
Large diffs are not rendered by default.

data_reading/database/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ <h2 class="text-xl mt-5">Description</h2>
345345
$connection,
346346
'orders',
347347
new OrderBy('created_at', Order::DESC),
348-
)
348+
);
349349
// read from a query using limit/offset pagination
350350
from_dbal_limit_offset_qb(
351351
$connection,
@@ -366,7 +366,7 @@ <h2 class="text-xl mt-5">Description</h2>
366366
)
367367
);
368368
</code></pre>
369-
<p>Additionally, each of them allows setting dataset schema through <code>$extractor-&gt;withSchema(Schema $schema)</code> method.</p>
369+
<p>Additionally, each of them allows setting a dataset schema through <code>$extractor-&gt;withSchema(Schema $schema)</code> method.</p>
370370

371371
</article>
372372

documentation/components/core/core/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ <h1><a id="flow-php-data-frame" href="#content-data-frame" class="mr-2" aria-hid
396396
<p>Unlike loading an entire dataset at once, a Data Frame processes information in smaller, manageable chunks.<br />
397397
As it moves through the data, it only keeps a limited number of rows in memory at any given time.<br />
398398
This approach helps avoid running out of memory, making it efficient and scalable for handling large datasets.</p>
399-
<p>Simple example of reading from php array and writing to stdout.</p>
399+
<p>Simple example of reading from php a array and writing to stdout.</p>
400400
<pre class="language-php"><code class="language-php" data-controller="syntax-highlight">&lt;?php
401401

402402
data_frame()

documentation/example/data_reading/database/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ <h2 class="text-xl mt-5 mb-5" id="description">Description</h2>
388388
$connection,
389389
'orders',
390390
new OrderBy('created_at', Order::DESC),
391-
)
391+
);
392392
// read from a query using limit/offset pagination
393393
from_dbal_limit_offset_qb(
394394
$connection,
@@ -409,7 +409,7 @@ <h2 class="text-xl mt-5 mb-5" id="description">Description</h2>
409409
)
410410
);
411411
</code></pre>
412-
<p>Additionally, each of them allows setting dataset schema through <code>$extractor-&gt;withSchema(Schema $schema)</code> method.</p>
412+
<p>Additionally, each of them allows setting a dataset schema through <code>$extractor-&gt;withSchema(Schema $schema)</code> method.</p>
413413

414414
</article>
415415

documentation/quick-start/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -422,15 +422,15 @@ <h2><a id="flow-php-data-frame" href="#content-data-frame" class="mr-2" aria-hid
422422
<p>[!TIP]
423423
To maximize developer experience, Flow exposes a DSL (Domain Specific Language).
424424
Flow DSL is a set of functions that can be used to build a data processing pipeline.
425-
Entire project is written in Object-Oriented style, but DSL is a more convenient way to build a pipeline.
425+
The entire project is written in Object-Oriented style, but DSL is a more convenient way to build a pipeline.
426426
Whenever possible, use DSL functions instead of creating objects directly.</p>
427427
</blockquote>
428428
<p>It creates a new instance of the <code>Flow\ETL\Flow</code> class, which is the main class of the ETL.</p>
429429
<p><a href="/data_frame/#example">Data Frame Examples</a></p>
430430
<h2><a id="flow-php-extraction---reading" href="#content-extraction---reading" class="mr-2" aria-hidden="true" title="Permalink">#</a>Extraction - Reading</h2>
431431
<p>The first step in creating a data processing pipeline is to read the data from a data source.
432432
Extractors are responsible for reading data from a data source and converting it into a format that can be processed by Flow ETL.
433-
All extractors return \Generator and by design will throw rows one by one, this is to ensure that memory consumption is constant and low.</p>
433+
All extractors return \Generator and by design will return rows one by one - this is to ensure that memory consumption is constant and low.</p>
434434
<pre class="language-php"><code class="language-php" data-controller="syntax-highlight">data_frame()
435435
-&gt;read(from_csv(__DIR__ . '/orders_flow.csv'))
436436
</code></pre>
@@ -456,7 +456,7 @@ <h2><a id="flow-php-transformation" href="#content-transformation" class="mr-2"
456456
<li><code>...-&gt;cast('date')</code> - casts column to a date type.</li>
457457
<li><code>...-&gt;dateFormat('Y/m')</code> - format date using the <code>Y/m</code> format, as a result created_at becomes a string <code>2023/01</code>.</li>
458458
</ul>
459-
<p>You can find all available functions in the <a href="../src/core/etl/src/Flow/ETL/DSL/functions.php">DSL</a>.</p>
459+
<p>You can find all available functions in the <a target="_blank" href="https://github.com/flow-php/flow/blob/1.x/src/core/etl/src/Flow/ETL/DSL/functions.php">DSL</a>.</p>
460460
<blockquote>
461461
<p>[!TIP]
462462
DSL is nothing more than a set of functions that return instances of Flow PHP objects.
@@ -479,22 +479,22 @@ <h2><a id="flow-php-loading---writing" href="#content-loading---writing" class="
479479
<p>Second write is writing the data to a CSV file, we're using the <code>mode()</code> function to set the save mode to <code>overwrite</code>.
480480
There are three save modes available:</p>
481481
<ul>
482-
<li><code>SaveMode::Append</code> - If data sink already exists, data will be appended. This solution might cause data duplication since it's not check if given rows already existed.</li>
483-
<li><code>SaveMode::ExceptionIfExists</code> - If data sink already exists error will be thrown.</li>
482+
<li><code>SaveMode::Append</code> - If data sink already exists, data will be appended. This solution might cause data duplication since it does not check if the given rows already exist.</li>
483+
<li><code>SaveMode::ExceptionIfExists</code> - If data sink already exists an error will be thrown.</li>
484484
<li><code>SaveMode::Ignore</code> - If data sink already exists, writing will be skipped.</li>
485485
<li><code>SaveMode::Overwrite</code> - If data sink already exists, it will be removed and written again.</li>
486486
</ul>
487487
<blockquote>
488488
<p>[!NOTE]
489489
Append mode is not really appending anything to existing files, instead it creates a folder in which it stores outputs under randomized file names.
490-
It can be later read using glob-pattern, for example <code>from_csv('/path/to/folder/*.csv')</code>.</p>
490+
It can be later read using a glob-pattern, for example <code>from_csv('/path/to/folder/*.csv')</code>.</p>
491491
</blockquote>
492492
<p><a href="/data_writing/#example">Loaders Examples</a></p>
493493
<h2><a id="flow-php-lazy-execution" href="#content-lazy-execution" class="mr-2" aria-hidden="true" title="Permalink">#</a>Lazy Execution</h2>
494494
<p>Flow ETL is using lazy execution, which means that the pipeline will not be executed until you call the <code>run()</code> function.</p>
495495
<pre class="language-php"><code class="language-php" data-controller="syntax-highlight"> -&gt;run();
496496
</code></pre>
497-
<p>There are few more triggering functions, like <code>fetch()</code>, you can find which functions are <code>@lazy</code> or <code>@trigger</code> looking at
497+
<p>There are few more triggering functions, like <code>fetch()</code>. You can find which functions are <code>@lazy</code> or <code>@trigger</code> by looking at
498498
the <a target="_blank" href="https://github.com/flow-php/flow/blob/1.x/src/core/etl/src/Flow/ETL/DataFrame.php">DataFrame</a> source code.</p>
499499

500500

sitemap.blog.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" ><url><loc>https://flow-php.com/blog/2025-01-25/data-processing-in-php</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod><changefreq>weekly</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/blog/2024-08-08/scalar-functions</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod><changefreq>weekly</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/blog/2024-04-04/building-custom-extractor-google-analytics</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod><changefreq>weekly</changefreq><priority>1.0</priority></url></urlset>
1+
<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" ><url><loc>https://flow-php.com/blog/2025-01-25/data-processing-in-php</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod><changefreq>weekly</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/blog/2024-08-08/scalar-functions</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod><changefreq>weekly</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/blog/2024-04-04/building-custom-extractor-google-analytics</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod><changefreq>weekly</changefreq><priority>1.0</priority></url></urlset>

sitemap.default.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" ><url><loc>https://flow-php.com/blog</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/documentation</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/changelog</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url></urlset>
1+
<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" ><url><loc>https://flow-php.com/blog</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/documentation</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/changelog</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url><url><loc>https://flow-php.com/</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod><changefreq>daily</changefreq><priority>1.0</priority></url></urlset>

sitemap.documentation.xml

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

sitemap.examples.xml

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

sitemap.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<?xml version="1.0" encoding="UTF-8"?><sitemapindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>https://flow-php.com/sitemap.default.xml</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod></sitemap><sitemap><loc>https://flow-php.com/sitemap.examples.xml</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod></sitemap><sitemap><loc>https://flow-php.com/sitemap.blog.xml</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod></sitemap><sitemap><loc>https://flow-php.com/sitemap.documentation.xml</loc><lastmod>2025-03-10T11:06:25+00:00</lastmod></sitemap></sitemapindex>
1+
<?xml version="1.0" encoding="UTF-8"?><sitemapindex xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/siteindex.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><sitemap><loc>https://flow-php.com/sitemap.default.xml</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod></sitemap><sitemap><loc>https://flow-php.com/sitemap.examples.xml</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod></sitemap><sitemap><loc>https://flow-php.com/sitemap.blog.xml</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod></sitemap><sitemap><loc>https://flow-php.com/sitemap.documentation.xml</loc><lastmod>2025-03-14T09:43:14+00:00</lastmod></sitemap></sitemapindex>

0 commit comments

Comments
 (0)