-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
eval_context.go
96 lines (82 loc) · 3.45 KB
/
eval_context.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Copyright 2017 The Cockroach Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.
package batcheval
import (
"context"
"fmt"
"github.com/cockroachdb/cockroach/pkg/internal/client"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/settings/cluster"
"github.com/cockroachdb/cockroach/pkg/storage/abortspan"
"github.com/cockroachdb/cockroach/pkg/storage/engine"
"github.com/cockroachdb/cockroach/pkg/storage/engine/enginepb"
"github.com/cockroachdb/cockroach/pkg/storage/storagebase"
"github.com/cockroachdb/cockroach/pkg/storage/txnwait"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/limit"
"github.com/cockroachdb/cockroach/pkg/util/uuid"
opentracing "github.com/opentracing/opentracing-go"
"golang.org/x/time/rate"
)
// Limiters is the collection of per-store limits used during cmd evaluation.
type Limiters struct {
BulkIOWriteRate *rate.Limiter
ConcurrentImports limit.ConcurrentRequestLimiter
ConcurrentExports limit.ConcurrentRequestLimiter
}
// EvalContext is the interface through which command evaluation accesses the
// underlying state.
type EvalContext interface {
fmt.Stringer
ClusterSettings() *cluster.Settings
EvalKnobs() storagebase.BatchEvalTestingKnobs
// TODO(tschottdorf): available through ClusterSettings().
Tracer() opentracing.Tracer
Engine() engine.Engine
Clock() *hlc.Clock
DB() *client.DB
AbortSpan() *abortspan.AbortSpan
GetTxnWaitQueue() *txnwait.Queue
GetLimiters() *Limiters
NodeID() roachpb.NodeID
StoreID() roachpb.StoreID
GetRangeID() roachpb.RangeID
IsFirstRange() bool
GetFirstIndex() (uint64, error)
GetTerm(uint64) (uint64, error)
GetLeaseAppliedIndex() uint64
Desc() *roachpb.RangeDescriptor
ContainsKey(key roachpb.Key) bool
// GetMVCCStats returns a snapshot of the MVCC stats for the range.
// If called from a command that declares a read/write span on the
// entire range, the stats will be consistent with the data that is
// visible to the batch. Otherwise, it may return inconsistent
// results due to concurrent writes.
GetMVCCStats() enginepb.MVCCStats
// GetSplitQPS returns the queries/s request rate for this range.
// NOTE: This should not be used when the load based splitting cluster
// setting is disabled.
GetSplitQPS() float64
// GetTxnTombstoneFromTimestampCache returns the tombstone timestamp for the
// provided transaction, along with an associated txnID marker. If the txnID
// is not empty then the tombstone was explicitly set by an EndTxn req. If
// it is empty then the tombstone is an implicit artifact of the timestamp
// cache's low-water mark. Either way, transactions should not write records
// at or below this timestamp.
GetTxnTombstoneFromTimestampCache(*roachpb.Transaction) (hlc.Timestamp, uuid.UUID)
GetGCThreshold() hlc.Timestamp
GetTxnSpanGCThreshold() hlc.Timestamp
GetLastReplicaGCTimestamp(context.Context) (hlc.Timestamp, error)
GetLease() (roachpb.Lease, roachpb.Lease)
}