https://github.com/camerodev/psql-wire
https://github.com/camerodev/psql-wire
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/camerodev/psql-wire
- Owner: camerodev
- License: mpl-2.0
- Created: 2024-03-15T21:05:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-15T21:05:15.000Z (about 1 year ago)
- Last Synced: 2025-04-07T16:43:27.584Z (about 2 months ago)
- Language: Go
- Size: 284 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# PSQL wire protocol 🔌
[](https://github.com/jeroenrinzema/psql-wire/actions/workflows/build.yaml)
[](https://pkg.go.dev/github.com/jeroenrinzema/psql-wire) [](https://github.com/jeroenrinzema/psql-wire/releases) [](https://goreportcard.com/report/github.com/jeroenrinzema/psql-wire)
A pure Go [PostgreSQL](https://www.postgresql.org/) server wire protocol implementation.
Build your own PostgreSQL server within a few lines of code.
This project attempts to make it as straight forward as possible to set-up and configure your own PSQL server.
Feel free to check out the [examples](https://github.com/jeroenrinzema/psql-wire/tree/main/examples) directory for various ways on how to configure/set-up your own server.
> 🚧 This project does not include a PSQL parser. Please check out other projects such as [auxten/postgresql-parser](https://github.com/auxten/postgresql-parser) to parse PSQL SQL queries.
```go
package main
import (
"context"
"fmt"
wire "github.com/jeroenrinzema/psql-wire"
)
func main() {
wire.ListenAndServe("127.0.0.1:5432", handler)
}
func handler(ctx context.Context, query string) (wire.PreparedStatementFn, []oid.Oid, wire.Columns, error) {
fmt.Println(query)
statement := func(ctx context.Context, writer wire.DataWriter, parameters []string) error {
return writer.Complete("OK")
}
return statement, nil, nil, nil
}
```
---
## Contributing
Thank you for your interest in contributing to psql-wire!
Check out the open projects and/or issues and feel free to join any ongoing discussion.
Feel free to checkout the [open TODO's](https://github.com/jeroenrinzema/psql-wire/issues?q=is%3Aissue+is%3Aopen+label%3Atodo) within the project.
Everyone is welcome to contribute, whether it's in the form of code, documentation, bug reports, feature requests, or anything else. We encourage you to experiment with the project and make contributions to help evolve it to meet your needs!
See the [contributing guide](https://github.com/jeroenrinzema/psql-wire/blob/main/CONTRIBUTING.md) for more details.