Browse documentation

#Filesystem Azure Bridge

The Filesystem Azure Bridge is a bridge that allows you to use the Azure Blob Storage as a filesystem in your application.

#Installation

For detailed installation instructions, see the installation page.

#Usage

[!NOTE]
Since the Azure SDK is not providing any http client or factories, you need to install them manually. The following example uses the php-http/discovery package to find the factories in your project existing dependencies. Use below links to find the implementations for client and the factories:

• Http Client
• Http Factories

<?php

use Http\Discovery\Psr17FactoryDiscovery;
use Http\Discovery\Psr18ClientDiscovery;
use function Flow\Azure\SDK\DSL\azure_blob_service;
use function Flow\Azure\SDK\DSL\azure_blob_service_config;
use function Flow\Azure\SDK\DSL\azure_http_factory;
use function Flow\Azure\SDK\DSL\azure_shared_key_authorization_factory;
use function Flow\Azure\SDK\DSL\azure_url_factory;

$sdk = azure_blob_service(
    $config = azure_blob_service_config($account, $container),
    Psr18ClientDiscovery::find(),
    azure_http_factory(Psr17FactoryDiscovery::findRequestFactory(), Psr17FactoryDiscovery::findStreamFactory()),
    azure_url_factory(),
    azure_shared_key_authorization_factory($config, $accountKey),
    $logger
);

#Usage with Flow

To use the Azure Blob filesystem with Flow, pass it to the source or sink that reads or writes the azure-blob:// path. Hold one instance and pass the same one to both sides.

The mount protocol - the URI scheme the filesystem serves - defaults to 'azure-blob'. Override via the third argument (azure_filesystem($blobService, $options, protocol: 'warehouse')) when the paths you read and write use a different scheme.

$azure = 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()
    ->read(from_csv(path('azure-blob://test.csv'), filesystem: $azure))
    ->write(to_parquet(path('azure-blob://test.parquet'), filesystem: $azure))
    ->run();

A source or sink given a filesystem that does not serve its path throws at construction, naming the filesystem: argument.

FileStatus values returned from list() and status() carry size (from the Content-Length header / listing property) and lastModifiedAt (from the Last-Modified header, parsed as RFC 7231) populated directly from the Azure response - no extra stream is opened when the CLI flow:filesystem:ls --long or flow:filesystem:stat prints them.

Found a typo or an outdated section? Edit this page on GitHub ↗