*: rename "GetDDLJob" to "GetDDLJobByIdx" (pingcap#7129)

zjsxwc · Jul 25, 2018 · 8b913c9 · 8b913c9
1 parent dd99148
commit 8b913c9
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 10 deletions.
diff --git a/ddl/ddl_worker.go b/ddl/ddl_worker.go
@@ -224,7 +224,7 @@ func (d *ddl) getHistoryDDLJob(id int64) (*model.Job, error) {
 
 // getFirstDDLJob gets the first DDL job form DDL queue.
 func (w *worker) getFirstDDLJob(t *meta.Meta) (*model.Job, error) {
-	job, err := t.GetDDLJob(0)
+	job, err := t.GetDDLJobByIdx(0)
 	return job, errors.Trace(err)
 }
 

diff --git a/ddl/schema_test.go b/ddl/schema_test.go
@@ -86,7 +86,7 @@ func testDropSchema(c *C, ctx sessionctx.Context, d *ddl, dbInfo *model.DBInfo)
 }
 
 func isDDLJobDone(c *C, t *meta.Meta) bool {
-	job, err := t.GetDDLJob(0)
+	job, err := t.GetDDLJobByIdx(0)
 	c.Assert(err, IsNil)
 	if job == nil {
 		return true

diff --git a/meta/meta.go b/meta/meta.go
@@ -507,19 +507,19 @@ func (m *Meta) getDDLJob(key []byte, index int64) (*model.Job, error) {
 	return job, errors.Trace(err)
 }
 
-// GetDDLJob returns the DDL job with index.
+// GetDDLJobByIdx returns the corresponding DDL job by the index.
 // The length of jobListKeys can only be 1 or 0.
 // If its length is 1, we need to replace m.jobListKey with jobListKeys[0].
 // Otherwise, we use m.jobListKey directly.
-func (m *Meta) GetDDLJob(index int64, jobListKeys ...JobListKeyType) (*model.Job, error) {
+func (m *Meta) GetDDLJobByIdx(index int64, jobListKeys ...JobListKeyType) (*model.Job, error) {
 	listKey := m.jobListKey
 	if len(jobListKeys) != 0 {
 		listKey = jobListKeys[0]
 	}
 
 	startTime := time.Now()
 	job, err := m.getDDLJob(listKey, index)
-	metrics.MetaHistogram.WithLabelValues(metrics.GetDDLJob, metrics.RetLabel(err)).Observe(time.Since(startTime).Seconds())
+	metrics.MetaHistogram.WithLabelValues(metrics.GetDDLJobByIdx, metrics.RetLabel(err)).Observe(time.Since(startTime).Seconds())
 	return job, errors.Trace(err)
 }
 

diff --git a/meta/meta_test.go b/meta/meta_test.go
@@ -273,10 +273,10 @@ func (s *testSuite) TestDDL(c *C) {
 	c.Assert(err, IsNil)
 	c.Assert(n, Equals, int64(1))
 
-	v, err := t.GetDDLJob(0)
+	v, err := t.GetDDLJobByIdx(0)
 	c.Assert(err, IsNil)
 	c.Assert(v, DeepEquals, job)
-	v, err = t.GetDDLJob(1)
+	v, err = t.GetDDLJobByIdx(1)
 	c.Assert(err, IsNil)
 	c.Assert(v, IsNil)
 	job.ID = 2

diff --git a/metrics/meta.go b/metrics/meta.go
@@ -33,7 +33,7 @@ var (
 
 	GetSchemaDiff    = "get_schema_diff"
 	SetSchemaDiff    = "set_schema_diff"
-	GetDDLJob        = "get_ddl_job"
+	GetDDLJobByIdx   = "get_ddl_job"
 	UpdateDDLJob     = "update_ddl_job"
 	GetHistoryDDLJob = "get_history_ddl_job"
 

diff --git a/util/admin/admin.go b/util/admin/admin.go
@@ -47,7 +47,7 @@ func GetDDLInfo(txn kv.Transaction) (*DDLInfo, error) {
 	info := &DDLInfo{}
 	t := meta.NewMeta(txn)
 
-	info.Job, err = t.GetDDLJob(0)
+	info.Job, err = t.GetDDLJobByIdx(0)
 	if err != nil {
 		return nil, errors.Trace(err)
 	}
@@ -127,7 +127,7 @@ func getDDLJobsInQueue(t *meta.Meta, jobListKey meta.JobListKeyType) ([]*model.J
 	}
 	jobs := make([]*model.Job, cnt)
 	for i := range jobs {
-		jobs[i], err = t.GetDDLJob(int64(i), jobListKey)
+		jobs[i], err = t.GetDDLJobByIdx(int64(i), jobListKey)
 		if err != nil {
 			return nil, errors.Trace(err)
 		}