LiteXStorage is simple yet powerful and very high-performance storage mechanism and incorporating both synchronous and asynchronous usage with some advanced usages of cloud storage which can help us to handle storage more easier!
Provide Storage service for ASP.NET Core/.NET applications.
Small library to abstract blob storage functionalities. Quick setup for any storage provider and very simple wrapper for the widely used storage providers. LiteX Storage uses the least common denominator of functionality between the supported providers to build a cross-cloud storage solution. Abstract interface to implement any kind of basic blob storage services. Having a default/generic implementation to wrap the Azure, Amazon AWS S3, Google Cloud, FileSystem (Local), Kvpbase storage. A cross-cloud storage abstraction.
Very simple configuration in advanced ways. Purpose of this package is to bring a new level of ease to the developers who deal with different storage provider integration with their system and implements many advanced features. You can also write your own and extend it also extend existing providers. Easily migrate or switch between one to another provider with no code breaking changes.
It provides possibility to upload files, upload the content of a folder inclusively subfolders, enumerate buckets/container, enumerate the content of a specific 'subfolder', delete buckets/container and delete files from specific subfolders.
LiteXStorage is an interface to unify the programming model for various storage providers. The Core library contains all base interfaces and tools. One should install at least one other LiteXStorage package to get storage handle implementation.
- AmazonS3
- Azure
- Google Cloud
- FileSystem
- Kvpbase - deprecated
- Old Docs - Version 6.x.x and before
- Refer example code for more details
- Multiple provider support (using provider factory)
- Create container or bucket
- Get Shared Access Signature (SAS) URL
- Upload Blobb file
- Get Blob metadata
- Set Blob metadata
- Get all containers/buckets
- Delete all containers/buckets
- Delete directory/folder from container/bucket
- Get Container/Bucket size in bytes
- Get number to total items/files in Container/Bucket
- Async compatible
- Thread safe, concurrency ready
- Obsolete sync methods
- Interface based API to support the test driven development and dependency injection
- Leverages a provider model on top of ILiteXBlobService under the hood and can be extended with your own implementation
Choose one kinds of sms provider type that you needs and install it via Nuget. To install LiteXSms, run the following command in the Package Manager Console
PM> Install-Package LiteX.Storage.Azure
PM> Install-Package LiteX.Storage.Amazon
PM> Install-Package LiteX.Storage.Google
PM> Install-Package LiteX.Storage.Local
PM> Install-Package LiteX.Storage.KvpbaseDifferent types of storage provider have their own way to config. Here are samples that show you how to config.
{
//LiteX Azure Storage settings
"AzureBlobStorageConfig": {
"AzureBlobStorageConnectionString": "--- REPLACE WITH YOUR AZURE CONNECTION STRING ---",
"AzureBlobStorageContainerName": "--- REPLACE WITH YOUR AZURE CONTAINER NAME ---",
"AzureBlobStorageEndPoint": "--- REPLACE WITH YOUR AZURE END POINT ---",
"EnableLogging": true
},
//LiteX Amazon S3 settings
"AmazonS3Config": {
"AmazonAwsAccessKeyId": "--- REPLACE WITH YOUR AMAZON ACCESS KEY ID ---",
"AmazonAwsSecretAccessKey": "--- REPLACE WITH YOUR AMAZON SECRET ACCESS KEY ---",
"AmazonRegion": "--- REPLACE WITH YOUR AMAZON REGION ---",
"AmazonBucketName": "--- REPLACE WITH YOUR AZURE AMAZON BUCKET NAME ---",
"EnableLogging": true
},
//LiteX Google Storage settings
"GoogleCloudStorageConfig": {
"GoogleProjectId": "--- REPLACE WITH YOUR GOOGLE PROJECT ID ---",
"GoogleJsonAuthPath": "--- REPLACE WITH YOUR GOOGLE JSON AUTH PATH ---",
"GoogleBucketName": "--- REPLACE WITH YOUR GOOGLE BUCKET NAME ---",
"EnableLogging": true
},
//LiteX Kvpbase Storage settings
"KvpbaseStorageConfig": {
"KvpbaseApiKey": "--- REPLACE WITH YOUR KVPBASE API KEY ---",
"KvpbaseContainer": "--- REPLACE WITH YOUR KVPBASE CONTAINER ---",
"KvpbaseEndpoint": "--- REPLACE WITH YOUR KVPBASE END POINT ---",
"KvpbaseUserGuid": "--- REPLACE WITH YOUR KVPBASE USERGUID ---",
"EnableLogging": true
},
//LiteX Local File System Storage settings
"FileSystemStorageConfig": {
"Directory": "--- REPLACE WITH YOUR LOCAL FILE SYSTEM DIRECTORY ---",
"EnableLogging": true
}
}public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
#region LiteX Storage
#region LiteX Storage (Register more than one providers)
// Register provider using factory (AmazonS3)
// 1. Use default configuration from appsettings.json's 'AmazonS3Config'
services.AddLiteXAmazonS3ServiceFactory();
//OR
// 2. Load configuration settings using options.
services.AddLiteXAmazonS3ServiceFactory(option =>
{
option.AmazonAwsSecretAccessKey = "";
option.AmazonAwsAccessKeyId = "";
option.AmazonBucketName = "";
option.AmazonRegion = "";
option.EnableLogging = true;
}, providerName: "amazons3");
//OR
// 3. Load configuration settings on your own.
// (e.g. appsettings, database, hardcoded)
var amazonS3Config = new AmazonS3Config()
{
AmazonAwsSecretAccessKey = "",
AmazonAwsAccessKeyId = "",
AmazonBucketName = "",
AmazonRegion = "",
EnableLogging = true
};
services.AddLiteXAmazonS3ServiceFactory(providerName: "amazons3", config: amazonS3Config);
// TODO: register more providers using factory (same way)
// Register default provider (last registered provider is the default one)
services.AddLiteXAzureBlobStorageService();
#endregion
#region LiteX Storage (Azure)
// 1. Use default configuration from appsettings.json's 'AzureBlobStorageConfig'
services.AddLiteXAzureBlobStorageService();
//OR
// 2. Load configuration settings using options.
services.AddLiteXAzureBlobStorageService(option =>
{
option.AzureBlobStorageConnectionString = "";
option.AzureBlobStorageContainerName = "";
option.AzureBlobStorageEndPoint = "";
option.EnableLogging = true;
});
//OR
// 3. Load configuration settings on your own.
// (e.g. appsettings, database, hardcoded)
var azureBlobStorageConfig = new AzureBlobStorageConfig()
{
AzureBlobStorageConnectionString = "",
AzureBlobStorageContainerName = "",
AzureBlobStorageEndPoint = "",
EnableLogging = true
};
services.AddLiteXAzureBlobStorageService(azureBlobStorageConfig);
#endregion
#region LiteX Storage (Amazon)
// 1. Use default configuration from appsettings.json's 'AmazonS3Config'
services.AddLiteXAmazonS3Service();
//OR
// 2. Load configuration settings using options.
services.AddLiteXAmazonS3Service(option =>
{
option.AmazonAwsSecretAccessKey = "";
option.AmazonAwsAccessKeyId = "";
option.AmazonBucketName = "";
option.AmazonRegion = "";
option.EnableLogging = true;
});
//OR
// 3. Load configuration settings on your own.
// (e.g. appsettings, database, hardcoded)
var amazonS3Config1 = new AmazonS3Config()
{
AmazonAwsSecretAccessKey = "",
AmazonAwsAccessKeyId = "",
AmazonBucketName = "",
AmazonRegion = "",
EnableLogging = true
};
services.AddLiteXAmazonS3Service(amazonS3Config1);
#endregion
#region LiteX Storage (Google)
// 1. Use default configuration from appsettings.json's 'GoogleCloudStorageConfig'
services.AddLiteXGoogleCloudStorageService();
//OR
// 2. Load configuration settings using options.
services.AddLiteXGoogleCloudStorageService(option =>
{
option.GoogleProjectId = "";
option.GoogleJsonAuthPath = "";
option.GoogleBucketName = "";
option.EnableLogging = true;
});
//OR
// 3. Load configuration settings on your own.
// (e.g. appsettings, database, hardcoded)
var googleCloudStorageConfig = new GoogleCloudStorageConfig()
{
GoogleProjectId = "",
GoogleJsonAuthPath = "",
GoogleBucketName = "",
EnableLogging = true
};
services.AddLiteXGoogleCloudStorageService(googleCloudStorageConfig);
#endregion
#region LiteX Storage (FileSystem-Local)
// 1. Use default configuration from appsettings.json's 'FileSystemStorageConfig'
services.AddLiteXFileSystemStorageService();
//OR
// 2. Load configuration settings using options.
services.AddLiteXFileSystemStorageService(option =>
{
option.Directory = "UploadFolder";
option.EnableLogging = true;
});
//OR
// 3. Load configuration settings on your own.
// (e.g. appsettings, database, hardcoded)
var fileSystemStorageConfig = new FileSystemStorageConfig()
{
Directory = "",
EnableLogging = true
};
services.AddLiteXFileSystemStorageService(fileSystemStorageConfig);
#endregion
#region LiteX Storage (Kvpbase)
// 1. Use default configuration from appsettings.json's 'KvpbaseStorageConfig'
services.AddLiteXKvpbaseStorageService();
//OR
// 2. Load configuration settings using options.
services.AddLiteXKvpbaseStorageService(option =>
{
option.KvpbaseApiKey = "";
option.KvpbaseEndpoint = "";
option.KvpbaseContainer = "";
option.KvpbaseUserGuid = "";
option.EnableLogging = true;
});
//OR
// 3. Load configuration settings on your own.
// (e.g. appsettings, database, hardcoded)
var kvpbaseStorageConfig = new KvpbaseStorageConfig()
{
KvpbaseApiKey = "",
KvpbaseEndpoint = "",
KvpbaseContainer = "",
KvpbaseUserGuid = "",
EnableLogging = true
};
services.AddLiteXKvpbaseStorageService(kvpbaseStorageConfig);
#endregion
#endregion
// add logging (optional)
services.AddLiteXLogging();
}
}/// <summary>
/// Storage (Factory) controller
/// </summary>
[Route("api/[controller]")]
public class StorageFactoryController : Controller
{
#region Fields
// when using single provider
// private readonly ILiteXBlobService _provider;
// when using multiple provider
private readonly ILiteXStorageProviderFactory _factory;
#endregion
#region Ctor
/// <summary>
///
/// </summary>
/// <param name="factory"></param>
// <param name="provider"></param>
public StorageFactoryController(ILiteXStorageProviderFactory factory)
{
_factory = factory;
//_provider = provider;
//_provider = _factory.GetStorageProvider("azure");
}
#endregion
#region Methods
/// <summary>
/// Get the provider from factory with its name
/// </summary>
/// <returns></returns>
[HttpGet]
[Route("demo-usage")]
public async Task<IActionResult> DemoUsage()
{
// get the provider from factory with its name
var provider = _factory.GetStorageProvider("azure");
//var provider = _factory.GetStorageProvider("amazons3");
//var provider = _factory.GetStorageProvider("googlecloudstorage");
//var provider = _factory.GetStorageProvider("filesystem");
//var provider = _factory.GetStorageProvider("Kvpbase");
//var provider = _factory.GetStorageProvider("other");
List<BlobDescriptor> blobs = (await provider.GetBlobsAsync()).ToList();
// sync
//List<BlobDescriptor> blobs = _blobService.GetBlobs().ToList();
return Ok(blobs);
}
/// <summary>
/// Get Storage Provider Type
/// </summary>
/// <param name="storageProviderType">Storage provider type</param>
/// <returns></returns>
[HttpGet]
[Route("get-storage-provider-type")]
public IActionResult GetStorageProviderType(StorageProviderType storageProviderType)
{
switch (storageProviderType)
{
case StorageProviderType.Azure:
var providerAzure = _factory.GetStorageProvider("azure");
return Ok(providerAzure.StorageProviderType.ToString());
case StorageProviderType.Amazon:
var providerAmazons3 = _factory.GetStorageProvider("amazons3");
return Ok(providerAmazons3.StorageProviderType.ToString());
case StorageProviderType.Google:
var providerGCP = _factory.GetStorageProvider("googlecloudstorage");
return Ok(providerGCP.StorageProviderType.ToString());
case StorageProviderType.FileSystem:
var providerFileSystem = _factory.GetStorageProvider("filesystem");
return Ok(providerFileSystem.StorageProviderType.ToString());
case StorageProviderType.Kvpbase:
var providerKvpbase = _factory.GetStorageProvider("Kvpbase");
return Ok(providerKvpbase.StorageProviderType.ToString());
case StorageProviderType.Other:
var providerOther = _factory.GetStorageProvider("other");
return Ok(providerOther.StorageProviderType.ToString());
default:
return BadRequest("Provider not supported");
}
}
/// <summary>
/// Get blob list
/// from default Container/Bucket
/// </summary>
/// <param name="storageProviderType">Storage provider type</param>
/// <returns></returns>
[HttpGet]
[Route("get-blobs")]
public async Task<IActionResult> GetBlobs(StorageProviderType storageProviderType)
{
List<BlobDescriptor> blobs = new List<BlobDescriptor>();
switch (storageProviderType)
{
case StorageProviderType.Azure:
var providerAzure = _factory.GetStorageProvider("azure");
blobs = (await providerAzure.GetBlobsAsync()).ToList();
break;
case StorageProviderType.Amazon:
var providerAmazons3 = _factory.GetStorageProvider("amazons3");
blobs = (await providerAmazons3.GetBlobsAsync()).ToList();
break;
case StorageProviderType.Google:
var providerGCP = _factory.GetStorageProvider("googlecloudstorage");
blobs = (await providerGCP.GetBlobsAsync()).ToList();
break;
case StorageProviderType.FileSystem:
var providerFileSystem = _factory.GetStorageProvider("filesystem");
blobs = (await providerFileSystem.GetBlobsAsync()).ToList();
break;
case StorageProviderType.Kvpbase:
var providerKvpbase = _factory.GetStorageProvider("Kvpbase");
blobs = (await providerKvpbase.GetBlobsAsync()).ToList();
break;
case StorageProviderType.Other:
var providerOther = _factory.GetStorageProvider("other");
blobs = (await providerOther.GetBlobsAsync()).ToList();
break;
default:
return BadRequest("Provider not supported");
}
return Ok(blobs);
}
/// <summary>
/// Get blob list
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="storageProviderType">Storage provider type</param>
/// <returns></returns>
[HttpGet]
[Route("get-blobs/{containerOrBucketName}")]
public async Task<IActionResult> GetBlobs(string containerOrBucketName, StorageProviderType storageProviderType)
{
List<BlobDescriptor> blobs = new List<BlobDescriptor>();
switch (storageProviderType)
{
case StorageProviderType.Azure:
var providerAzure = _factory.GetStorageProvider("azure");
blobs = (await providerAzure.GetBlobsAsync(containerOrBucketName)).ToList();
break;
case StorageProviderType.Amazon:
var providerAmazons3 = _factory.GetStorageProvider("amazons3");
blobs = (await providerAmazons3.GetBlobsAsync(containerOrBucketName)).ToList();
break;
case StorageProviderType.Google:
var providerGCP = _factory.GetStorageProvider("googlecloudstorage");
blobs = (await providerGCP.GetBlobsAsync(containerOrBucketName)).ToList();
break;
case StorageProviderType.FileSystem:
var providerFileSystem = _factory.GetStorageProvider("filesystem");
blobs = (await providerFileSystem.GetBlobsAsync(containerOrBucketName)).ToList();
break;
case StorageProviderType.Kvpbase:
var providerKvpbase = _factory.GetStorageProvider("Kvpbase");
blobs = (await providerKvpbase.GetBlobsAsync(containerOrBucketName)).ToList();
break;
case StorageProviderType.Other:
var providerOther = _factory.GetStorageProvider("other");
blobs = (await providerOther.GetBlobsAsync(containerOrBucketName)).ToList();
break;
default:
return BadRequest("Provider not supported");
}
return Ok(blobs);
}
/// <summary>
/// Create/Replace blob file
/// from default Container/Bucket
/// </summary>
/// <param name="model">Blob file</param>
/// <param name="isPublic">Is Private or Public blob</param>
/// <param name="storageProviderType">Storage provider type</param>
/// <returns></returns>
[HttpPost]
[Route("upload-blob")]
public async Task<IActionResult> UploadBlob(FileModel model, bool isPublic = true, StorageProviderType storageProviderType = StorageProviderType.Azure)
{
string blobName = model.File.FileName;
Stream stream = model.File.OpenReadStream();
string contentType = model.File.ContentType;
BlobProperties properties = new BlobProperties
{
ContentType = contentType,
Security = isPublic ? BlobSecurity.Public : BlobSecurity.Private
};
var isUploaded = false;
switch (storageProviderType)
{
case StorageProviderType.Azure:
var providerAzure = _factory.GetStorageProvider("azure");
isUploaded = await providerAzure.UploadBlobAsync(blobName, stream, properties);
break;
case StorageProviderType.Amazon:
var providerAmazons3 = _factory.GetStorageProvider("amazons3");
isUploaded = await providerAmazons3.UploadBlobAsync(blobName, stream, properties);
break;
case StorageProviderType.Google:
var providerGCP = _factory.GetStorageProvider("googlecloudstorage");
isUploaded = await providerGCP.UploadBlobAsync(blobName, stream, properties);
break;
case StorageProviderType.FileSystem:
var providerFileSystem = _factory.GetStorageProvider("filesystem");
isUploaded = await providerFileSystem.UploadBlobAsync(blobName, stream, properties);
break;
case StorageProviderType.Kvpbase:
var providerKvpbase = _factory.GetStorageProvider("Kvpbase");
isUploaded = await providerKvpbase.UploadBlobAsync(blobName, stream, properties);
break;
case StorageProviderType.Other:
var providerOther = _factory.GetStorageProvider("other");
isUploaded = await providerOther.UploadBlobAsync(blobName, stream, properties);
break;
default:
return BadRequest("Provider not supported");
}
return Ok(isUploaded);
}
/// <summary>
/// Create/Replace blob file
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="model">Blob file</param>
/// <param name="isPublic">Is Private or Public blob</param>
/// <param name="storageProviderType">Storage provider type</param>
/// <returns></returns>
[HttpPost]
[Route("upload-blob/{containerOrBucketName}")]
public async Task<IActionResult> UploadBlob(string containerOrBucketName, FileModel model, bool isPublic = true, StorageProviderType storageProviderType = StorageProviderType.Azure)
{
string blobName = model.File.FileName;
Stream stream = model.File.OpenReadStream();
string contentType = model.File.ContentType;
BlobProperties properties = new BlobProperties
{
ContentType = contentType,
Security = isPublic ? BlobSecurity.Public : BlobSecurity.Private
};
var isUploaded = false;
switch (storageProviderType)
{
case StorageProviderType.Azure:
var providerAzure = _factory.GetStorageProvider("azure");
isUploaded = await providerAzure.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
break;
case StorageProviderType.Amazon:
var providerAmazons3 = _factory.GetStorageProvider("amazons3");
isUploaded = await providerAmazons3.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
break;
case StorageProviderType.Google:
var providerGCP = _factory.GetStorageProvider("googlecloudstorage");
isUploaded = await providerGCP.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
break;
case StorageProviderType.FileSystem:
var providerFileSystem = _factory.GetStorageProvider("filesystem");
isUploaded = await providerFileSystem.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
break;
case StorageProviderType.Kvpbase:
var providerKvpbase = _factory.GetStorageProvider("Kvpbase");
isUploaded = await providerKvpbase.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
break;
case StorageProviderType.Other:
var providerOther = _factory.GetStorageProvider("other");
isUploaded = await providerOther.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
break;
default:
return BadRequest("Provider not supported");
}
return Ok(isUploaded);
}
/// <summary>
/// Get blob url
/// from default Container/Bucket
/// </summary>
/// <param name="blobName">Name of the Blob.</param>
/// <param name="storageProviderType">Storage provider type</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-url/{blobName}")]
public async Task<IActionResult> GetBlobUrl(string blobName, StorageProviderType storageProviderType = StorageProviderType.Azure)
{
string blobUrl = string.Empty;
switch (storageProviderType)
{
case StorageProviderType.Azure:
var providerAzure = _factory.GetStorageProvider("azure");
blobUrl = await providerAzure.GetBlobUrlAsync(blobName);
break;
case StorageProviderType.Amazon:
var providerAmazons3 = _factory.GetStorageProvider("amazons3");
blobUrl = await providerAmazons3.GetBlobUrlAsync(blobName);
break;
case StorageProviderType.Google:
var providerGCP = _factory.GetStorageProvider("googlecloudstorage");
blobUrl = await providerGCP.GetBlobUrlAsync(blobName);
break;
case StorageProviderType.FileSystem:
var providerFileSystem = _factory.GetStorageProvider("filesystem");
blobUrl = await providerFileSystem.GetBlobUrlAsync(blobName);
break;
case StorageProviderType.Kvpbase:
var providerKvpbase = _factory.GetStorageProvider("Kvpbase");
blobUrl = await providerKvpbase.GetBlobUrlAsync(blobName);
break;
case StorageProviderType.Other:
var providerOther = _factory.GetStorageProvider("other");
blobUrl = await providerOther.GetBlobUrlAsync(blobName);
break;
default:
return BadRequest("Provider not supported");
}
return Ok(blobUrl);
}
/// <summary>
/// Get blob url
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-url/{containerOrBucketName}/{blobName}")]
public async Task<IActionResult> GetBlobUrl(string containerOrBucketName, string blobName, StorageProviderType storageProviderType)
{
string blobUrl = string.Empty;
switch (storageProviderType)
{
case StorageProviderType.Azure:
var providerAzure = _factory.GetStorageProvider("azure");
blobUrl = await providerAzure.GetBlobUrlAsync(containerOrBucketName, blobName);
break;
case StorageProviderType.Amazon:
var providerAmazons3 = _factory.GetStorageProvider("amazons3");
blobUrl = await providerAmazons3.GetBlobUrlAsync(containerOrBucketName, blobName);
break;
case StorageProviderType.Google:
var providerGCP = _factory.GetStorageProvider("googlecloudstorage");
blobUrl = await providerGCP.GetBlobUrlAsync(containerOrBucketName, blobName);
break;
case StorageProviderType.FileSystem:
var providerFileSystem = _factory.GetStorageProvider("filesystem");
blobUrl = await providerFileSystem.GetBlobUrlAsync(containerOrBucketName, blobName);
break;
case StorageProviderType.Kvpbase:
var providerKvpbase = _factory.GetStorageProvider("Kvpbase");
blobUrl = await providerKvpbase.GetBlobUrlAsync(containerOrBucketName, blobName);
break;
case StorageProviderType.Other:
var providerOther = _factory.GetStorageProvider("other");
blobUrl = await providerOther.GetBlobUrlAsync(containerOrBucketName, blobName);
break;
default:
return BadRequest("Provider not supported");
}
return Ok(blobUrl);
}
#endregion
}/// <summary>
/// Storage controller
/// </summary>
[Route("api/[controller]")]
public class StorageController : Controller
{
#region Fields
private readonly ILiteXBlobService _blobService;
#endregion
#region Ctor
/// <summary>
/// Ctor
/// </summary>
/// <param name="blobService"></param>
public StorageController(ILiteXBlobService blobService)
{
_blobService = blobService;
}
#endregion
#region Methods
/// <summary>
/// Get Storage Provider Type
/// </summary>
/// <returns></returns>
[HttpGet]
[Route("get-storage-provider-type")]
public IActionResult GetStorageProviderType()
{
return Ok(_blobService.StorageProviderType.ToString());
}
/// <summary>
/// Get blob list
/// from default Container/Bucket
/// </summary>
/// <returns></returns>
[HttpGet]
[Route("get-blobs")]
public async Task<IActionResult> GetBlobs()
{
List<BlobDescriptor> blobs = (await _blobService.GetBlobsAsync()).ToList();
// sync
//List<BlobDescriptor> blobs = _blobService.GetBlobs().ToList();
return Ok(blobs);
}
/// <summary>
/// Get blob list
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blobs/{containerOrBucketName}")]
public async Task<IActionResult> GetBlobs(string containerOrBucketName)
{
List<BlobDescriptor> blobs = (await _blobService.GetBlobsAsync(containerOrBucketName)).ToList();
// sync
//List<BlobDescriptor> blobs = _blobService.GetBlobs(containerOrBucketName).ToList();
return Ok(blobs);
}
/// <summary>
/// Create/Replace blob file
/// from default Container/Bucket
/// </summary>
/// <param name="model">Blob file</param>
/// <param name="isPublic">Is Private or Public blob</param>
/// <returns></returns>
[HttpPost]
[Route("upload-blob")]
public async Task<IActionResult> UploadBlob(FileModel model, bool isPublic = true)
{
string blobName = model.File.FileName;
Stream stream = model.File.OpenReadStream();
string contentType = model.File.ContentType;
BlobProperties properties = new BlobProperties
{
ContentType = contentType,
Security = isPublic ? BlobSecurity.Public : BlobSecurity.Private
};
var isUploaded = await _blobService.UploadBlobAsync(blobName, stream, properties);
// sync
//var isUploaded = _blobService.UploadBlob(blobName, stream, properties);
return Ok(isUploaded);
}
/// <summary>
/// Create/Replace blob file
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="model">Blob file</param>
/// <param name="isPublic">Is Private or Public blob</param>
/// <returns></returns>
[HttpPost]
[Route("upload-blob/{containerOrBucketName}")]
public async Task<IActionResult> UploadBlob(string containerOrBucketName, FileModel model, bool isPublic = true)
{
string blobName = model.File.FileName;
Stream stream = model.File.OpenReadStream();
string contentType = model.File.ContentType;
BlobProperties properties = new BlobProperties
{
ContentType = contentType,
Security = isPublic ? BlobSecurity.Public : BlobSecurity.Private
};
var isUploaded = await _blobService.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
// sync
//var isUploaded = _blobService.UploadBlob(containerOrBucketName, blobName, stream, properties);
return Ok(isUploaded);
}
/// <summary>
/// Create/Replace blob file in directory/folder
/// from default Container/Bucket
/// </summary>
/// <param name="directoryName">Name of directory/folder.</param>
/// <param name="model">Blob file</param>
/// <param name="isPublic">Is Private or Public blob</param>
/// <returns></returns>
[HttpPost]
[Route("upload-blob-in-directory/{directoryName}")]
public async Task<IActionResult> UploadBlobInDirectory(string directoryName, FileModel model, bool isPublic = true)
{
string blobName = $"{directoryName}/{model.File.FileName}";
Stream stream = model.File.OpenReadStream();
string contentType = model.File.ContentType;
BlobProperties properties = new BlobProperties
{
ContentType = contentType,
Security = isPublic ? BlobSecurity.Public : BlobSecurity.Private
};
var isUploaded = await _blobService.UploadBlobAsync(blobName, stream, properties);
// sync
//var isUploaded = _blobService.UploadBlob(blobName, stream, properties);
return Ok(isUploaded);
}
/// <summary>
/// Create/Replace blob file in directory/folder
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="directoryName">Name of directory/folder.</param>
/// <param name="model">Blob file</param>
/// <param name="isPublic">Is Private or Public blob</param>
/// <returns></returns>
[HttpPost]
[Route("upload-blob-in-directory/{containerOrBucketName}/{directoryName}")]
public async Task<IActionResult> UploadBlobInDirectory(string containerOrBucketName, string directoryName, FileModel model, bool isPublic = true)
{
string blobName = $"{directoryName}/{model.File.FileName}";
//string blobName = $"{directoryName}{Path.DirectorySeparatorChar}{file.FileName}";
Stream stream = model.File.OpenReadStream();
string contentType = model.File.ContentType;
BlobProperties properties = new BlobProperties
{
ContentType = contentType,
Security = isPublic ? BlobSecurity.Public : BlobSecurity.Private
};
var isUploaded = await _blobService.UploadBlobAsync(containerOrBucketName, blobName, stream, properties);
// sync
//var isUploaded = _blobService.UploadBlob(containerOrBucketName, blobName, stream, properties);
return Ok(isUploaded);
}
/// <summary>
/// Get blob file data (bytes or stream)
/// from default Container/Bucket
/// </summary>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("download-blob/{blobName}")]
public async Task<IActionResult> DownloadBlob(string blobName)
{
// get blob
Stream stream = await _blobService.GetBlobAsync(blobName);
// sync
//Stream stream = _blobService.GetBlob(blobName);
var response = File(stream, "application/octet-stream", blobName); // FileStreamResult
return response;
}
/// <summary>
/// Get blob file data (bytes or stream)
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("download-blob/{containerOrBucketName}/{blobName}")]
public async Task<IActionResult> DownloadBlob(string containerOrBucketName, string blobName)
{
// get blob
Stream stream = await _blobService.GetBlobAsync(containerOrBucketName, blobName);
// sync
//Stream stream = _blobService.GetBlob(containerOrBucketName, blobName);
var response = File(stream, "application/octet-stream", blobName); // FileStreamResult
return response;
}
/// <summary>
/// Get blob url
/// from default Container/Bucket
/// </summary>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-url/{blobName}")]
public async Task<IActionResult> GetBlobUrl(string blobName)
{
string blobUrl = await _blobService.GetBlobUrlAsync(blobName);
// sync
//string blobUrl = _blobService.GetBlobUrl(blobName);
return Ok(blobUrl);
}
/// <summary>
/// Get blob url
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-url/{containerOrBucketName}/{blobName}")]
public async Task<IActionResult> GetBlobUrl(string containerOrBucketName, string blobName)
{
string blobUrl = await _blobService.GetBlobUrlAsync(containerOrBucketName, blobName);
// sync
//string blobUrl = _blobService.GetBlobUrl(containerOrBucketName, blobName);
return Ok(blobUrl);
}
/// <summary>
/// Get blob SAS url
/// from default Container/Bucket
/// </summary>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-sasurl/{blobName}")]
public async Task<IActionResult> GetBlobSasUrl(string blobName)
{
string blobUrl = await _blobService.GetBlobSasUrlAsync(blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);
// sync
//string blobUrl = _blobService.GetBlobSasUrl(blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);
return Ok(blobUrl);
}
/// <summary>
/// Get blob SAS url
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-sasurl/{containerOrBucketName}/{blobName}")]
public async Task<IActionResult> GetBlobSasUrl(string containerOrBucketName, string blobName)
{
string blobUrl = await _blobService.GetBlobSasUrlAsync(containerOrBucketName, blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);
// sync
//string blobUrl = _blobService.GetBlobSasUrl(containerOrBucketName, blobName, DateTimeOffset.UtcNow.AddHours(2), BlobUrlAccess.Read);
return Ok(blobUrl);
}
/// <summary>
/// Delete blob file
/// from default Container/Bucket
/// </summary>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpDelete]
[Route("delete-blob/{blobName}")]
public async Task<IActionResult> DeleteBlobFile(string blobName)
{
var isDeleted = await _blobService.DeleteBlobAsync(blobName);
// sync
//var isDeleted = _blobService.DeleteBlob(blobName);
return Ok(isDeleted);
}
/// <summary>
/// Delete blob file
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpDelete]
[Route("delete-blob/{containerOrBucketName}/{blobName}")]
public async Task<IActionResult> DeleteBlobFile(string containerOrBucketName, string blobName)
{
var isDeleted = await _blobService.DeleteBlobAsync(containerOrBucketName, blobName);
// sync
//var isDeleted = _blobService.DeleteBlob(containerOrBucketName, blobName);
return Ok(isDeleted);
}
/// <summary>
/// Get blob metadata
/// from default Container/Bucket
/// </summary>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-metadata/{blobName}")]
public async Task<IActionResult> GetBlobMetadata(string blobName)
{
BlobDescriptor blobDescriptor = await _blobService.GetBlobDescriptorAsync(blobName);
// sync
//BlobDescriptor blobDescriptor = _blobService.GetBlobDescriptor(blobName);
var metadata = blobDescriptor.Metadata;
return Ok(blobDescriptor);
}
/// <summary>
/// Get blob metadata
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpGet]
[Route("get-blob-metadata/{containerOrBucketName}/{blobName}")]
public async Task<IActionResult> GetBlobMetadata(string containerOrBucketName, string blobName)
{
BlobDescriptor blobDescriptor = await _blobService.GetBlobDescriptorAsync(containerOrBucketName, blobName);
// sync
//BlobDescriptor blobDescriptor = _blobService.GetBlobDescriptor(containerOrBucketName, blobName);
var metadata = blobDescriptor.Metadata;
return Ok(blobDescriptor);
}
/// <summary>
/// Set blob metadata
/// from default Container/Bucket
/// </summary>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpPut]
[Route("set-blob-metadata/{blobName}")]
public async Task<IActionResult> SetBlobMetadata(string blobName)
{
IDictionary<string, string> metadata = new Dictionary<string, string>();
BlobProperties properties = new BlobProperties()
{
ContentType = "",
Metadata = metadata,
ContentDisposition = "",
Security = BlobSecurity.Public
};
var isSet = await _blobService.SetBlobPropertiesAsync(blobName, properties);
// sync
//var isSet = _blobService.SetBlobProperties(blobName, properties);
return Ok(isSet);
}
/// <summary>
/// Set blob metadata
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="blobName">Name of the Blob.</param>
/// <returns></returns>
[HttpPut]
[Route("set-blob-metadata/{containerOrBucketName}/{blobName}")]
public async Task<IActionResult> SetBlobMetadata(string containerOrBucketName, string blobName)
{
IDictionary<string, string> metadata = new Dictionary<string, string>();
BlobProperties properties = new BlobProperties()
{
ContentType = "",
Metadata = metadata,
ContentDisposition = "",
Security = BlobSecurity.Public
};
var isSet = await _blobService.SetBlobPropertiesAsync(containerOrBucketName, blobName, properties);
// sync
//var isSet = _blobService.SetBlobProperties(containerOrBucketName, blobName, properties);
return Ok(isSet);
}
/// <summary>
/// Delete directory/folder from default Container/Bucket
/// </summary>
/// <param name="directoryName">Name of directory/folder.</param>
/// <returns></returns>
[HttpDelete]
[Route("delete-directory/{directoryName}")]
public async Task<IActionResult> DeleteDirectory(string directoryName)
{
var isDeleted = await _blobService.DeleteDirectoryAsync(directoryName);
// sync
//var isDeleted = _blobService.DeleteDirectory(directoryName);
return Ok(isDeleted);
}
/// <summary>
/// Delete directory/folder from Container/Bucket
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <param name="directoryName">Name of directory/folder.</param>
/// <returns></returns>
[HttpDelete]
[Route("delete-directory/{containerOrBucketName}/{directoryName}")]
public async Task<IActionResult> DeleteDirectory(string containerOrBucketName, string directoryName)
{
var isDeleted = await _blobService.DeleteDirectoryAsync(containerOrBucketName, directoryName);
// sync
//var isDeleted = _blobService.DeleteDirectory(containerOrBucketName, directoryName);
return Ok(isDeleted);
}
/// <summary>
/// Get number to total items/files in Container/Bucket
/// </summary>
/// <returns></returns>
[HttpGet]
[Route("get-container-or-bucket-item-count")]
public async Task<IActionResult> GetContainerOrBucketItemCount()
{
var itemsCount = await _blobService.GetContainerItemCountAsync();
// sync
//var itemsCount = _blobService.GetContainerItemCount();
return Ok(itemsCount);
}
/// <summary>
/// Get number to total items/files in Container/Bucket
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <returns></returns>
[HttpGet]
[Route("get-container-or-bucket-item-count/{containerOrBucketName}")]
public async Task<IActionResult> GetContainerOrBucketItemCount(string containerOrBucketName)
{
var itemsCount = await _blobService.GetContainerItemCountAsync(containerOrBucketName);
// sync
//var itemsCount = _blobService.GetContainerItemCount(containerOrBucketName);
return Ok(itemsCount);
}
/// <summary>
/// Get Container/Bucket size in bytes
/// </summary>
/// <returns></returns>
[HttpGet]
[Route("get-container-or-bucket-size")]
public async Task<IActionResult> GetContainerOrBucketSize()
{
var size = await _blobService.GetContainerSizeAsync();
// sync
//var size = _blobService.GetContainerSize();
return Ok(size);
}
/// <summary>
/// Get Container/Bucket size in bytes
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <returns></returns>
[HttpGet]
[Route("get-container-or-bucket-size/{containerOrBucketName}")]
public async Task<IActionResult> GetContainerOrBucketSize(string containerOrBucketName)
{
var size = await _blobService.GetContainerSizeAsync(containerOrBucketName);
// sync
//var size = _blobService.GetContainerSize(containerOrBucketName);
return Ok(size);
}
/// <summary>
/// Create Container/Bucket
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <returns></returns>
[HttpGet]
[Route("create-container-or-bucket/{containerOrBucketName}")]
public async Task<IActionResult> CreateContainerOrBucket(string containerOrBucketName)
{
var isCreated = await _blobService.CreateContainerAsync(containerOrBucketName);
// sync
//var isCreated = _blobService.CreateContainer(containerOrBucketName);
return Ok(isCreated);
}
/// <summary>
/// Delete Container/Bucket
/// </summary>
/// <param name="containerOrBucketName">Name of the Bucket/Container.</param>
/// <returns></returns>
[HttpDelete]
[Route("delete-container-or-bucket/{containerOrBucketName}")]
public async Task<IActionResult> DeleteContainerOrBucket(string containerOrBucketName)
{
var isDeleted = await _blobService.DeleteContainerAsync(containerOrBucketName);
// sync
//var isDeleted = _blobService.DeleteContainer(containerOrBucketName);
return Ok(isDeleted);
}
/// <summary>
/// Get all Containers/Buckets
/// </summary>
/// <returns></returns>
[HttpGet]
[Route("get-all-containers-or-buckets")]
public async Task<IActionResult> GetAllContainersOrBuckets()
{
var containers = await _blobService.GetAllContainersAsync();
// sync
//var containers = _blobService.GetAllContainers();
return Ok(containers);
}
/// <summary>
/// Delete all Containers/Buckets
/// </summary>
/// <returns></returns>
[HttpDelete]
[Route("delete-all-containers-or-buckets")]
public async Task<IActionResult> DeleteAllContainersOrBuckets()
{
var isDeleted = await _blobService.DeleteAllContainersAsync();
// sync
//var isDeleted = _blobService.DeleteAllContainers();
return Ok(isDeleted);
}
#endregion
}- Azure
- AmazonS3
- Google Cloud
- File System
- Kvpbase
- Get Blob SAS
- .NET Standard 2.1 support
- .NET 5.0 support
- Remove sync methods
Feel free to request an issue on github if you find bugs or request a new feature. Your valuable feedback is much appreciated to better improve this project. If you find this useful, please give it a star to show your support for this project.
Reach out to me at one of the following places!
- Email ✉️ at
[email protected] - NuGet 📦 at
@iamaashishpatel
- Ashish Patel - A-Patel
| Website | Medium | NuGet | GitHub | Microsoft | Tumblr | ||||
|---|---|---|---|---|---|---|---|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
If you find this project useful — or just feeling generous, consider buying me a beer or a coffee. Cheers! 🍻 ☕
| PayPal | BMC | Patreon |
|---|---|---|
 |
 |
 |
This project is licensed under the MIT License - see the LICENSE file for details.
