ManagedCode.Storage.Core 2.1.15-alpha

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of ManagedCode.Storage.Core.
dotnet add package ManagedCode.Storage.Core --version 2.1.15-alpha
NuGet\Install-Package ManagedCode.Storage.Core -Version 2.1.15-alpha
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ManagedCode.Storage.Core" Version="2.1.15-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ManagedCode.Storage.Core --version 2.1.15-alpha
#r "nuget: ManagedCode.Storage.Core, 2.1.15-alpha"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ManagedCode.Storage.Core as a Cake Addin
#addin nuget:?package=ManagedCode.Storage.Core&version=2.1.15-alpha&prerelease

// Install ManagedCode.Storage.Core as a Cake Tool
#tool nuget:?package=ManagedCode.Storage.Core&version=2.1.15-alpha&prerelease

img|300x200

ManagedCode.Storage

.NET Coverage Status nuget CodeQL

Version Package Description
NuGet Package ManagedCode.Storage.Core Core
NuGet Package ManagedCode.Storage.FileSystem FileSystem
NuGet Package ManagedCode.Storage.Azure Azure
NuGet Package ManagedCode.Storage.Aws AWS
NuGet Package ManagedCode.Storage.Gcp GCP
NuGet Package ManagedCode.Storage.AspNetExtensions AspNetExtensions

Storage


General concept

One of the key benefits of using a universal wrapper for cloud blob storages is that it provides a consistent, easy-to-use interface for working with different types of blob storage. This can make it much easier for developers to switch between different storage providers, or to use multiple providers in the same project.

A universal wrapper can also simplify the development process by providing a single set of methods for working with blob storage, rather than requiring developers to learn and use the different APIs provided by each storage provider. This can save time and reduce the complexity of the code, making it easier to write, maintain, and debug.

In addition, a universal wrapper can provide additional functionality that is not available through the individual storage providers, such as support for common patterns like asynchronous programming and error handling. This can make it easier to write high-quality, reliable code that is robust and resilient to errors.

Overall, using a universal wrapper for cloud blob storages can provide many benefits, including improved flexibility, simplicity, and reliability in your application. A universal storage for working with multiple storage providers:

  • Azure
  • Google Cloud
  • Amazon
  • FileSystem

Motivation

Cloud storage is a popular and convenient way to store and access data in the cloud. However, different cloud storage providers often have their own unique APIs and interfaces for accessing and manipulating data. This can make it difficult to switch between different providers or to use multiple providers simultaneously.

Our library, provides a universal interface for accessing and manipulating data in different cloud blob storage providers. This makes it easy to switch between providers or to use multiple providers at the same time, without having to learn and use multiple APIs.

Features

  • Provides a universal interface for accessing and manipulating data in different cloud blob storage providers.
  • Makes it easy to switch between providers or to use multiple providers simultaneously.
  • Supports common operations such as uploading, downloading, and deleting data.

Connection modes

You can connect storage interface in two modes provider-specific and default. In case of default you are restricted with one storage type

Azure

Default mode connection:

// Startup.cs
services.AddAzureStorageAsDefault(new AzureStorageOptions
{
    Container = "{YOUR_CONTAINER_NAME}",
    ConnectionString = "{YOUR_CONNECTION_NAME}",
});

Using in default mode:

// MyService.cs
public class MyService
{
    private readonly IStorage _storage;

    public MyService(IStorage storage)
    {
        _storage = storage;
    }
}

Provider-specific mode connection:

// Startup.cs
services.AddAzureStorage(new AzureStorageOptions
{
    Container = "{YOUR_CONTAINER_NAME}",
    ConnectionString = "{YOUR_CONNECTION_NAME}",
});

Using in provider-specific mode

// MyService.cs
public class MyService
{
    private readonly IAzureStorage _azureStorage;

    public MyService(IAzureStorage azureStorage)
    {
        _azureStorage = azureStorage;
    }
}

<details> <summary>Google Cloud (Click here to expand)</summary>

Google Cloud

Default mode connection:

// Startup.cs
services.AddGCPStorageAsDefault(opt =>
{
    opt.GoogleCredential = GoogleCredential.FromFile("{PATH_TO_YOUR_CREDENTIALS_FILE}.json");

    opt.BucketOptions = new BucketOptions()
    {
        ProjectId = "{YOUR_API_PROJECT_ID}",
        Bucket = "{YOUR_BUCKET_NAME}",
    };
});

Using in default mode:

// MyService.cs
public class MyService
{
    private readonly IStorage _storage;
  
    public MyService(IStorage storage)
    {
        _storage = storage;
    }
}

Provider-specific mode connection:

// Startup.cs
services.AddGCPStorage(new GCPStorageOptions
{
    BucketOptions = new BucketOptions()
    {
        ProjectId = "{YOUR_API_PROJECT_ID}",
        Bucket = "{YOUR_BUCKET_NAME}",
    }
});

Using in provider-specific mode

// MyService.cs
public class MyService
{
    private readonly IGCPStorage _gcpStorage;
    public MyService(IGCPStorage gcpStorage)
    {
        _gcpStorage = gcpStorage;
    }
}

</details>

<details> <summary>Amazon (Click here to expand)</summary>

Amazon

Default mode connection:

// Startup.cs
//aws libarary overwrites property values. you should only create configurations this way. 
var awsConfig = new AmazonS3Config();
awsConfig.RegionEndpoint = RegionEndpoint.EUWest1;
awsConfig.ForcePathStyle = true;
awsConfig.UseHttp = true;
awsConfig.ServiceURL = "http://localhost:4566"; //this is the default port for the aws s3 emulator, must be last in the list

services.AddAWSStorageAsDefault(opt =>
{
    opt.PublicKey = "{YOUR_PUBLIC_KEY}";
    opt.SecretKey = "{YOUR_SECRET_KEY}";
    opt.Bucket = "{YOUR_BUCKET_NAME}";
    opt.OriginalOptions = awsConfig;
});

Using in default mode:

// MyService.cs
public class MyService
{
    private readonly IStorage _storage;
  
    public MyService(IStorage storage)
    {
        _storage = storage;
    }
}

Provider-specific mode connection:

// Startup.cs
services.AddAWSStorage(new AWSStorageOptions
{
    PublicKey = "{YOUR_PUBLIC_KEY}",
    SecretKey = "{YOUR_SECRET_KEY}",
    Bucket = "{YOUR_BUCKET_NAME}",
    OriginalOptions = awsConfig
});

Using in provider-specific mode

// MyService.cs
public class MyService
{
    private readonly IAWSStorage _gcpStorage;
    public MyService(IAWSStorage gcpStorage)
    {
        _gcpStorage = gcpStorage;
    }
}

</details>

<details> <summary>FileSystem (Click here to expand)</summary>

FileSystem

Default mode connection:

// Startup.cs
services.AddFileSystemStorageAsDefault(opt =>
{
    opt.BaseFolder = Path.Combine(Environment.CurrentDirectory, "{YOUR_BUCKET_NAME}");
});

Using in default mode:

// MyService.cs
public class MyService
{
    private readonly IStorage _storage;
  
    public MyService(IStorage storage)
    {
        _storage = storage;
    }
}

Provider-specific mode connection:

// Startup.cs
services.AddFileSystemStorage(new FileSystemStorageOptions
{
    BaseFolder = Path.Combine(Environment.CurrentDirectory, "{YOUR_BUCKET_NAME}"),
});

Using in provider-specific mode

// MyService.cs
public class MyService
{
    private readonly IFileSystemStorage _fileSystemStorage;
    public MyService(IFileSystemStorage fileSystemStorage)
    {
        _fileSystemStorage = fileSystemStorage;
    }
}

</details>

How to use

We assume that below code snippets are placed in your service class with injected IStorage:

public class MyService
{
    private readonly IStorage _storage;
    public MyService(IStorage storage)
    {
        _storage = storage;
    }
}

Upload

await _storage.UploadAsync(new Stream());
await _storage.UploadAsync("some string content");
await _storage.UploadAsync(new FileInfo("D:\\my_report.txt"));

Delete

await _storage.DeleteAsync("my_report.txt");

Download

var localFile = await _storage.DownloadAsync("my_report.txt");

Get metadata

await _storage.GetBlobMetadataAsync("my_report.txt");

Native client

If you need more flexibility, you can use native client for any IStorage<T>

_storage.StorageClient

Conclusion

In summary, Storage library provides a universal interface for accessing and manipulating data in different cloud blob storage providers. It makes it easy to switch between providers or to use multiple providers simultaneously, without having to learn and use multiple APIs. We hope you find it useful in your own projects!

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on ManagedCode.Storage.Core:

Package Downloads
ManagedCode.Storage.Azure The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Storage for Azure

ManagedCode.Storage.AspNetExtensions The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Extensions for ASP.NET for Storage

ManagedCode.Storage.Aws The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Storage for AWS

ManagedCode.Storage.FileSystem The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Storage for FileSystem

ManagedCode.Storage.Gcp The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Storage for GCP

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.15-alpha 487 5/22/2023
2.1.14 3,715 5/21/2023
2.1.13 5,077 12/20/2022
2.1.11 2,186 10/18/2022
2.1.10 1,123 10/18/2022
2.1.9 1,092 10/18/2022
2.1.8 1,110 10/18/2022
2.1.7 1,100 10/18/2022
2.1.6 1,122 10/18/2022
2.1.5 1,093 10/17/2022
2.1.4 1,137 10/17/2022
2.1.3 1,131 10/17/2022
2.1.2 1,119 10/16/2022
2.1.1 1,142 10/16/2022
2.1.0 1,153 10/14/2022
2.0.18 1,909 10/14/2022
2.0.11 5,150 8/12/2022
2.0.10 1,791 8/12/2022
2.0.9 1,773 8/11/2022
2.0.8 1,853 8/10/2022
2.0.7 1,749 8/9/2022
2.0.6 1,727 8/9/2022
2.0.5 1,802 8/8/2022
2.0.4 1,811 7/27/2022
2.0.3 1,788 7/26/2022
2.0.2 1,787 7/25/2022
2.0.1 1,882 7/22/2022
2.0.0 1,782 7/22/2022
1.2.1 1,852 7/17/2022
1.2.0 4,837 4/19/2022
1.1.2 1,561 4/18/2022
1.1.1 2,049 4/7/2022
1.1.0 1,688 3/29/2022
1.0.0 1,626 3/23/2022
0.1.0 1,694 3/22/2022
0.0.1 1,639 3/21/2022