Skip to content

Deprecate no-op queue peek batch size (MaxRecordsToPeek / peekBatchSize)#1755

Merged
ramonsmits merged 1 commit into
masterfrom
deprecate-peek-batch-size
Jul 3, 2026
Merged

Deprecate no-op queue peek batch size (MaxRecordsToPeek / peekBatchSize)#1755
ramonsmits merged 1 commit into
masterfrom
deprecate-peek-batch-size

Conversation

@ramonsmits

Copy link
Copy Markdown
Member

Resolves #1754.

Marks MaxRecordsToPeek (and the legacy QueuePeekerOptions peekBatchSize argument) [PreObsolete] and logs a warning when set, stating the API has no effect. Applies to the SQL Server and PostgreSQL transports.

The peek batch size has no effect: the peek query was changed to a RowVersion/seq
range estimate, and the receive loop is bounded by the configured message
processing concurrency and self-terminates on the first empty receive, so a peek
batch bound is unnecessary. It has had no effect in the SQL Server transport since
6.2 (#631); the PostgreSQL transport (introduced in 9.0) has never used it.

- Obsolete QueuePeekerOptions.MaxRecordsToPeek via [ObsoleteMetadata] +
  [Obsolete] (compile-time warning now, error from version 10, removed in 11),
  for SQL Server + PostgreSQL
- Log a runtime warning when the property (or the legacy QueuePeekerOptions
  peekBatchSize argument) is set
- Suppress the obsolete warning at the internal legacy-API assignment
- Drop the unit test assertions that depended on the no-op value; update API approvals

Resolves #1754
@ramonsmits ramonsmits force-pushed the deprecate-peek-batch-size branch from b5b4ae0 to a9ed8fc Compare June 29, 2026 13:57
@ramonsmits ramonsmits marked this pull request as ready for review July 3, 2026 12:53
@ramonsmits ramonsmits merged commit 8d1ea82 into master Jul 3, 2026
4 checks passed
@ramonsmits ramonsmits deleted the deprecate-peek-batch-size branch July 3, 2026 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove the no-op queue peek batch size (MaxRecordsToPeek / peekBatchSize)

2 participants