Skip to content

executor, sqlexec: add a function to let DrainRecordSet also close the RecordSet #61448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2025
Merged

executor, sqlexec: add a function to let DrainRecordSet also close the RecordSet #61448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 10 additions & 60 deletions pkg/executor/simple.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -962,12 +962,7 @@ func readPasswordLockingInfo(ctx context.Context, sqlExecutor sqlexec.SQLExecuto
if err != nil {
return nil, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, 3)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, 3)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -1320,12 +1315,7 @@ func isRole(ctx context.Context, sqlExecutor sqlexec.SQLExecutor, name, host str
if err != nil {
return false, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, 1)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, 1)
if err != nil {
return false, err
}
Expand All @@ -1342,12 +1332,7 @@ func getUserPasswordLimit(ctx context.Context, sqlExecutor sqlexec.SQLExecutor,
if err != nil {
return nil, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, 3)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, 3)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -1464,12 +1449,7 @@ func getUserPasswordNum(ctx context.Context, sqlExecutor sqlexec.SQLExecutor, us
if err != nil {
return 0, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, 3)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, 3)
if err != nil {
return 0, err
}
Expand All @@ -1490,12 +1470,7 @@ func fullRecordCheck(ctx context.Context, sqlExecutor sqlexec.SQLExecutor, userD
if err != nil {
return false, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, 3)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, 3)
if err != nil {
return false, err
}
Expand All @@ -1510,12 +1485,7 @@ func fullRecordCheck(ctx context.Context, sqlExecutor sqlexec.SQLExecutor, userD
if err != nil {
return false, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, vardef.DefMaxChunkSize)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, vardef.DefMaxChunkSize)
if err != nil {
return false, err
}
Expand All @@ -1538,12 +1508,7 @@ func checkPasswordHistoryRule(ctx context.Context, sqlExecutor sqlexec.SQLExecut
if err != nil {
return false, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, 3)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, 3)
if err != nil {
return false, err
}
Expand All @@ -1560,12 +1525,7 @@ func checkPasswordHistoryRule(ctx context.Context, sqlExecutor sqlexec.SQLExecut
if err != nil {
return false, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, vardef.DefMaxChunkSize)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, vardef.DefMaxChunkSize)
if err != nil {
return false, err
}
Expand All @@ -1587,12 +1547,7 @@ func checkPasswordTimeRule(ctx context.Context, sqlExecutor sqlexec.SQLExecutor,
if err != nil {
return false, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, 3)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, 3)
if err != nil {
return false, err
}
Expand All @@ -1606,12 +1561,7 @@ func checkPasswordTimeRule(ctx context.Context, sqlExecutor sqlexec.SQLExecutor,
if err != nil {
return false, err
}
defer func() {
if closeErr := recordSet.Close(); closeErr != nil {
err = closeErr
}
}()
rows, err := sqlexec.DrainRecordSet(ctx, recordSet, vardef.DefMaxChunkSize)
rows, err := sqlexec.DrainRecordSetAndClose(ctx, recordSet, vardef.DefMaxChunkSize)
if err != nil {
return false, err
}
Expand Down
2 changes: 2 additions & 0 deletions pkg/util/sqlexec/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ go_library(
"//pkg/sessionctx/variable",
"//pkg/types",
"//pkg/util/chunk",
"//pkg/util/logutil",
"@org_uber_go_zap//:zap",
],
)

Expand Down
14 changes: 14 additions & 0 deletions pkg/util/sqlexec/restricted_sql_executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import (
"github.com/pingcap/tidb/pkg/sessionctx/sysproctrack"
"github.com/pingcap/tidb/pkg/sessionctx/variable"
"github.com/pingcap/tidb/pkg/util/chunk"
"github.com/pingcap/tidb/pkg/util/logutil"
"go.uber.org/zap"
)

// RestrictedSQLExecutor is an interface provides executing restricted sql statement.
Expand Down Expand Up @@ -250,6 +252,18 @@ func DrainRecordSet(ctx context.Context, rs RecordSet, maxChunkSize int) ([]chun
}
}

// DrainRecordSetAndClose fetches the rows in the RecordSet and closes it.
func DrainRecordSetAndClose(ctx context.Context, rs RecordSet, maxChunkSize int) ([]chunk.Row, error) {
defer func() {
if closeErr := rs.Close(); closeErr != nil {
// Log the close error but don't override the main error
logutil.BgLogger().Error("failed to close recordSet in DrainRecordSetAndClose", zap.Error(closeErr))
}
}()

return DrainRecordSet(ctx, rs, maxChunkSize)
}

// ExecSQL executes the sql and returns the result.
// TODO: consider retry.
func ExecSQL(ctx context.Context, exec SQLExecutor, sql string, args ...any) ([]chunk.Row, error) {
Expand Down