SqlBatchCommand support CommandBehavior

[campersau]

Description

#1825 added the Batch APIs and also added a CommandBehavior property to SqlBatchCommand which was completly unused.
Note: SqlBatchCommand.CommandBehavior is a custom property in SqlClient which isn't in the DbBatchCommand

Also the CommandBehavior for ExecuteReader was ignored.

This PR enables the use of the SqlBatchCommand.CommandBehavior and also supports passing CommandBehavior to ExecuteReader.

Issues

Fixes #4083

Testing

Added tests for passing CommandBehavior.SchemaOnly | CommandBehavior.KeyInfo to SqlBatchCommand.CommandBehavior.
Added tests for passing CommandBehavior.CloseConnection to ExecuteReader.

[cheenamalhotra]

LGTM

[cheenamalhotra]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[codecov]

Codecov Report

❌ Patch coverage is 90.62500% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 64.74%. Comparing base (c724554) to head (2ff5fe5).
⚠️ Report is 9 commits behind head on main.

Files with missing lines	Patch %	Lines
...SqlClient/src/Microsoft/Data/SqlClient/SqlBatch.cs	88.46%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4125      +/-   ##
==========================================
- Coverage   66.57%   64.74%   -1.83%     
==========================================
  Files         284      279       -5     
  Lines       43301    66225   +22924     
==========================================
+ Hits        28827    42879   +14052     
- Misses      14474    23346    +8872     

Flag	Coverage Δ
CI-SqlClient	?
PR-SqlClient-Project	64.74% <90.62%> (?)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[mdaigle]

Overall, I have some concerns about existing behavior that we have copied over without explanation and I would like to remove any unnecessary refactors.

[mdaigle]

Thank you for making those changes. I'll do another review pass on Monday.

[mdaigle]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[mdaigle]

I'm trying to think through the best way to expose things on SqlBatchCommand. It already accepts a CommandBehavior, and this PR now pipes that through. But certain behaviors are not meaningful. SingleResult, SingleRow, SequentialAccess, and CloseConnection all only apply at the top level (SqlBatch). I'm thinking we should add some validation to SqlBatchCommand that limits the CommandBehavior values we can pass in, or add some explanation to the public docs that most options will be no-ops.

[campersau]

Throwing exceptions is a breaking change, but not sure if somebody used it. So I am fine either way (validation or doc or both).

[mdaigle]

Those changes look good. Let's note the restriction in a doc comment.

[campersau]

I updated the doc comments.

[mdaigle]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[mdaigle]

@cheenamalhotra this is ready for another review

[cheenamalhotra]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[cheenamalhotra]

Mentioning @Wraith2 if he's interesting in reviewing too as the primary contributor of SqlBatch support in the driver :)