Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bxcodec/dbresolver
Golang Database Resolver and Wrapper for any multiple database connections topology, e.g. master-slave replication database, cross-region application, and for separated ReadWrite (RW) and ReadOnly (RO) database connections
https://github.com/bxcodec/dbresolver
database database-replication dbresolver global-database go golang master-slave-replication mysql postgres postgresql sql sqlite3
Last synced: 3 days ago
JSON representation
Golang Database Resolver and Wrapper for any multiple database connections topology, e.g. master-slave replication database, cross-region application, and for separated ReadWrite (RW) and ReadOnly (RO) database connections
- Host: GitHub
- URL: https://github.com/bxcodec/dbresolver
- Owner: bxcodec
- License: mit
- Created: 2022-05-30T13:07:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T22:50:10.000Z (5 months ago)
- Last Synced: 2024-10-15T04:27:39.322Z (4 months ago)
- Topics: database, database-replication, dbresolver, global-database, go, golang, master-slave-replication, mysql, postgres, postgresql, sql, sqlite3
- Language: Go
- Homepage: https://pkg.go.dev/github.com/bxcodec/dbresolver
- Size: 216 KB
- Stars: 150
- Watchers: 3
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-golang-repositories - dbresolver - slave replication database, cross-region application, and for separated ReadWrite (RW) and Rea ... (Repositories)
README
# dbresolver
Golang Database Resolver and Wrapper for any multiple database connections topology, eg. master-slave replication database, cross-region application.
[](https://github.com/bxcodec/dbresolver/actions/workflows/go.yml)
[](https://pkg.go.dev/github.com/bxcodec/dbresolver/v2?tab=doc)
## Idea and Inspiration
This DBResolver library will split your connections to correct defined DBs. Eg, all read query will routed to ReadOnly replica db, and all write operation(Insert, Update, Delete) will routed to Primary/Master DB.
**Read More**
|Items| Link|
------|-----|
|Blogpost| [blog post](https://betterprogramming.pub/create-a-cross-region-rdbms-connection-library-with-dbresolver-5072bed6a7b8) |
|Excalidraw| [diagram](https://excalidraw.com/#json=DTs8yxHOGF6uLkjnZny4z,RVo8iwhO0Rk6DRGkKuNZTg)|
|GoSG Meetup Demo| [repository](https://github.com/bxcodec/dbresolver-examples) |
| GoSG Presentation | [deck](https://www.canva.com/design/DAFgbpc7tfw/bEXVFtcHEnlFxKVBdnUggA/edit?utm_content=DAFgbpc7tfw&utm_campaign=designshare&utm_medium=link2&utm_source=sharebutton) |
| Instagram | [post](https://www.instagram.com/p/CnlDFPsBAJG/?utm_source=ig_web_copy_link&igsh=MzRlODBiNWFlZA==)|
### Usecase 1: Separated RW and RO Database connection
Click to Expand
- You have your application deployed
- Your application is heavy on read operations
- Your DBs replicated to multiple replicas for faster queries
- You separate the connections for optimized query
- 
### Usecase 2: Cross Region Database
Click to Expand
- Your application deployed to multi regions.
- You have your Databases configured globally.
- 
### Usecase 3: Multi-Master (Multi-Primary) Database
Click to Expand
- You're using a Multi-Master database topology eg, Aurora Multi-Master
- 
## Support
You can file an [Issue](https://github.com/bxcodec/dbresolver/issues/new).
See documentation in [Go.Dev](https://pkg.go.dev/github.com/bxcodec/dbresolver/v2?tab=doc)
## Getting Started
#### Download
```shell
go get -u github.com/bxcodec/dbresolver/v2
```
# Example
### Implementing DB Resolver using \*sql.DB
Click to Expand
```go
package main
import (
"context"
"database/sql"
"fmt"
"log"
"github.com/bxcodec/dbresolver/v2"
_ "github.com/lib/pq"
)
func main() {
var (
host1 = "localhost"
port1 = 5432
user1 = "postgresrw"
password1 = ""
host2 = "localhost"
port2 = 5433
user2 = "postgresro"
password2 = ""
dbname = ""
)
// connection string
rwPrimary := fmt.Sprintf("host=%s port=%d user=%s password=%s dbname=%s sslmode=disable", host1, port1, user1, password1, dbname)
readOnlyReplica := fmt.Sprintf("host=%s port=%d user=%s password=%s dbname=%s sslmode=disable", host2, port2, user2, password2, dbname)
// open database for primary
dbPrimary, err := sql.Open("postgres", rwPrimary)
if err != nil {
log.Print("go error when connecting to the DB")
}
// configure the DBs for other setup eg, tracing, etc
// eg, tracing.Postgres(dbPrimary)
// open database for replica
dbReadOnlyReplica, err := sql.Open("postgres", readOnlyReplica)
if err != nil {
log.Print("go error when connecting to the DB")
}
// configure the DBs for other setup eg, tracing, etc
// eg, tracing.Postgres(dbReadOnlyReplica)
connectionDB := dbresolver.New(
dbresolver.WithPrimaryDBs(dbPrimary),
dbresolver.WithReplicaDBs(dbReadOnlyReplica),
dbresolver.WithLoadBalancer(dbresolver.RoundRobinLB))
defer connectionDB.Close()
// now you can use the connection for all DB operation
_, err = connectionDB.ExecContext(context.Background(), "DELETE FROM book WHERE id=$1") // will use primaryDB
if err != nil {
log.Print("go error when executing the query to the DB", err)
}
connectionDB.QueryRowContext(context.Background(), "SELECT * FROM book WHERE id=$1") // will use replicaReadOnlyDB
}
```
## Important Notes
- Primary Database will be used when you call these functions
- `Exec`
- `ExecContext`
- `Begin` (transaction will use primary)
- `BeginTx`
- Queries with `"RETURNING"` clause
- `Query`
- `QueryContext`
- `QueryRow`
- `QueryRowContext`
- Replica Databases will be used when you call these functions
- `Query`
- `QueryContext`
- `QueryRow`
- `QueryRowContext`
## Contribution
To contrib to this project, you can open a PR or an issue.