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

Whitea029 · 2025-06-01T01:03:13Z

What problem does this PR solve?

This PR addresses the enhancement suggestion regarding repetitive patterns when using DrainRecordSet. Previously, callers needed to manually defer the closing of the RecordSet after execution, which introduced boilerplate and risked forgetting to close the resource.

Issue Number: close #61408

Problem Summary:

What changed and how does it work?

This change introduces a new utility function DrainRecordSetAndClose, which automatically drains and closes the RecordSet, simplifying the common usage pattern and improving code readability and safety. Existing code that follows the defer Close() pattern can now be replaced with a single call to this new function.

Check List

Tests

Unit test
Integration test

Side effects

Performance regression: Consumes more CPU
Performance regression: Consumes more Memory
Breaking backward compatibility

Documentation

Release note

Add DrainRecordSetAndClose to simplify draining and closing RecordSet, reducing boilerplate and preventing resource leaks.

sre-bot · 2025-06-01T01:03:20Z

All committers have signed the CLA.

ti-chi-bot · 2025-06-01T01:03:22Z

Welcome @Whitea029!

It looks like this is your first PR to pingcap/tidb 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to pingcap/tidb. 😃

ti-chi-bot · 2025-06-01T01:03:22Z

Hi @Whitea029. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

tiprow · 2025-06-01T01:03:31Z

Hi @Whitea029. Thanks for your PR.

PRs from untrusted users cannot be marked as trusted with /ok-to-test in this repo meaning untrusted PR authors can never trigger tests themselves. Collaborators can still trigger tests on the PR using /test all.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

lance6716 · 2025-06-01T07:38:59Z

/ok-to-test

codecov · 2025-06-01T08:21:59Z

Codecov Report

Attention: Patch coverage is 70.58824% with 5 lines in your changes missing coverage. Please review.

Project coverage is 73.5759%. Comparing base (e7b038b) to head (63f8476).
Report is 4 commits behind head on master.

Additional details and impacted files

@@               Coverage Diff                @@
##             master     #61448        +/-   ##
================================================
+ Coverage   73.1839%   73.5759%   +0.3919%     
================================================
  Files          1727       1729         +2     
  Lines        479899     482284      +2385     
================================================
+ Hits         351209     354845      +3636     
+ Misses       107194     105969      -1225     
+ Partials      21496      21470        -26

Flag	Coverage Δ
integration	`42.3318% <70.5882%> (?)`
unit	`72.4473% <47.0588%> (+0.0176%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
dumpling	`52.7804% <ø> (ø)`
parser	`∅ <ø> (∅)`
br	`47.3136% <ø> (-0.1594%)`	⬇️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Whitea029 · 2025-06-01T08:58:29Z

/retest

lance6716 · 2025-06-01T11:29:37Z

/cc @YangKeao

ti-chi-bot · 2025-06-02T03:15:34Z

[LGTM Timeline notifier]

Timeline:

2025-06-01 11:29:37.829102595 +0000 UTC m=+182064.031447893: ☑️ agreed by lance6716.
2025-06-02 03:15:33.327956166 +0000 UTC m=+238819.530301431: ☑️ agreed by hawkingrei.

hawkingrei · 2025-06-02T03:15:43Z

/hold

@YangKeao PTAL

YangKeao

LGTM

ti-chi-bot · 2025-06-03T03:01:13Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hawkingrei, lance6716, YangKeao

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [YangKeao,hawkingrei,lance6716]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

lance6716 · 2025-06-03T03:05:01Z

/unhold

hawkingrei · 2025-06-03T03:50:18Z

/retest

Whitea029 · 2025-06-03T05:10:42Z

/test check-dev

tiprow · 2025-06-03T05:11:04Z

@Whitea029: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test fast_test_tiprow
/test tidb_parser_test

Use /test all to run all jobs.

In response to this:

/test check-dev

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Whitea029 · 2025-06-03T05:12:46Z

/retest

lance6716 · 2025-06-03T06:50:54Z

/retest

ti-chi-bot bot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Jun 1, 2025

ti-chi-bot bot added needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 1, 2025

ti-chi-bot bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Jun 1, 2025

This comment was marked as resolved.

Sign in to view

opt: add a function to let DrainRecordSet also close the RecordSet

63f8476

Whitea029 force-pushed the opt-func-drainrecordset branch from 2bddf07 to 63f8476 Compare June 1, 2025 08:57

lance6716 approved these changes Jun 1, 2025

View reviewed changes

ti-chi-bot bot added the approved label Jun 1, 2025

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 1, 2025

ti-chi-bot bot requested a review from YangKeao June 1, 2025 11:29

hawkingrei approved these changes Jun 2, 2025

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jun 2, 2025

ti-chi-bot bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 2, 2025

YangKeao approved these changes Jun 3, 2025

View reviewed changes

ti-chi-bot bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 3, 2025

ti-chi-bot bot merged commit 609805c into pingcap:master Jun 3, 2025
24 checks passed

Whitea029 deleted the opt-func-drainrecordset branch June 3, 2025 10:08

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

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

Uh oh!

Conversation

Whitea029 commented Jun 1, 2025

What problem does this PR solve?

What changed and how does it work?

Check List

Release note

Uh oh!

sre-bot commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ti-chi-bot bot commented Jun 1, 2025

Uh oh!

ti-chi-bot bot commented Jun 1, 2025

Uh oh!

tiprow bot commented Jun 1, 2025

Uh oh!

lance6716 commented Jun 1, 2025

Uh oh!

This comment was marked as resolved.

codecov bot commented Jun 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Whitea029 commented Jun 1, 2025

Uh oh!

lance6716 commented Jun 1, 2025

Uh oh!

ti-chi-bot bot commented Jun 2, 2025

[LGTM Timeline notifier]

Uh oh!

hawkingrei commented Jun 2, 2025

Uh oh!

YangKeao left a comment

Choose a reason for hiding this comment

Uh oh!

ti-chi-bot bot commented Jun 3, 2025

Uh oh!

lance6716 commented Jun 3, 2025

Uh oh!

hawkingrei commented Jun 3, 2025

Uh oh!

Whitea029 commented Jun 3, 2025

Uh oh!

tiprow bot commented Jun 3, 2025

Uh oh!

Whitea029 commented Jun 3, 2025

Uh oh!

lance6716 commented Jun 3, 2025

Uh oh!

Uh oh!

Uh oh!

sre-bot commented Jun 1, 2025 •

edited

Loading

codecov bot commented Jun 1, 2025 •

edited

Loading