https://github.com/viniciuscestarii/postgres-protocol-go
🐘 PostgreSQL driver in Go using only the standard library
https://github.com/viniciuscestarii/postgres-protocol-go
postgresql postgresql-driver postgresql-protocol
Last synced: 26 days ago
JSON representation
🐘 PostgreSQL driver in Go using only the standard library
- Host: GitHub
- URL: https://github.com/viniciuscestarii/postgres-protocol-go
- Owner: ViniciusCestarii
- License: mit
- Created: 2025-01-30T12:29:13.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-07T18:19:16.000Z (3 months ago)
- Last Synced: 2025-02-07T19:23:56.491Z (3 months ago)
- Topics: postgresql, postgresql-driver, postgresql-protocol
- Language: Go
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Postgres Protocol Go
This project implements the PostgreSQL wire protocol in Go using only the standard library.
## Usage
```go
func main() {
connStr := "postgres://postgres:123456@localhost:5432/postgres"
driveConfig := models.DriveConfig{Verbose: true,}
pgConnection, err := protocol.NewPgConnection(connStr, driveConfig)
if err != nil {
fmt.Println(err)
return
}
userToFind := "postgres"
res, err := pgConnection.Query("SELECT * FROM pg_user WHERE usename = $1;", userToFind)
if err != nil {
fmt.Println(err)
pgConnection.Close()
return
}
fmt.Println("Postgres user: ", res.Rows)
pgConnection.Close()
}
```
## Features
- Flexible Connection Handling
- Supports both URL-style connection strings (postgres://user:pass@host:port/db)
- Supports key-value connection strings (`host=localhost port=5432`)
- SSL/TLS Support
- Automatic SSL/TLS negotiation when `sslmode=require`
- Secure encrypted connections
- Query Interface
- Simple query protocol support
- Extended query protocol with parameter binding
- Support for parameterized queries using $1, $2 etc.
- Connection Configuration
- Configurable verbose mode for debugging
- Custom drive configuration options via models.DriveConfig
- Authentication
- SCRAM-SHA-256
- md5
- clear text
- Clean Resource Management
- Proper connection termination
## Running the Client Implementation example
1. Clone the repository:
```bash
git clone https://github.com/ViniciusCestarii/postgres-protocol-go.git
```
2. Create environment file:
```bash
cp .env.example .env
```
3. Set the environment variables in the `.env` file.
4. Run the client implementation:
```bash
go run cmd/client.go
```
## Folder Structure
```bash
postgres-protocol-go/
│── cmd/
│ ├── client.go # Client implementation example using this driver
│── internal/
│ ├── pool/ # Buff writer
│ ├── protocol/ # PostgreSQL wire protocol handling
│── pkg/
│ ├── utils/ # Shared utilities (logging, errors, helpers)
│ ├── models/ # Data structures for queries, results, etc.
│── tests/ # Integration and unit tests
│── go.mod # Go module file
│── README.md # Project documentation
```
## Testing
To run the tests, use the following commands:
```bash
go test ./tests/...
```
## Acknowledgements
[Official Protocol Documentation](https://www.postgresql.org/docs/16/protocol.html)
[Message Formats](https://www.postgresql.org/docs/16/protocol-message-formats.html)
[pbkdf2 go implementation](https://cs.opensource.google/go/x/crypto/+/refs/tags/v0.32.0:pbkdf2/pbkdf2.go)
[gp-pg](https://github.com/go-pg/pg)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.