Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seddryck/pgnoli
Pgnoli is a .NET implementation of the PostgreSQL wire protocol v3. It gives you some traits to implement your own PostgreSQL compatible servers (and client if there is case Npgsql does not fit).
https://github.com/seddryck/pgnoli
database-driver postgresql postgresql-driver wire-protocol
Last synced: 4 days ago
JSON representation
Pgnoli is a .NET implementation of the PostgreSQL wire protocol v3. It gives you some traits to implement your own PostgreSQL compatible servers (and client if there is case Npgsql does not fit).
- Host: GitHub
- URL: https://github.com/seddryck/pgnoli
- Owner: Seddryck
- License: apache-2.0
- Created: 2023-09-02T16:12:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-29T20:22:25.000Z (9 months ago)
- Last Synced: 2024-05-01T13:04:11.536Z (7 months ago)
- Topics: database-driver, postgresql, postgresql-driver, wire-protocol
- Language: C#
- Homepage:
- Size: 1.3 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Pgnoli
Pgnoli is a .NET implementation of the PostgreSQL wire protocol v3.
It gives you some traits to implement your own PostgreSQL compatible servers (and client if there is case [Npgsql](https://github.com/Npgsql/Npgsql) does not fit).
Postgresql wire protocol is actually a general purpose Layer-7 application protocol. It is not bound with SQL, and can be used for any query language, data format or even natural language. It is possible to build a chat bot that use psql as client.
- [X] (De)serialization of messages for Startup flow
- [X] (De)serialization of messages for Simple Query flow
- [X] (De)serialization of messages for Extended Query flow
- [X] (De)serialization of types for binary encoding
- [X] (De)serialization of types for text encoding
- [X] Support of DateStyle for encoding Date/Time related types
[About][] | [Quickstart][]
[About]: #about (About)
[Quickstart]: #quickstart (Quickstart)
## About
**Social media:** [](https://seddryck.github.io/Pgnoli)
[](https://twitter.com/Seddryck)
**Releases:** [](https://www.nuget.org/packages/Pgnoli/)
[](https://github.com/Seddryck/Pgnoli/blob/master/LICENSE)
**Dev. activity:** [](https://github.com/Seddryck/Pgnoli/commits)
**Continuous integration builds:** [](https://ci.appveyor.com/project/Seddryck/Pgnoli/)
[](https://ci.appveyor.com/project/Seddryck/Pgnoli/build/tests)
[](https://www.codefactor.io/repository/github/seddryck/Pgnoli)
[](https://codecov.io/github/Seddryck/Pgnoli)
**Status:** [](https://github.com/Seddryck/Pgnoli/stargazers)
[](https://github.com/Seddryck/Pgnoli/issues?utf8=%E2%9C%93&q=is:issue+is:open+label:bug+)
[](https://github.com/Seddryck/Pgnoli/issues?utf8=%E2%9C%93&q=is:issue+is:open+label:new-feature+)
[](https://github.com/Seddryck/Pgnoli/search?l=C%23)
## Quickstart
Pgnoli is a .NET assembly and can be installed as a package next to your project with the help of `Nuget CLI` or `dotnet.exe`
```bash
dotnet add package Pgnoli
```
When receiving a message from the client your solution can use the `FrontendParser` class to deserialize the message contained in an array of bytes.
```csharp
var parser = new FrontendParser();
var msg = parser.Parse(bytes);
```
The parser returns a strongly typed message implementing the interface `IMessage`. Most of the messages inherits from the class `CodeMessage` exposing a property Code of one char.
Once the message is parsed, you can access its payload, using the property `Payload`. The content of the payload depends of the message class, i.e. for a [Query message](https://www.postgresql.org/docs/current/protocol-message-formats.html), the payload contains the SQL query.
```csharp
var queryMsg = msg as Query;
Console.WriteLine(queryMsh.Sql);
```
To create a message, you can use the static methods offered by the class implementing these messages. These methods depends of the messages, i.e. to create a message `ReadyForQuery`, you can use the static method `Idle`.
To effectively get your message you should call the `Build()` method.
```csharp
var msg = ReadyForQuery.Idle.Build();
```
Some messages accept optional informations. You can communicate them with the help of `With(...)` functions. i.e. the message `Bind` can create messages for named and unnamed portals but also accept the different parameters and how the result should be serialized. This last element can be defined with the methods `WithAllResultsAsText()` or `WithAllResultsAsBinary()` or for each column of the result, we can define the encoding by chaining the calls to `WithResultFormat(...)`.
```csharp
var msg = Bind.Portal("destination", "source").WithAllResultsAsBinary().Build();
```
The handling of the encoding in both text and binary formats is done with the classes from the `TypeHandlers` namespace.
However in most cases, you won't need them as the handling is directly managed within the class implementing the messages.