Skip to content

Commit bc75ed4

Browse files
committed
sql: remove unnecessary param from helper functions
This commit removes an unused `ClientNoticeSender` parameter from several functions related to formatting virtual table names. Epic: None Release note: None
1 parent 27fa7e6 commit bc75ed4

9 files changed

+27
-35
lines changed

pkg/sql/conn_executor.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -821,7 +821,7 @@ func (s *Server) getScrubbedStmtStats(
821821
}
822822

823823
// Scrub the statement itself.
824-
scrubbedQueryStr, ok := scrubStmtStatKey(s.cfg.VirtualSchemas, stat.Key.Query, nil)
824+
scrubbedQueryStr, ok := scrubStmtStatKey(s.cfg.VirtualSchemas, stat.Key.Query)
825825

826826
// We don't want to report this stats if scrubbing has failed. We also don't
827827
// wish to abort here because we want to try our best to report all the
@@ -1339,7 +1339,7 @@ func (ex *connExecutor) closeWrapper(ctx context.Context, recovered interface{})
13391339
// Embed the statement in the error object for the telemetry
13401340
// report below. The statement gets anonymized.
13411341
vt := ex.planner.extendedEvalCtx.VirtualSchemas
1342-
panicErr = WithAnonymizedStatement(panicErr, ex.curStmtAST, vt, nil)
1342+
panicErr = WithAnonymizedStatement(panicErr, ex.curStmtAST, vt)
13431343
}
13441344

13451345
// Report the panic to telemetry in any case.

pkg/sql/conn_executor_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ INSERT INTO sensitive(super, sensible) VALUES('that', 'nobody', 'must', 'see')
8989
}
9090

9191
rUnsafe := errors.New("some error")
92-
safeErr := sql.WithAnonymizedStatement(rUnsafe, stmt1.AST, vt, nil /* ClientNoticeSender */)
92+
safeErr := sql.WithAnonymizedStatement(rUnsafe, stmt1.AST, vt)
9393

9494
const expMessage = "some error"
9595
actMessage := safeErr.Error()

pkg/sql/exec_factory_util.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ func constructVirtualScan(
259259
delayedNodeCallback func(*delayedNode) (exec.Node, error),
260260
) (exec.Node, error) {
261261
tn := &table.(*optVirtualTable).name
262-
virtual, err := p.getVirtualTabler().getVirtualTableEntry(tn, p)
262+
virtual, err := p.getVirtualTabler().getVirtualTableEntry(tn)
263263
if err != nil {
264264
return nil, err
265265
}

pkg/sql/exec_util.go

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2780,11 +2780,9 @@ func truncateStatementStringForTelemetry(stmt string) string {
27802780
// hideNonVirtualTableNameFunc returns a function that can be used with
27812781
// FmtCtx.SetReformatTableNames. It hides all table names that are not virtual
27822782
// tables.
2783-
func hideNonVirtualTableNameFunc(
2784-
vt VirtualTabler, ns eval.ClientNoticeSender,
2785-
) func(ctx *tree.FmtCtx, name *tree.TableName) {
2783+
func hideNonVirtualTableNameFunc(vt VirtualTabler) func(ctx *tree.FmtCtx, name *tree.TableName) {
27862784
reformatFn := func(ctx *tree.FmtCtx, tn *tree.TableName) {
2787-
virtual, err := vt.getVirtualTableEntry(tn, ns)
2785+
virtual, err := vt.getVirtualTableEntry(tn)
27882786

27892787
if err != nil || virtual == nil {
27902788
// Current table is non-virtual and therefore needs to be scrubbed (for statement stats) or redacted (for logs).
@@ -2828,16 +2826,14 @@ func hideNonVirtualTableNameFunc(
28282826
return reformatFn
28292827
}
28302828

2831-
func anonymizeStmtAndConstants(
2832-
stmt tree.Statement, vt VirtualTabler, ns eval.ClientNoticeSender,
2833-
) string {
2829+
func anonymizeStmtAndConstants(stmt tree.Statement, vt VirtualTabler) string {
28342830
// Re-format to remove most names.
28352831
fmtFlags := tree.FmtAnonymize | tree.FmtHideConstants
28362832
var f *tree.FmtCtx
28372833
if vt != nil {
28382834
f = tree.NewFmtCtx(
28392835
fmtFlags,
2840-
tree.FmtReformatTableNames(hideNonVirtualTableNameFunc(vt, ns)),
2836+
tree.FmtReformatTableNames(hideNonVirtualTableNameFunc(vt)),
28412837
)
28422838
} else {
28432839
f = tree.NewFmtCtx(fmtFlags)
@@ -2848,10 +2844,8 @@ func anonymizeStmtAndConstants(
28482844

28492845
// WithAnonymizedStatement attaches the anonymized form of a statement
28502846
// to an error object.
2851-
func WithAnonymizedStatement(
2852-
err error, stmt tree.Statement, vt VirtualTabler, ns eval.ClientNoticeSender,
2853-
) error {
2854-
anonStmtStr := anonymizeStmtAndConstants(stmt, vt, ns)
2847+
func WithAnonymizedStatement(err error, stmt tree.Statement, vt VirtualTabler) error {
2848+
anonStmtStr := anonymizeStmtAndConstants(stmt, vt)
28552849
anonStmtStr = truncateStatementStringForTelemetry(anonStmtStr)
28562850
return errors.WithSafeDetails(err,
28572851
"while executing: %s", errors.Safe(anonStmtStr))
@@ -4469,7 +4463,7 @@ func quantizeCounts(d *appstatspb.StatementStatistics) {
44694463
d.FirstAttemptCount = int64((float64(d.FirstAttemptCount) / float64(oldCount)) * float64(newCount))
44704464
}
44714465

4472-
func scrubStmtStatKey(vt VirtualTabler, key string, ns eval.ClientNoticeSender) (string, bool) {
4466+
func scrubStmtStatKey(vt VirtualTabler, key string) (string, bool) {
44734467
// Re-parse the statement to obtain its AST.
44744468
stmt, err := parser.ParseOne(key)
44754469
if err != nil {
@@ -4479,7 +4473,7 @@ func scrubStmtStatKey(vt VirtualTabler, key string, ns eval.ClientNoticeSender)
44794473
// Re-format to remove most names.
44804474
f := tree.NewFmtCtx(
44814475
tree.FmtAnonymize,
4482-
tree.FmtReformatTableNames(hideNonVirtualTableNameFunc(vt, ns)),
4476+
tree.FmtReformatTableNames(hideNonVirtualTableNameFunc(vt)),
44834477
)
44844478
f.FormatNode(stmt.AST)
44854479
return f.CloseAndGetString(), true

pkg/sql/exec_util_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func TestHideNonVirtualTableNameFunc(t *testing.T) {
2727
if err != nil {
2828
t.Fatal(err)
2929
}
30-
tableNameFunc := hideNonVirtualTableNameFunc(vt, nil)
30+
tableNameFunc := hideNonVirtualTableNameFunc(vt)
3131

3232
testData := []struct {
3333
stmt string

pkg/sql/opt_exec_factory.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -808,7 +808,7 @@ func constructVirtualTableLookupJoin(
808808
onCond tree.TypedExpr,
809809
) (planNode, error) {
810810
tn := &table.(*optVirtualTable).name
811-
virtual, err := p.getVirtualTabler().getVirtualTableEntry(tn, p)
811+
virtual, err := p.getVirtualTabler().getVirtualTableEntry(tn)
812812
if err != nil {
813813
return nil, err
814814
}

pkg/sql/pg_catalog.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1660,19 +1660,19 @@ https://www.postgresql.org/docs/9.5/catalog-pg-depend.html`,
16601660
schema: vtable.PGCatalogDepend,
16611661
populate: func(ctx context.Context, p *planner, dbContext catalog.DatabaseDescriptor, addRow func(...tree.Datum) error) error {
16621662
vt := p.getVirtualTabler()
1663-
pgConstraintsDesc, err := vt.getVirtualTableDesc(&pgConstraintsTableName, p)
1663+
pgConstraintsDesc, err := vt.getVirtualTableDesc(&pgConstraintsTableName)
16641664
if err != nil {
16651665
return errors.New("could not find pg_catalog.pg_constraint")
16661666
}
1667-
pgClassDesc, err := vt.getVirtualTableDesc(&pgClassTableName, p)
1667+
pgClassDesc, err := vt.getVirtualTableDesc(&pgClassTableName)
16681668
if err != nil {
16691669
return errors.New("could not find pg_catalog.pg_class")
16701670
}
1671-
pgRewriteDesc, err := vt.getVirtualTableDesc(&pgRewriteTableName, p)
1671+
pgRewriteDesc, err := vt.getVirtualTableDesc(&pgRewriteTableName)
16721672
if err != nil {
16731673
return errors.New("could not find pg_catalog.pg_rewrite")
16741674
}
1675-
pgProcDesc, err := vt.getVirtualTableDesc(&pgProcTableName, p)
1675+
pgProcDesc, err := vt.getVirtualTableDesc(&pgProcTableName)
16761676
if err != nil {
16771677
return errors.New("could not find pg_catalog.pg_proc")
16781678
}
@@ -3157,19 +3157,19 @@ https://www.postgresql.org/docs/9.6/catalog-pg-shdepend.html`,
31573157
vt := p.getVirtualTabler()
31583158
h := makeOidHasher()
31593159

3160-
pgClassDesc, err := vt.getVirtualTableDesc(&pgClassTableName, p)
3160+
pgClassDesc, err := vt.getVirtualTableDesc(&pgClassTableName)
31613161
if err != nil {
31623162
return errors.New("could not find pg_catalog.pg_class")
31633163
}
31643164
pgClassOid := tableOid(pgClassDesc.GetID())
31653165

3166-
pgAuthIDDesc, err := vt.getVirtualTableDesc(&pgAuthIDTableName, p)
3166+
pgAuthIDDesc, err := vt.getVirtualTableDesc(&pgAuthIDTableName)
31673167
if err != nil {
31683168
return errors.New("could not find pg_catalog.pg_authid")
31693169
}
31703170
pgAuthIDOid := tableOid(pgAuthIDDesc.GetID())
31713171

3172-
pgDatabaseDesc, err := vt.getVirtualTableDesc(&pgDatabaseTableName, p)
3172+
pgDatabaseDesc, err := vt.getVirtualTableDesc(&pgDatabaseTableName)
31733173
if err != nil {
31743174
return errors.New("could not find pg_catalog.pg_database")
31753175
}

pkg/sql/statement_mark_redaction_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ func TestMarkRedactionStatement(t *testing.T) {
8484
f := tree.NewFmtCtx(
8585
tree.FmtAlwaysQualifyTableNames|tree.FmtMarkRedactionNode,
8686
tree.FmtAnnotations(&ann),
87-
tree.FmtReformatTableNames(hideNonVirtualTableNameFunc(vt, nil)))
87+
tree.FmtReformatTableNames(hideNonVirtualTableNameFunc(vt)))
8888
f.FormatNode(stmt.AST)
8989
redactedString := f.CloseAndGetString()
9090
require.Equal(t, test.expected, redactedString)

pkg/sql/virtual_schema.go

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1085,9 +1085,7 @@ func (vs *VirtualSchemaHolder) getVirtualSchemaEntry(name string) (*virtualSchem
10851085
// a specific table. It will return an error if the name references a virtual database
10861086
// but the table is non-existent.
10871087
// getVirtualTableEntry is part of the VirtualTabler interface.
1088-
func (vs *VirtualSchemaHolder) getVirtualTableEntry(
1089-
tn *tree.TableName, ns eval.ClientNoticeSender,
1090-
) (*virtualDefEntry, error) {
1088+
func (vs *VirtualSchemaHolder) getVirtualTableEntry(tn *tree.TableName) (*virtualDefEntry, error) {
10911089
if db, ok := vs.getVirtualSchemaEntry(tn.Schema()); ok {
10921090
tableName := tn.Table()
10931091
if t, ok := db.defs[tableName]; ok {
@@ -1110,8 +1108,8 @@ func (vs *VirtualSchemaHolder) getVirtualTableEntry(
11101108

11111109
// VirtualTabler is used to fetch descriptors for virtual tables and databases.
11121110
type VirtualTabler interface {
1113-
getVirtualTableDesc(tn *tree.TableName, ns eval.ClientNoticeSender) (catalog.TableDescriptor, error)
1114-
getVirtualTableEntry(tn *tree.TableName, ns eval.ClientNoticeSender) (*virtualDefEntry, error)
1111+
getVirtualTableDesc(tn *tree.TableName) (catalog.TableDescriptor, error)
1112+
getVirtualTableEntry(tn *tree.TableName) (*virtualDefEntry, error)
11151113
getSchemas() map[string]*virtualSchemaEntry
11161114
getSchemaNames() []string
11171115
}
@@ -1120,9 +1118,9 @@ type VirtualTabler interface {
11201118
// pair, and returns its descriptor if it does.
11211119
// getVirtualTableDesc is part of the VirtualTabler interface.
11221120
func (vs *VirtualSchemaHolder) getVirtualTableDesc(
1123-
tn *tree.TableName, ns eval.ClientNoticeSender,
1121+
tn *tree.TableName,
11241122
) (catalog.TableDescriptor, error) {
1125-
t, err := vs.getVirtualTableEntry(tn, ns)
1123+
t, err := vs.getVirtualTableEntry(tn)
11261124
if err != nil || t == nil {
11271125
return nil, err
11281126
}

0 commit comments

Comments
 (0)