chore: lint and refactor for Godoc needs (#15)

Author: bxcodec

README.md

@@ -3,7 +3,7 @@
 Golang Database Resolver and Wrapper for any multiple database connections topology, eg. master-slave replication database, cross-region application.
 
 [![Go](https://github.com/bxcodec/dbresolver/actions/workflows/go.yml/badge.svg?branch=main)](https://github.com/bxcodec/dbresolver/actions/workflows/go.yml)
-[![Go.Dev](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/bxcodec/dbresolver?tab=doc)
+[![Go.Dev](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://pkg.go.dev/github.com/bxcodec/dbresolver/v2?tab=doc)
 
 ## Idea and Inspiration
 

db.go

@@ -12,12 +12,14 @@ import (
 // DB interface is a contract that supported by this library.
 // All offered function of this library defined here.
 // This supposed to be aligned with sql.DB, but since some of the functions is not relevant
-// with multi dbs connection, we decided to not support it
+// with multi dbs connection, we decided to forward all single connection DB related function to the first primary DB
+// For example, function like, `Conn()“, or `Stats()` only available for the primary DB, or the first primary DB (if using multi-primary)
 type DB interface {
 	Begin() (*sql.Tx, error)
 	BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)
 	Close() error
-	Conn(ctx context.Context) (*sql.Conn, error) // db stats for only one of the primary db
+	// Conn only available for the primary db or the first primary db (if using multi-primary)
+	Conn(ctx context.Context) (*sql.Conn, error)
 	Driver() driver.Driver
 	Exec(query string, args ...interface{}) (sql.Result, error)
 	ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
@@ -35,14 +37,15 @@ type DB interface {
 	SetMaxOpenConns(n int)
 	PrimaryDBs() []*sql.DB
 	ReplicaDBs() []*sql.DB
-	Stats() sql.DBStats // db stats for only one of the primary db
+	// Stats only available for the primary db or the first primary db (if using multi-primary)
+	Stats() sql.DBStats
 }
 
-// Supported LoadBalancer
-type (
-	DBLoadBalancer   LoadBalancer[*sql.DB]
-	StmtLoadBalancer LoadBalancer[*sql.Stmt]
-)
+// DBLoadBalancer is loadbalancer for physical DBs
+type DBLoadBalancer LoadBalancer[*sql.DB]
+
+// StmtLoadBalancer is loadbalancer for query prepared statements
+type StmtLoadBalancer LoadBalancer[*sql.Stmt]
 
 // sqlDB is a logical database with multiple underlying physical databases
 // forming a single ReadWrite (primary) with multiple ReadOnly(replicas) db.

example_wrap_dbs_test.go

@@ -10,7 +10,7 @@ import (
 	_ "github.com/lib/pq"
 )
 
-func ExampleNewResolver() {
+func ExampleNew() {
 	var (
 		host1     = "localhost"
 		port1     = 5432
@@ -42,7 +42,7 @@ func ExampleNewResolver() {
 	// configure the DBs for other setup eg, tracing, etc
 	// eg, tracing.Postgres(dbReadOnlyReplica)
 
-	connectionDB := dbresolver.NewResolver(
+	connectionDB := dbresolver.New(
 		dbresolver.WithPrimaryDBs(dbPrimary),
 		dbresolver.WithReplicaDBs(dbReadOnlyReplica),
 		dbresolver.WithLoadBalancer(dbresolver.RoundRobinLB))

resolver.go

@@ -1,17 +1,15 @@
 package dbresolver
 
-// Resolver will resolve all the passed connection
-// first DB connection is the primary-writer connection (RW),
-// the rest connection will be used for RO connection
-func NewResolver(opts ...OptionFunc) DB {
+// New will resolve all the passed connection with configurable parameters
+func New(opts ...OptionFunc) DB {
 	opt := defaultOption()
 	for _, optFunc := range opts {
 		optFunc(opt)
 	}
 
 	if len(opt.PrimaryDBs) == 0 {
 		panic("required primary db connection, set the primary db " +
-			"connection with dbresolver.Resolver(dbresolver.WithPrimaryDBs(primaryDB))")
+			"connection with dbresolver.New(dbresolver.WithPrimaryDBs(primaryDB))")
 	}
 	return &sqlDB{
 		primaries:        opt.PrimaryDBs,

resolver_test.go

@@ -12,7 +12,7 @@ func TestWrapDBWithMultiDBs(t *testing.T) {
 	db2 := &sql.DB{}
 	db3 := &sql.DB{}
 
-	db := dbresolver.NewResolver(dbresolver.WithPrimaryDBs(db1), dbresolver.WithReplicaDBs(db2, db3))
+	db := dbresolver.New(dbresolver.WithPrimaryDBs(db1), dbresolver.WithReplicaDBs(db2, db3))
 
 	if db == nil {
 		t.Errorf("expected %v, got %v", "not nil", db)
@@ -22,7 +22,7 @@ func TestWrapDBWithMultiDBs(t *testing.T) {
 func TestWrapDBWithOneDB(t *testing.T) {
 	db1 := &sql.DB{}
 
-	db := dbresolver.NewResolver(dbresolver.WithPrimaryDBs(db1))
+	db := dbresolver.New(dbresolver.WithPrimaryDBs(db1))
 
 	if db == nil {
 		t.Errorf("expected %v, got %v", "not nil", db)