Improved remote filesystem code samples (#1295)

Author: norberttech

documentation/_navigation.md

@@ -53,4 +53,5 @@
 ## Bridges
 - [Filesystem Azure](/documentation/components/bridges/filesystem-azure-bridge.md)
 - [Filesystem Async AWS](/documentation/components/bridges/filesystem-async-aws-bridge.md)
+- [Symfony Http Foundation](/documentation/components/bridges/symfony-http-foundation-bridge.md)
 - [Monolog Http](/documentation/components/bridges/monolog-http-bridge.md) 

documentation/components/bridges/filesystem-async-aws-bridge.md

@@ -22,4 +22,28 @@ $aws = aws_s3_filesystem(
 );
 
 $fstab = fstab($aws);
+```
+
+## Usage with Flow
+
+To use the AWS S3 filesystem with Flow, you need to mount the filesystem to the configuration.
+This operation will mount the S3 filesystem to fstab instance available in the DataFrame runtime.
+
+```php
+$config = config_builder()
+    ->mount(
+        aws_s3_filesystem(
+            $_ENV['AWS_S3_BUCKET'],
+            aws_s3_client([
+                'region' => $_ENV['AWS_S3_REGION'],
+                'accessKeyId' => $_ENV['AWS_S3_KEY'],
+                'accessKeySecret' => $_ENV['AWS_S3_SECRET'],
+            ])
+        )
+    );
+    
+data_frame($config)
+    ->read(from_csv(path('aws-s3://test.csv')))
+    ->write(to_stream(__DIR__ . '/output.txt', truncate: false))
+    ->run();    
 ```

documentation/components/bridges/filesystem-azure-bridge.md

@@ -40,4 +40,32 @@ $sdk = azure_blob_service(
     azure_shared_key_authorization_factory($config, $accountKey),
     $logger
 );
+```
+
+## Usage with Flow
+
+To use the Azure Blob filesystem with Flow, you need to mount the filesystem to the configuration.
+This operation will mount the Azure Blob filesystem to fstab instance available in the DataFrame runtime.
+
+```php
+$config = config_builder()
+    ->mount(
+        azure_filesystem(
+            azure_blob_service(
+                azure_blob_service_config(
+                    $_ENV['AZURE_ACCOUNT'],
+                    $_ENV['AZURE_CONTAINER']
+                ),
+                azure_shared_key_authorization_factory(
+                    $_ENV['AZURE_ACCOUNT'],
+                    $_ENV['AZURE_ACCOUNT_KEY']
+                ),
+            )
+        )
+    );
+    
+data_frame($config)
+    ->read(from_csv(path('azure-blob://test.csv')))
+    ->write(to_stream(__DIR__ . '/output.txt', truncate: false))
+    ->run();    
 ```

examples/topics/data_reading/http_dynamic/output.txt

@@ -1,6 +1,6 @@
 +----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
 |     name |                    html_url |                blog |    login | public_repos | followers |           created_at |
 +----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
-| Flow PHP | https://github.com/flow-php | http://flow-php.com | flow-php |           36 |       106 | 2020-10-26T18:40:27Z |
+| Flow PHP | https://github.com/flow-php | http://flow-php.com | flow-php |           37 |       106 | 2020-10-26T18:40:27Z |
 +----------+-----------------------------+---------------------+----------+--------------+-----------+----------------------+
 1 rows

examples/topics/filesystem/azure/code.php

@@ -3,8 +3,8 @@
 declare(strict_types=1);
 
 use function Flow\Azure\SDK\DSL\{azure_blob_service, azure_blob_service_config, azure_shared_key_authorization_factory};
-use function Flow\ETL\Adapter\CSV\to_csv;
-use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite};
+use function Flow\ETL\Adapter\CSV\{from_csv, to_csv};
+use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite, to_stream};
 use function Flow\Filesystem\Bridge\Azure\DSL\azure_filesystem;
 use function Flow\Filesystem\DSL\path;
 use Symfony\Component\Dotenv\Dotenv;
@@ -46,3 +46,8 @@
     ->saveMode(overwrite())
     ->write(to_csv(path('azure-blob://test.csv')))
     ->run();
+
+data_frame($config)
+    ->read(from_csv(path('azure-blob://test.csv')))
+    ->write(to_stream(__DIR__ . '/output.txt', truncate: false))
+    ->run();

examples/topics/filesystem/azure/output.txt

@@ -0,0 +1,24 @@
++----+------+
+| id | name |
++----+------+
+|  1 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  2 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  3 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  4 | test |
++----+------+
+1 rows

examples/topics/filesystem/s3/code.php

@@ -2,8 +2,8 @@
 
 declare(strict_types=1);
 
-use function Flow\ETL\Adapter\CSV\to_csv;
-use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite};
+use function Flow\ETL\Adapter\CSV\{from_csv, to_csv};
+use function Flow\ETL\DSL\{config_builder, data_frame, from_array, overwrite, to_stream};
 use function Flow\Filesystem\Bridge\AsyncAWS\DSL\{aws_s3_client, aws_s3_filesystem};
 use function Flow\Filesystem\DSL\path;
 use Symfony\Component\Dotenv\Dotenv;
@@ -41,3 +41,8 @@
     ->saveMode(overwrite())
     ->write(to_csv(path('aws-s3://test.csv')))
     ->run();
+
+data_frame($config)
+    ->read(from_csv(path('aws-s3://test.csv')))
+    ->write(to_stream(__DIR__ . '/output.txt', truncate: false))
+    ->run();

examples/topics/filesystem/s3/description.md

@@ -0,0 +1,24 @@
++----+------+
+| id | name |
++----+------+
+|  1 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  2 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  3 | test |
++----+------+
+1 rows
++----+------+
+| id | name |
++----+------+
+|  4 | test |
++----+------+
+1 rows

examples/topics/filesystem/s3/output.txt

@@ -3,5 +3,4 @@ write straight to stdout of the process.
 
 `Stdout is a write-only filesystem. It is not possible to read from it.`
 
-Its main purpose is to allow to allow web servers to stream 
-data to the client without buffering it in memory.
+Its main purpose is to allow web servers to stream data to the client without buffering it in memory.