MVFC.DataX.Providers.SQS
1.2.0
dotnet add package MVFC.DataX.Providers.SQS --version 1.2.0
NuGet\Install-Package MVFC.DataX.Providers.SQS -Version 1.2.0
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="MVFC.DataX.Providers.SQS" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MVFC.DataX.Providers.SQS" Version="1.2.0" />
<PackageReference Include="MVFC.DataX.Providers.SQS" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MVFC.DataX.Providers.SQS --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MVFC.DataX.Providers.SQS, 1.2.0"
#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.
#:package MVFC.DataX.Providers.SQS@1.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MVFC.DataX.Providers.SQS&version=1.2.0
#tool nuget:?package=MVFC.DataX.Providers.SQS&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MVFC.DataX.Providers.SQS
Amazon SQS data provider for MVFC.DataX, implementing AWS messaging queues via AWSSDK.SQS.
This package is part of the MVFC.DataX suite. For the full documentation and more examples, please check the main repository README.
Installation
dotnet add package MVFC.DataX.Providers.SQS
Available Classes
| Class | Description |
|---|---|
SqsDataReader<T> |
Streams data from an SQS queue via long-polling, automatically executing DeleteMessageAsync for yielded messages. |
SqsDataWriter<T> |
Writes item via SendMessageAsync. In batch context, chunks requests into sets of 10 mapping to SendMessageBatchAsync. |
API Signatures
SqsDataReader<T>
public SqsDataReader(
IAmazonSQS sqsClient,
string queueUrl,
Func<Message, T> deserializer,
int maxMessages = 10,
int waitTimeSeconds = 20)
SqsDataWriter<T>
public SqsDataWriter(
IAmazonSQS sqsClient,
string queueUrl,
Func<T, SendMessageRequest> serializer)
Usage / Example
using System.Text.Json;
using Amazon.SQS;
using Amazon.SQS.Model;
using MVFC.DataX.Pipeline;
using MVFC.DataX.Providers.SQS;
var sqsClient = new AmazonSQSClient(); // Assumes AWS credentials are valid in environment
var inboundQueue = "https://sqs.us-east-1.amazonaws.com/123/inbound";
var outboundQueue = "https://sqs.us-east-1.amazonaws.com/123/outbound";
// 1. Setup the SQS Reader
var reader = new SqsDataReader<Order>(
sqsClient,
inboundQueue,
// Safely deserialize the body of the SQS Message
deserializer: msg => JsonSerializer.Deserialize<Order>(msg.Body)!
);
// 2. Setup the SQS Writer
var writer = new SqsDataWriter<Order>(
sqsClient,
outboundQueue,
// Convert your object to an explicit SendMessageRequest model
serializer: order => new SendMessageRequest
{
MessageBody = JsonSerializer.Serialize(order)
}
);
// 3. Orchestrate with PipelineBuilder
var pipeline = PipelineBuilder.ReadFrom(reader)
.WriteTo(writer)
// SQS chunks internally into 10-message limits via WriteBatchAsync optimization
.WithBatchSize(25)
.Build();
await pipeline.RunAsync(cancellationToken);
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- AWSSDK.SQS (>= 3.7.400.78)
- MVFC.DataX.Core (>= 1.2.0)
-
net9.0
- AWSSDK.SQS (>= 3.7.400.78)
- MVFC.DataX.Core (>= 1.2.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.