Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

locate

package

Go to main page

Versions in this module

v3

v3.1.3

Jul 5, 2022

v3.1.2

Jun 6, 2022

v3.1.1

Jun 6, 2022

v3.1.0

May 17, 2022

v3.0.9

May 17, 2022

v3.0.8

May 3, 2022

v3.0.7

May 3, 2022

v3.0.6

May 3, 2022

v3.0.5

May 2, 2022

v3.0.4

May 1, 2022

v3.0.3

May 1, 2022

v3.0.0

May 1, 2022

Changes in this version

+ func GetStoreLivenessTimeout() time.Duration

+ func IsFakeRegionError(err *errorpb.Error) bool

+ func LoadShuttingDown() uint32

+ func RecordRegionRequestRuntimeStats(stats map[tikvrpc.CmdType]*RPCRuntimeStats, cmd tikvrpc.CmdType, ...)

+ func SetRegionCacheTTLSec(t int64)

+ func SetStoreLivenessTimeout(t time.Duration)

+ func StoreShuttingDown(v uint32)

+ type AccessIndex int

+ type Bucket struct

+ EndKey []byte

+ StartKey []byte

+ func (b *Bucket) Contains(key []byte) bool

+ type CodecPDClient struct

+ func NewCodeCPDClient(client pd.Client) *CodecPDClient

+ func (c *CodecPDClient) GetPrevRegion(ctx context.Context, key []byte, opts ...pd.GetRegionOption) (*pd.Region, error)

+ func (c *CodecPDClient) GetRegion(ctx context.Context, key []byte, opts ...pd.GetRegionOption) (*pd.Region, error)

+ func (c *CodecPDClient) GetRegionByID(ctx context.Context, regionID uint64, opts ...pd.GetRegionOption) (*pd.Region, error)

+ func (c *CodecPDClient) ScanRegions(ctx context.Context, startKey []byte, endKey []byte, limit int) ([]*pd.Region, error)

+ type InvalidReason int32

+ const EpochNotMatch

+ const NoLeader

+ const Ok

+ const Other

+ const RegionNotFound

+ const StoreNotFound

+ type KeyLocation struct

+ Buckets *metapb.Buckets

+ EndKey []byte

+ Region RegionVerID

+ StartKey []byte

+ func (l *KeyLocation) Contains(key []byte) bool

+ func (l *KeyLocation) GetBucketVersion() uint64

+ func (l *KeyLocation) LocateBucket(key []byte) *Bucket

+ func (l *KeyLocation) String() string

+ type RPCCanceller struct

+ func NewRPCanceller() *RPCCanceller

+ func (h *RPCCanceller) CancelAll()

+ func (h *RPCCanceller) WithCancel(ctx context.Context) (context.Context, func())

+ type RPCCancellerCtxKey struct

+ type RPCContext struct

+ AccessIdx AccessIndex

+ AccessMode accessMode

+ Addr string

+ Meta *metapb.Region

+ Peer *metapb.Peer

+ ProxyAddr string

+ ProxyStore *Store

+ Region RegionVerID

+ Store *Store

+ TiKVNum int

+ func (c *RPCContext) String() string

+ type RPCRuntimeStats struct

+ Consume int64

+ Count int64

+ type Region struct

+ func (r *Region) AnyStorePeer(rs *regionStore, followerStoreSeed uint32, op *storeSelectorOp) (store *Store, peer *metapb.Peer, accessIdx AccessIndex, storeIdx int)

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

+ func (r *Region) ContainsByEnd(key []byte) bool

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

+ func (r *Region) FollowerStorePeer(rs *regionStore, followerStoreSeed uint32, op *storeSelectorOp) (store *Store, peer *metapb.Peer, accessIdx AccessIndex, storeIdx int)

+ func (r *Region) GetID() uint64

+ func (r *Region) GetLeaderPeerID() uint64

+ func (r *Region) GetLeaderStoreID() uint64

+ func (r *Region) GetMeta() *metapb.Region

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

+ func (r *Region) VerID() RegionVerID

+ func (r *Region) WorkStorePeer(rs *regionStore) (store *Store, peer *metapb.Peer, accessIdx AccessIndex, storeIdx int)

+ type RegionCache struct

+ func NewRegionCache(pdClient pd.Client) *RegionCache

+ func (c *RegionCache) BatchLoadRegionsFromKey(bo *retry.Backoffer, startKey []byte, count int) ([]byte, error)

+ func (c *RegionCache) BatchLoadRegionsWithKeyRange(bo *retry.Backoffer, startKey []byte, endKey []byte, count int) (regions []*Region, err error)

+ func (c *RegionCache) Close()

+ func (c *RegionCache) GetAllValidTiFlashStores(id RegionVerID, currentStore *Store) []uint64

+ func (c *RegionCache) GetCachedRegionWithRLock(regionID RegionVerID) (r *Region)

+ func (c *RegionCache) GetStoresByType(typ tikvrpc.EndpointType) []*Store

+ func (c *RegionCache) GetTiFlashRPCContext(bo *retry.Backoffer, id RegionVerID, loadBalance bool) (*RPCContext, error)

+ func (c *RegionCache) GetTiFlashStores() []*Store

+ func (c *RegionCache) GetTiKVRPCContext(bo *retry.Backoffer, id RegionVerID, replicaRead kv.ReplicaReadType, ...) (*RPCContext, error)

+ func (c *RegionCache) GroupKeysByRegion(bo *retry.Backoffer, keys [][]byte, ...) (map[RegionVerID][][]byte, RegionVerID, error)

+ func (c *RegionCache) InvalidateCachedRegion(id RegionVerID)

+ func (c *RegionCache) InvalidateCachedRegionWithReason(id RegionVerID, reason InvalidReason)

+ func (c *RegionCache) ListRegionIDsInKeyRange(bo *retry.Backoffer, startKey, endKey []byte) (regionIDs []uint64, err error)

+ func (c *RegionCache) LoadRegionsInKeyRange(bo *retry.Backoffer, startKey, endKey []byte) (regions []*Region, err error)

+ func (c *RegionCache) LocateEndKey(bo *retry.Backoffer, key []byte) (*KeyLocation, error)

+ func (c *RegionCache) LocateKey(bo *retry.Backoffer, key []byte) (*KeyLocation, error)

+ func (c *RegionCache) LocateRegionByID(bo *retry.Backoffer, regionID uint64) (*KeyLocation, error)

+ func (c *RegionCache) OnRegionEpochNotMatch(bo *retry.Backoffer, ctx *RPCContext, currentRegions []*metapb.Region) (bool, error)

+ func (c *RegionCache) OnSendFail(bo *retry.Backoffer, ctx *RPCContext, scheduleReload bool, err error)

+ func (c *RegionCache) OnSendFailForTiFlash(bo *retry.Backoffer, store *Store, region RegionVerID, prev *metapb.Region, ...)

+ func (c *RegionCache) PDClient() pd.Client

+ func (c *RegionCache) SetPDClient(client pd.Client)

+ func (c *RegionCache) SetRegionCacheStore(id uint64, storeType tikvrpc.EndpointType, state uint64, ...)

+ func (c *RegionCache) UpdateBucketsIfNeeded(regionID RegionVerID, latestBucketsVer uint64)

+ func (c *RegionCache) UpdateLeader(regionID RegionVerID, leader *metapb.Peer, currentPeerIdx AccessIndex)

+ type RegionRequestRuntimeStats struct

+ Stats map[tikvrpc.CmdType]*RPCRuntimeStats

+ func NewRegionRequestRuntimeStats() RegionRequestRuntimeStats

+ func (r *RegionRequestRuntimeStats) Clone() RegionRequestRuntimeStats

+ func (r *RegionRequestRuntimeStats) Merge(rs RegionRequestRuntimeStats)

+ func (r *RegionRequestRuntimeStats) String() string

+ type RegionRequestSender struct

+ func NewRegionRequestSender(regionCache *RegionCache, client client.Client) *RegionRequestSender

+ func (s *RegionRequestSender) GetClient() client.Client

+ func (s *RegionRequestSender) GetRPCError() error

+ func (s *RegionRequestSender) GetRegionCache() *RegionCache

+ func (s *RegionRequestSender) GetStoreAddr() string

+ func (s *RegionRequestSender) NeedReloadRegion(ctx *RPCContext) (need bool)

+ func (s *RegionRequestSender) SendReq(bo *retry.Backoffer, req *tikvrpc.Request, regionID RegionVerID, ...) (*tikvrpc.Response, error)

+ func (s *RegionRequestSender) SendReqCtx(bo *retry.Backoffer, req *tikvrpc.Request, regionID RegionVerID, ...) (resp *tikvrpc.Response, rpcCtx *RPCContext, err error)

+ func (s *RegionRequestSender) SetRPCError(err error)

+ func (s *RegionRequestSender) SetStoreAddr(addr string)

+ type RegionVerID struct

+ func NewRegionVerID(id, confVer, ver uint64) RegionVerID

+ func (r *RegionVerID) Equals(another RegionVerID) bool

+ func (r *RegionVerID) GetConfVer() uint64

+ func (r *RegionVerID) GetID() uint64

+ func (r *RegionVerID) GetVer() uint64

+ func (r *RegionVerID) String() string

+ type Store struct

+ func (s *Store) GetAddr() string

+ func (s *Store) IsLabelsMatch(labels []*metapb.StoreLabel) bool

+ func (s *Store) IsSameLabels(labels []*metapb.StoreLabel) bool

+ func (s *Store) IsTiFlash() bool

+ func (s *Store) StoreID() uint64

+ type StoreSelectorOption func(*storeSelectorOp)

+ func WithLeaderOnly() StoreSelectorOption

+ func WithMatchLabels(labels []*metapb.StoreLabel) StoreSelectorOption