Npgmq 1.13.0

Npgmq

A .NET client for Postgres Message Queue (PGMQ).

Installation

To install the package via Nuget, run the following command:

dotnet add package Npgmq

Recommended Usage (TL;DR)

Creating NpgmqClient

When creating an NpgmqClient instance, the recommended approach is to use an NpgsqlDataSource. This provides the best connection pooling, performance, and safety.

await using var dataSource = NpgsqlDataSource.Create("<YOUR CONNECTION STRING HERE>");
var npgmq = new NpgmqClient(dataSource);

You can also construct the client with a connection string or an existing NpgsqlConnection, but those options have tradeoffs. See Database Connection below.

Using Dependency Injection (ASP.NET Core)

For ASP.NET Core applications, register NpgmqClient in the DI container using one of the following methods:

builder.Services.AddNpgmqClient("<YOUR CONNECTION STRING HERE>");

builder.Services.AddNpgmqClient(); // If you already have an NpgsqlDataSource registered

Basic Example

using Npgmq;

var npgmq = new NpgmqClient("<YOUR CONNECTION STRING HERE>");

await npgmq.InitAsync(); // Optional (ensures the pgmq extension has been created in postgres)

await npgmq.CreateQueueAsync("my_queue");

var msgId = await npgmq.SendAsync("my_queue", new MyMessageType
{
    Foo = "Test",
    Bar = 123
});
Console.WriteLine($"Sent message with id {msgId}");

var msg = await npgmq.ReadAsync<MyMessageType>("my_queue");
if (msg != null)
{
    Console.WriteLine($"Read message with id {msg.MsgId}: Foo = {msg.Message?.Foo}, Bar = {msg.Message?.Bar}");
    await npgmq.ArchiveAsync("my_queue", msg.MsgId);
}

public class MyMessageType
{
    public string Foo { get; set; } = null!;
    public int Bar { get; set; }
}

Additional Examples

For more complete examples, see the following projects included in this repository:

• Npgmq.Example.Console
• Npgmq.Example.Web

JSON Messages (Custom Serialization)

If you want full control over JSON serialization, you can send and receive messages as string:

var msgId = await npgmq.SendAsync("my_queue", "{\"foo\":\"Test\",\"bar\":123}");
Console.WriteLine($"Sent message with id {msgId}");

var msg = await npgmq.ReadAsync<string>("my_queue");
if (msg != null)
{
    Console.WriteLine($"Read message with id {msg.MsgId}: {msg.Message}");
    await npgmq.ArchiveAsync("my_queue", msg.MsgId);
}

Important:

• When sending messages as string, the value must contain valid JSON.
• NpgmqClient does not validate or escape string messages. Invalid JSON will cause the database call to fail.

Database Connection

Npgmq uses Npgsql internally to connect to the database.

Using NpgsqlDataSource (Recommended)

await using var myDataSource = NpgsqlDataSource.Create("<YOUR CONNECTION STRING HERE>");
var npgmq = new NpgmqClient(myDataSource);

This is the preferred approach and provides optimal pooling and configuration.

Using a Connection String

var npgmq = new NpgmqClient("<YOUR CONNECTION STRING HERE>");

Connections are created as needed using the provided connection string.

Using an Existing NpgsqlConnection

await using var myConnection = new NpgsqlConnection("<YOUR CONNECTION STRING HERE>");
var npgmq = new NpgmqClient(myConnection);

When using this constructor:

• You are responsible for managing the connection lifecycle.
• NpgmqClient will open the connection if necessary, but will not close or dispose it.
• Concurrent usage is not supported. Ensure only one operation uses the connection at a time.

Concurrency

NpgmqClient is safe for concurrent use when constructed with:

• an NpgsqlDataSource
• a connection string

When constructed with an existing NpgsqlConnection, concurrent operations are not supported.

PGMQ Version Requirements

Npgmq is tested with pgmq versions 1.5.1 and higher.

Some features require minimum versions of the pgmq extension:

You can check the installed version:

var version = await npgmq.GetPgmqVersionAsync();

License

MIT License. See LICENSE for details.