Merge branch 'master' into sa-master-v2

Author: salarali

.github/workflows/compatibility.yml

@@ -14,7 +14,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.16
+        go-version: 1.19
 
     - name: Checkout Client-Go
       uses: actions/checkout@v2

.github/workflows/integration.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.19
 
       - name: Test
         run: go test ./...
@@ -32,7 +32,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.19
 
       - name: Test
         run: go test ./... -race
@@ -47,7 +47,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.19
 
       - name: Fetch PD
         uses: shrink/actions-docker-extract@v1
@@ -79,14 +79,17 @@ jobs:
 
   integration-raw-tikv:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        api_version: [v1ttl, v2]
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.19
 
       - name: Fetch PD
         uses: shrink/actions-docker-extract@v1
@@ -108,7 +111,7 @@ jobs:
           mv ../../${{steps.extract-tikv.outputs.destination}}/tikv-server .
           ./pd-server > pd.log 2>&1 &
           sleep 5
-          ./tikv-server -C tikv.toml > tikv.log 2>&1 &
+          ./tikv-server -C tikv-${{ matrix.api_version }}.toml > tikv.log 2>&1 &
           sleep 15
         working-directory: integration_tests/raw
 

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.16
+        go-version: 1.18
 
     - name: Test
       run: go test ./...
@@ -28,7 +28,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.16
+        go-version: 1.18
 
     - name: Test with race
       run: go test -race ./...
@@ -42,9 +42,10 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.16
+          go-version: 1.18
 
       - name: Lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v2.5.2
         with:
-          version: v1.29
+          version: v1.47.3
+

README.md

@@ -91,6 +91,7 @@ go mod download github.com/tikv/client-go/v2
 - [TiCDC](https://github.com/pingcap/ticdc): Change data capture for TiDB
 - [go-ycsb](https://github.com/pingcap/go-ycsb): A Go port of Yahoo! Cloud Serving Benchmark (YCSB)
 - [JuiceFS](https://github.com/juicedata/juicefs): JuiceFS is a distributed POSIX file system built on top of Redis and S3
+- [tcli](https://github.com/c4pt0r/tcli): A CLI tool for TiKV, for human being :)
 
 ## License
 

error/error.go

@@ -35,6 +35,7 @@
 package error
 
 import (
+	"encoding/hex"
 	"fmt"
 	"time"
 
@@ -86,6 +87,12 @@ var (
 	ErrRegionNotInitialized = errors.New("region not Initialized")
 	// ErrTiKVDiskFull is the error when tikv server disk usage is full.
 	ErrTiKVDiskFull = errors.New("tikv disk full")
+	// ErrRegionRecoveryInProgress is the error when region is recovering.
+	ErrRegionRecoveryInProgress = errors.New("region is being online unsafe recovered")
+	// ErrRegionFlashbackInProgress is the error when a region in the flashback progress receive any other request.
+	ErrRegionFlashbackInProgress = errors.New("region is in the flashback progress")
+	// ErrRegionFlashbackNotPrepared is the error when a region is not prepared for the flashback first.
+	ErrRegionFlashbackNotPrepared = errors.New("region is not prepared for the flashback")
 	// ErrUnknown is the unknow error.
 	ErrUnknown = errors.New("unknow")
 	// ErrResultUndetermined is the error when execution result is unknown.
@@ -150,13 +157,14 @@ func IsErrWriteConflict(err error) bool {
 	return errors.As(err, &e)
 }
 
-//NewErrWriteConfictWithArgs generates an ErrWriteConflict with args.
-func NewErrWriteConfictWithArgs(startTs, conflictTs, conflictCommitTs uint64, key []byte) *ErrWriteConflict {
+// NewErrWriteConflictWithArgs generates an ErrWriteConflict with args.
+func NewErrWriteConflictWithArgs(startTs, conflictTs, conflictCommitTs uint64, key []byte, reason kvrpcpb.WriteConflict_Reason) *ErrWriteConflict {
 	conflict := kvrpcpb.WriteConflict{
 		StartTs:          startTs,
 		ConflictTs:       conflictTs,
 		Key:              key,
 		ConflictCommitTs: conflictCommitTs,
+		Reason:           reason,
 	}
 	return &ErrWriteConflict{WriteConflict: &conflict}
 }
@@ -236,10 +244,36 @@ type ErrAssertionFailed struct {
 	*kvrpcpb.AssertionFailed
 }
 
+// ErrLockOnlyIfExistsNoReturnValue is used when the flag `LockOnlyIfExists` of `LockCtx` is set, but `ReturnValues`` is not.
+type ErrLockOnlyIfExistsNoReturnValue struct {
+	StartTS     uint64
+	ForUpdateTs uint64
+	LockKey     []byte
+}
+
+// ErrLockOnlyIfExistsNoPrimaryKey is used when the flag `LockOnlyIfExists` of `LockCtx` is set, but primary key of current transaction is not.
+type ErrLockOnlyIfExistsNoPrimaryKey struct {
+	StartTS     uint64
+	ForUpdateTs uint64
+	LockKey     []byte
+}
+
 func (e *ErrAssertionFailed) Error() string {
 	return fmt.Sprintf("assertion failed { %s }", e.AssertionFailed.String())
 }
 
+func (e *ErrLockOnlyIfExistsNoReturnValue) Error() string {
+	return fmt.Sprintf("LockOnlyIfExists is set for Lock Context, but ReturnValues is not set, "+
+		"StartTs is {%d}, ForUpdateTs is {%d}, one of lock keys is {%v}.",
+		e.StartTS, e.ForUpdateTs, hex.EncodeToString(e.LockKey))
+}
+
+func (e *ErrLockOnlyIfExistsNoPrimaryKey) Error() string {
+	return fmt.Sprintf("LockOnlyIfExists is set for Lock Context, but primary key of current transaction is not set, "+
+		"StartTs is {%d}, ForUpdateTs is {%d}, one of lock keys is {%s}",
+		e.StartTS, e.ForUpdateTs, hex.EncodeToString(e.LockKey))
+}
+
 // ExtractKeyErr extracts a KeyError.
 func ExtractKeyErr(keyErr *kvrpcpb.KeyError) error {
 	if val, err := util.EvalFailpoint("mockRetryableErrorResp"); err == nil {

examples/gcworker/gcworker.go

@@ -21,7 +21,7 @@ import (
 	"time"
 
 	"github.com/tikv/client-go/v2/oracle"
-	"github.com/tikv/client-go/v2/tikv"
+	"github.com/tikv/client-go/v2/txnkv"
 )
 
 var (
@@ -31,7 +31,7 @@ var (
 
 func main() {
 	flag.Parse()
-	client, err := tikv.NewTxnClient([]string{*pdAddr})
+	client, err := txnkv.NewClient([]string{*pdAddr})
 	if err != nil {
 		panic(err)
 	}

examples/gcworker/go.mod

@@ -1,6 +1,6 @@
 module gcworker
 
-go 1.16
+go 1.18
 
 require github.com/tikv/client-go/v2 v2.0.0
 

examples/rawkv/go.mod

@@ -1,6 +1,6 @@
 module rawkv
 
-go 1.16
+go 1.18
 
 require github.com/tikv/client-go/v2 v2.0.0
 

examples/txnkv/1pc_txn/1pc_txn.go

@@ -20,18 +20,18 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/tikv/client-go/v2/tikv"
+	"github.com/tikv/client-go/v2/txnkv"
 )
 
 var (
-	client *tikv.KVStore
+	client *txnkv.Client
 	pdAddr = flag.String("pd", "127.0.0.1:2379", "pd address")
 )
 
 // Init initializes information.
 func initStore() {
 	var err error
-	client, err = tikv.NewTxnClient([]string{*pdAddr})
+	client, err = txnkv.NewClient([]string{*pdAddr})
 	if err != nil {
 		panic(err)
 	}

examples/txnkv/1pc_txn/go.mod

@@ -1,6 +1,6 @@
 module 1pc_txn
 
-go 1.16
+go 1.18
 
 require github.com/tikv/client-go/v2 v2.0.0