Hangfire.AzureCosmosDB 2.0.1

.NET Standard 2.0
NuGet\Install-Package Hangfire.AzureCosmosDB -Version 2.0.1
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.
dotnet add package Hangfire.AzureCosmosDB --version 2.0.1
<PackageReference Include="Hangfire.AzureCosmosDB" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Hangfire.AzureCosmosDB --version 2.0.1
#r "nuget: Hangfire.AzureCosmosDB, 2.0.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Hangfire.AzureCosmosDB as a Cake Addin
#addin nuget:?package=Hangfire.AzureCosmosDB&version=2.0.1

// Install Hangfire.AzureCosmosDB as a Cake Tool
#tool nuget:?package=Hangfire.AzureCosmosDB&version=2.0.1

Hangfire.AzureCosmosDB

Official Site Latest version Downloads Build status

This repo will add a Microsoft Azure Cosmos DB storage support to Hangfire - fire-and-forget, delayed and recurring tasks runner for .NET. Scalable and reliable background job runner. Supports multiple servers, CPU and I/O intensive, long-running and short-running jobs.

Installation

Hangfire.AzureCosmosDB is available on NuGet.

Package Manager

PM> Install-Package Hangfire.AzureCosmosDB

.NET CLI

> dotnet add package Hangfire.AzureCosmosDB

PackageReference

<PackageReference Include="Hangfire.AzureCosmosDB" Version="0.0.0" />

Usage

Use one the following ways to initialize CosmosDbStorage

GlobalConfiguration.Configuration.UseAzureCosmosDbStorage("<url>", "<authSecret>", "<databaseName>", "<collectionName>");

------------------------------------------------ 

Hangfire.Azure.CosmosDbStorage storage = Hangfire.Azure.CosmosDbStorage.Create("<url>", "<authSecret>", "<databaseName>", "<collectionName>");
GlobalConfiguration.Configuration.UseStorage(storage);
// customize any options
Hangfire.Azure.CosmosDbStorageOptions options = new Hangfire.Azure.CosmosDbStorageOptions
{
    ExpirationCheckInterval = TimeSpan.FromMinutes(2),
    CountersAggregateInterval = TimeSpan.FromMinutes(2),
    QueuePollInterval = TimeSpan.FromSeconds(15)
};

GlobalConfiguration.Configuration.UseAzureCosmosDbStorage("<url>", "<authSecret>", "<databaseName>", "<collectionName>", cosmoClientOptions, options);

------------------------------------------------ 

Hangfire.Azure.CosmosDbStorage storage = Hangfire.Azure.CosmosDbStorage.Create("<url>", "<authSecret>", "<databaseName>", "<collectionName>", cosmoClientOptions, options);
GlobalConfiguration.Configuration.UseStorage(storage);

Recommendations

  • Keep separate database/collection for the hangfire. (Now you can enable free tier on Azure)

SDK Support

This package only supports the latest Microsoft.Azure.Cosmos SDK v3

Questions? Problems?

Open-source project are developing more smoothly, when all discussions are held in public.

If you have any questions or problems related to Hangfire.AzureCosmosDB itself or this storage implementation or want to discuss new features, please create under issues and assign the correct label for discussion.

If you've discovered a bug, please report it to the GitHub Issues. Detailed reports with stack traces, actual and expected behaviours are welcome.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.1 12,554 4/8/2022
2.0.0 117 4/6/2022
1.3.1 3,851 2/2/2022
1.3.0 24,862 8/19/2021
1.2.0 11,822 5/10/2021
1.1.0 9,950 6/11/2020
1.0.1 6,199 3/11/2020