tikv

Documentation

Overview

Package tikv provides tcp connection to kvserver.

Index

• Constants
• func NewBackoff(retry, base, cap, jitter int) func() error
• func NewMockTikvStore() kv.Storage
• type Client
  • func NewRPCClient(srvHost string) (Client, error)
• type ClientFactory
• type CopClient
  • func (c *CopClient) Send(req *kv.Request) kv.Response
  • func (c *CopClient) SupportRequestType(reqType, subType int64) bool
• type Driver
  • func (d Driver) Open(path string) (kv.Storage, error)
• type Region
  • func (r *Region) Contains(key []byte) bool
  • func (r *Region) EndKey() []byte
  • func (r *Region) GetAddress() string
  • func (r *Region) GetContext() *kvrpcpb.Context
  • func (r *Region) GetID() uint64
  • func (r *Region) NextPeer() (*metapb.Peer, error)
  • func (r *Region) StartKey() []byte
  • func (r *Region) VerID() RegionVerID
• type RegionCache
  • func NewRegionCache(pdClient pd.Client) *RegionCache
  • func (c *RegionCache) DropRegion(id RegionVerID)
  • func (c *RegionCache) GetRegion(key []byte) (*Region, error)
  • func (c *RegionCache) GetRegionByVerID(id RegionVerID) *Region
  • func (c *RegionCache) NextPeer(id RegionVerID)
  • func (c *RegionCache) UpdateLeader(regionID RegionVerID, leaderID uint64)
• type RegionVerID
• type Scanner
  • func (s *Scanner) Close()
  • func (s *Scanner) Key() kv.Key
  • func (s *Scanner) Next() error
  • func (s *Scanner) Valid() bool
  • func (s *Scanner) Value() []byte

Constants

const (
	// NoJitter makes the backoff sequence strict exponential.
	NoJitter = 1 + iota
	// FullJitter applies random factors to strict exponential.
	FullJitter
	// EqualJitter is also randomized, but prevents very short sleeps.
	EqualJitter
	// DecorrJitter increases the maximum jitter based on the last random value.
	DecorrJitter
)

Functions

func NewBackoff

func NewBackoff(retry, base, cap, jitter int) func() error

NewBackoff creates a backoff func which implements exponential backoff with optional jitters. See: http://www.awsarchitectureblog.com/2015/03/backoff.html

func NewMockTikvStore

func NewMockTikvStore() kv.Storage

NewMockTikvStore creates a mocked tikv store.

Types

type Client

type Client interface {
	// Close should release all data.
	Close() error
	// SendKVReq sends kv request.
	SendKVReq(req *kvrpcpb.Request) (*kvrpcpb.Response, error)
	// SendCopReq sends coprocessor request.
	SendCopReq(req *coprocessor.Request) (*coprocessor.Response, error)
}

Client is a client that sends RPC. It should not be used after calling Close().

func NewRPCClient

func NewRPCClient(srvHost string) (Client, error)

NewRPCClient new client that sends protobuf to do RPC.

type ClientFactory

type ClientFactory func(string) (Client, error)

ClientFactory is a function that creates a Client with server address.

type CopClient

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

CopClient is coprocessor client.

func (*CopClient) Send

func (c *CopClient) Send(req *kv.Request) kv.Response

Send builds the request and gets the coprocessor iterator response.

func (*CopClient) SupportRequestType

func (c *CopClient) SupportRequestType(reqType, subType int64) bool

SupportRequestType checks whether reqType is supported.

type Driver

type Driver struct {
}

Driver implements engine Driver.

func (Driver) Open

func (d Driver) Open(path string) (kv.Storage, error)

Open opens or creates an TiKV storage with given path. Path example: tikv://etcd-node1:port,etcd-node2:port/pd-path?cluster=1

type Region

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

Region stores region info. Region is a readonly class.

func (*Region) Contains

func (r *Region) Contains(key []byte) bool

Contains checks whether the key is in the region, for the maximum region endKey is empty. startKey <= key < endKey.

func (*Region) EndKey

func (r *Region) EndKey() []byte

EndKey returns EndKey.

func (*Region) GetAddress

func (r *Region) GetAddress() string

GetAddress returns address.

func (*Region) GetContext

func (r *Region) GetContext() *kvrpcpb.Context

GetContext constructs kvprotopb.Context from region info.

func (*Region) GetID

func (r *Region) GetID() uint64

GetID returns id.

func (*Region) NextPeer

func (r *Region) NextPeer() (*metapb.Peer, error)

NextPeer picks next peer as leader, if out of range return error.

func (*Region) StartKey

func (r *Region) StartKey() []byte

StartKey returns StartKey.

func (*Region) VerID

func (r *Region) VerID() RegionVerID

VerID returns the Region's RegionVerID.

type RegionCache

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

RegionCache store region cache by region id.

func NewRegionCache

func NewRegionCache(pdClient pd.Client) *RegionCache

NewRegionCache new region cache.

func (*RegionCache) DropRegion

func (c *RegionCache) DropRegion(id RegionVerID)

DropRegion remove some region cache.

func (*RegionCache) GetRegion

func (c *RegionCache) GetRegion(key []byte) (*Region, error)

GetRegion find in cache, or get new region.

func (*RegionCache) GetRegionByVerID

func (c *RegionCache) GetRegionByVerID(id RegionVerID) *Region

GetRegionByVerID finds a Region by Region's verID.

func (*RegionCache) NextPeer

func (c *RegionCache) NextPeer(id RegionVerID)

NextPeer picks next peer as new leader, if out of range of peers delete region.

func (*RegionCache) UpdateLeader

func (c *RegionCache) UpdateLeader(regionID RegionVerID, leaderID uint64)

UpdateLeader update some region cache with newer leader info.

type RegionVerID

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

RegionVerID is a unique ID that can identify a Region at a specific version.

type Scanner

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

Scanner support tikv scan

func (*Scanner) Close

func (s *Scanner) Close()

Close close iterator.

func (*Scanner) Key

func (s *Scanner) Key() kv.Key

Key return key.

func (*Scanner) Next

func (s *Scanner) Next() error

Next return next element.

func (*Scanner) Valid

func (s *Scanner) Valid() bool

Valid return valid.

func (*Scanner) Value

func (s *Scanner) Value() []byte

Value return value.