conn

Documentation

Index

• func GetAllTiKVStores(ctx context.Context, pdClient pd.Client, storeBehavior StoreBehavior) ([]*metapb.Store, error)
• func GetAllTiKVStoresWithRetry(ctx context.Context, pdClient pd.Client, storeBehavior StoreBehavior) ([]*metapb.Store, error)
• type Mgr
  • func NewMgr(ctx context.Context, g glue.Glue, pdAddrs string, tlsConf *tls.Config, ...) (*Mgr, error)
  • func (mgr *Mgr) Close()
  • func (mgr *Mgr) GetBackupClient(ctx context.Context, storeID uint64) (backuppb.BackupClient, error)
  • func (mgr *Mgr) GetDomain() *domain.Domain
  • func (mgr *Mgr) GetLockResolver() *txnlock.LockResolver
  • func (mgr *Mgr) GetStorage() kv.Storage
  • func (mgr *Mgr) GetTLSConfig() *tls.Config
  • func (mgr *Mgr) ResetBackupClient(ctx context.Context, storeID uint64) (backuppb.BackupClient, error)
• type Pool
  • func NewConnPool(cap int, newConn func(ctx context.Context) (*grpc.ClientConn, error)) *Pool
  • func (p *Pool) Close()
  • func (p *Pool) Get(ctx context.Context) (*grpc.ClientConn, error)
• type StoreBehavior

Functions

func GetAllTiKVStores

func GetAllTiKVStores(
	ctx context.Context,
	pdClient pd.Client,
	storeBehavior StoreBehavior,
) ([]*metapb.Store, error)

GetAllTiKVStores returns all TiKV stores registered to the PD client. The stores must not be a tombstone and must never contain a label `engine=tiflash`.

func GetAllTiKVStoresWithRetry

func GetAllTiKVStoresWithRetry(ctx context.Context,
	pdClient pd.Client,
	storeBehavior StoreBehavior,
) ([]*metapb.Store, error)

Types

type Mgr

type Mgr struct {
	*pdutil.PdController
	// contains filtered or unexported fields
}

Mgr manages connections to a TiDB cluster.

func NewMgr

func NewMgr(
	ctx context.Context,
	g glue.Glue,
	pdAddrs string,
	tlsConf *tls.Config,
	securityOption pd.SecurityOption,
	keepalive keepalive.ClientParameters,
	storeBehavior StoreBehavior,
	checkRequirements bool,
	needDomain bool,
) (*Mgr, error)

NewMgr creates a new Mgr.

Domain is optional for Backup, set `needDomain` to false to disable initializing Domain.

func (*Mgr) Close

func (mgr *Mgr) Close()

Close closes all client in Mgr.

func (*Mgr) GetBackupClient

func (mgr *Mgr) GetBackupClient(ctx context.Context, storeID uint64) (backuppb.BackupClient, error)

GetBackupClient get or create a backup client.

func (*Mgr) GetDomain

func (mgr *Mgr) GetDomain() *domain.Domain

GetDomain returns a tikv storage.

func (*Mgr) GetLockResolver

func (mgr *Mgr) GetLockResolver() *txnlock.LockResolver

GetLockResolver gets the LockResolver.

func (*Mgr) GetStorage

func (mgr *Mgr) GetStorage() kv.Storage

GetStorage returns a kv storage.

func (*Mgr) GetTLSConfig

func (mgr *Mgr) GetTLSConfig() *tls.Config

GetTLSConfig returns the tls config.

func (*Mgr) ResetBackupClient

func (mgr *Mgr) ResetBackupClient(ctx context.Context, storeID uint64) (backuppb.BackupClient, error)

ResetBackupClient reset the connection for backup client.

type Pool

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

Pool is a lazy pool of gRPC channels. When `Get` called, it lazily allocates new connection if connection not full. If it's full, then it will return allocated channels round-robin.

func NewConnPool

func NewConnPool(cap int, newConn func(ctx context.Context) (*grpc.ClientConn, error)) *Pool

NewConnPool creates a new Pool by the specified conn factory function and capacity.

func (*Pool) Close

func (p *Pool) Close()

Close closes the conn pool.

func (*Pool) Get

func (p *Pool) Get(ctx context.Context) (*grpc.ClientConn, error)

Get tries to get an existing connection from the pool, or make a new one if the pool not full.

type StoreBehavior

type StoreBehavior uint8

StoreBehavior is the action to do in GetAllTiKVStores when a non-TiKV store (e.g. TiFlash store) is found.

const (
	// ErrorOnTiFlash causes GetAllTiKVStores to return error when the store is
	// found to be a TiFlash node.
	ErrorOnTiFlash StoreBehavior = 0
	// SkipTiFlash causes GetAllTiKVStores to skip the store when it is found to
	// be a TiFlash node.
	SkipTiFlash StoreBehavior = 1
	// TiFlashOnly caused GetAllTiKVStores to skip the store which is not a
	// TiFlash node.
	TiFlashOnly StoreBehavior = 2
)