add comments and add --skip-rows for load csv

Author: c4pt0r

cmd_flags.go

@@ -38,10 +38,12 @@ var DeleteOptsKeywordList = []string{
 ///////////////// loadcsv options //////////////////////
 var (
 	LoadFileOptBatchSize string = "batch-size"
+	LoadFileoptSkipRows  string = "skip-rows"
 )
 
 var LoadFileOptsKeywordList = []string{
 	LoadFileOptBatchSize,
+	LoadFileoptSkipRows,
 }
 
 //////////////// end of loadcsv options ///////////////

kvcmds/cmd_backup.go

@@ -32,7 +32,10 @@ Usage:
 Options:
 	--batch-size=<size>, default 1000
 Example:
+	# backup all kvs with prefix "t_" to csv file
 	backup "t_" backup.csv --batch-size=5000
+
+	# backup all kvs to csv file
 	backup * backup.csv
 	backup $head  backup.csv
 `)

kvcmds/cmd_delete_prefix.go

@@ -29,7 +29,7 @@ Alias:
 	deletep, removep, rmp
 Options:
 	--yes, force yes
-	--limit, default: 1000
+	--limit=<limit>, default: 1000
 `
 	return s
 }

kvcmds/cmd_loadfile.go

@@ -34,23 +34,27 @@ Usage:
 Alias:
 	lcsv
 Options:
-	--batch-size: int, how many records in one tikv transaction, default: 1000
+	--batch-size=<size>: int, how many records in one tikv transaction, default: 1000
 Examples:
-	loadcsv sample.csv
+	# load csv file to tikv
+	loadcsv sample.csv 
+
+	# load csv file to tikv with key prefix: "prefix_"
 	loadcsv sample.csv "prefix_" --batch-size=100
+
+	# load csv file to tikv with key prefix and skip first row (header)
+	loadcsv sample.csv "prefix_" --batch-size=100 --skip-rows=1
 `
 	return s
 }
 
 func (c LoadCsvCmd) processCSV(prop *properties.Properties, rc io.Reader, keyPrefix []byte) error {
 	r := csv.NewReader(rc)
-	if _, err := r.Read(); err != nil { //read header
-		return err
-	}
 	var cnt int
 	var batch []client.KV
 
 	batchSize := prop.GetInt(tcli.LoadFileOptBatchSize, 1000)
+	skips := prop.GetInt(tcli.LoadFileoptSkipRows, 0)
 	for {
 		rawRec, err := r.Read()
 		if err != nil {
@@ -59,6 +63,13 @@ func (c LoadCsvCmd) processCSV(prop *properties.Properties, rc io.Reader, keyPre
 			}
 			return err
 		}
+		if skips > 0 {
+			skips--
+			continue
+		}
+		if len(rawRec) != 2 {
+			return fmt.Errorf("invalid csv record: %v, format should be: <key>,<value>", rawRec)
+		}
 		k, _ := utils.GetStringLit(rawRec[0])
 		v, _ := utils.GetStringLit(rawRec[1])
 		cnt++
@@ -74,7 +85,6 @@ func (c LoadCsvCmd) processCSV(prop *properties.Properties, rc io.Reader, keyPre
 			K: key,
 			V: v,
 		})
-
 		if len(batch) == batchSize {
 			// do insert
 			err := client.GetTiKVClient().BatchPut(context.TODO(), batch)

kvcmds/cmd_scan.go

@@ -31,10 +31,18 @@ Options:
 	--strict-prefix=<true|false>, default false
 	--count-only=<true|false>, default false
 Examples:
+	# scan from "a", max 10 keys
 	scan "a" --limit=10
+
+	# scan from "a", max 10 keys, output key-only
 	scan "a" --limit=10 --key-only=true
+
+	# scan from "a", max 10 keys, output key-only, the result keys are strictly prefix
 	scan "a" --limit=10 --strict-prefix
+
+	# scan from "a", count the number of keys, max 10 keys
 	scan "a" --limit=10 --count-only
+
 	scan "a" --limit=10 --strict-prefix --key-only=true
 	scan $head --limit=10 --key-only=true
 `