primaryreplica

README

primaryreplica

Read Write separation for primary-replica topologies

Example

package main

import (
	"context"

	_ "github.com/go-sql-driver/mysql"
	"github.com/go-rel/primaryreplica"
	"github.com/go-rel/mysql"
	"github.com/go-rel/rel"
)
func main() {
	// open mysql connections.
	// note: `clientFoundRows=true` is required for update and delete to works correctly.
	adapter := primaryreplica.New(
		mysql.MustOpen("root@(source:3306)/rel_test?charset=utf8&parseTime=True&loc=Local"),
		mysql.MustOpen("root@(replica1:3306)/rel_test?charset=utf8&parseTime=True&loc=Local"),
		mysql.MustOpen("root@(replica2:3306)/rel_test?charset=utf8&parseTime=True&loc=Local"),
	)
	defer adapter.Close()

	// initialize REL's repo.
	repo := rel.New(adapter)
	repo.Ping(context.TODO())
}

Load Balancing of Replicas

REL only implements a very primitive load balancing for multiple replicas. For large scale application we recommend you to use external load balancing solution.

Documentation

Index

• func New(primary rel.Adapter, replicas ...rel.Adapter) rel.Adapter
• type PrimaryReplica
  • func (pr *PrimaryReplica) Aggregate(ctx context.Context, query rel.Query, mode string, field string) (int, error)
  • func (pr *PrimaryReplica) Apply(ctx context.Context, migration rel.Migration) error
  • func (pr *PrimaryReplica) Begin(ctx context.Context) (rel.Adapter, error)
  • func (pr *PrimaryReplica) Close() error
  • func (pr *PrimaryReplica) Commit(ctx context.Context) error
  • func (pr *PrimaryReplica) Delete(ctx context.Context, query rel.Query) (int, error)
  • func (pr *PrimaryReplica) Exec(ctx context.Context, stmt string, args []interface{}) (int64, int64, error)
  • func (pr *PrimaryReplica) Insert(ctx context.Context, query rel.Query, primaryField string, ...) (interface{}, error)
  • func (pr *PrimaryReplica) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, ...) ([]interface{}, error)
  • func (pr *PrimaryReplica) Instrumentation(instrumenter rel.Instrumenter)
  • func (pr *PrimaryReplica) Name() string
  • func (pr *PrimaryReplica) Ping(ctx context.Context) error
  • func (pr *PrimaryReplica) Query(ctx context.Context, query rel.Query) (rel.Cursor, error)
  • func (pr *PrimaryReplica) Rollback(ctx context.Context) error
  • func (pr *PrimaryReplica) Update(ctx context.Context, query rel.Query, primaryField string, ...) (int, error)
  • func (pr *PrimaryReplica) WriteAdapter() rel.Adapter

Functions

func New

func New(primary rel.Adapter, replicas ...rel.Adapter) rel.Adapter

Types

type PrimaryReplica

type PrimaryReplica struct {
	// contains filtered or unexported fields
}

func (*PrimaryReplica) Aggregate

func (pr *PrimaryReplica) Aggregate(ctx context.Context, query rel.Query, mode string, field string) (int, error)

func (*PrimaryReplica) Apply

func (pr *PrimaryReplica) Apply(ctx context.Context, migration rel.Migration) error

func (*PrimaryReplica) Begin

func (pr *PrimaryReplica) Begin(ctx context.Context) (rel.Adapter, error)

func (*PrimaryReplica) Close

func (pr *PrimaryReplica) Close() error

func (*PrimaryReplica) Commit

func (pr *PrimaryReplica) Commit(ctx context.Context) error

func (*PrimaryReplica) Delete

func (pr *PrimaryReplica) Delete(ctx context.Context, query rel.Query) (int, error)

func (*PrimaryReplica) Exec

func (pr *PrimaryReplica) Exec(ctx context.Context, stmt string, args []interface{}) (int64, int64, error)

func (*PrimaryReplica) Insert

func (pr *PrimaryReplica) Insert(ctx context.Context, query rel.Query, primaryField string, mutates map[string]rel.Mutate, onConflict rel.OnConflict) (interface{}, error)

func (*PrimaryReplica) InsertAll

func (pr *PrimaryReplica) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, bulkMutates []map[string]rel.Mutate, onConflict rel.OnConflict) ([]interface{}, error)

func (*PrimaryReplica) Instrumentation

func (pr *PrimaryReplica) Instrumentation(instrumenter rel.Instrumenter)

func (*PrimaryReplica) Name

func (pr *PrimaryReplica) Name() string

func (*PrimaryReplica) Ping

func (pr *PrimaryReplica) Ping(ctx context.Context) error

func (*PrimaryReplica) Query

func (pr *PrimaryReplica) Query(ctx context.Context, query rel.Query) (rel.Cursor, error)

func (*PrimaryReplica) Rollback

func (pr *PrimaryReplica) Rollback(ctx context.Context) error

func (*PrimaryReplica) Update

func (pr *PrimaryReplica) Update(ctx context.Context, query rel.Query, primaryField string, mutates map[string]rel.Mutate) (int, error)

func (*PrimaryReplica) WriteAdapter

func (pr *PrimaryReplica) WriteAdapter() rel.Adapter