blobfs

Documentation

Overview

Package blobfs provides an interface to blob stores such as Google Cloud Storage, Azure Blob Storage, or AWS S3, allowing you to interact with the store as a standard filesystem.

This filesystem's behaviour complies with fstest.TestFS.

Usage

To use this filesystem, call New with a base URL. All reads from the filesystem are relative to this base URL. The schemes "s3", "gs", and "azblob" are supported.

Index

• Variables
• func New(u *url.URL) (fs.FS, error)
• func V2ConfigFromURLParams(ctx context.Context, q url.Values) (awsv2.Config, error)

Variables

var FS = fsimpl.FSProviderFunc(New, s3blob.Scheme, gcsblob.Scheme, azureblob.Scheme)

FS is used to register this filesystem with an fsimpl.FSMux

Functions

func New

func New(u *url.URL) (fs.FS, error)

New provides a filesystem (an fs.FS) backed by an blob storage bucket, rooted at the given URL.

A context can be given by using WithContextFS.

func V2ConfigFromURLParams

func V2ConfigFromURLParams(ctx context.Context, q url.Values) (awsv2.Config, error)

V2ConfigFromURLParams returns an aws.Config for AWS SDK v2 initialized based on the URL parameters in q. It is intended to be used by URLOpeners for AWS services if UseV2 returns true.

https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/aws#Config

It returns an error if q contains any unknown query parameters; callers should remove any query parameters they know about from q before calling V2ConfigFromURLParams.

The following query options are supported:

• region: The AWS region for requests; sets WithRegion.
• profile: The shared config profile to use; sets SharedConfigProfile.
• endpoint: The AWS service endpoint to send HTTP request.
• hostname_immutable: Make the hostname immutable, only works if endpoint is also set.
• dualstack: A value of "true" enables dual stack (IPv4 and IPv6) endpoints.
• fips: A value of "true" enables the use of FIPS endpoints.
• rate_limiter_capacity: A integer value configures the capacity of a token bucket used in client-side rate limits. If no value is set, the client-side rate limiting is disabled. See https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/retries-timeouts/#client-side-rate-limiting.