Skip to content

📝 Legacy docs review: SQL/PostgreSQL transport design + peek batch size deprecation#8379

Merged
mauroservienti merged 5 commits into
masterfrom
docs-review-sql-transport-design
Jul 3, 2026
Merged

📝 Legacy docs review: SQL/PostgreSQL transport design + peek batch size deprecation#8379
mauroservienti merged 5 commits into
masterfrom
docs-review-sql-transport-design

Conversation

@ramonsmits

@ramonsmits ramonsmits commented Jun 29, 2026

Copy link
Copy Markdown
Member

Legacy documentation review of SQL Transport Design, extended to cover the PostgreSQL transport and the related upgrade guide as the docs side of the MaxRecordsToPeek / peekBatchSize deprecation (Particular/NServiceBus.SqlServer#1754).

SQL design page

  • reviewed date; grammar fixes in the concurrency partial.
  • Correctness: RowVersion index is non-clustered on a heap, not clustered (since 6.0.1); peek estimates pending count via a RowVersion range, not a select count query (since 6.1.1).
  • Removed the non-functional peek batch size config section + orphaned SqlTransport_6/7/8/9 snippets (MaxRecordsToPeek is a no-op).
  • Cross-linked the non-clustered index note to the existing non-clustered index upgrade guide.

PostgreSQL design page (parity)

  • Removed the identical no-op peek batch size config section + orphaned PostgreSqlTransport_8/9 snippets; aligned the receive-tasks wording and the rejected sub-100ms delay; bumped reviewed.

Upgrade guide

  • sqlserver-9to10: documented that the queue peek batch size (MaxRecordsToPeek / peekBatchSize) has no effect, is deprecated, and should be removed.

Verification

  • docstool test --no-version-check passes; affected snippet projects compile.

Pairs with code deprecation:

- Update reviewed date
- Fix grammar in concurrency partial: "greater then" → "greater than", "there is has been" → "there have been", align "receive tasks" terminology
- RowVersion index is non-clustered on a heap, not clustered (since 6.0.1)
- Peek estimates pending count via RowVersion range, not a select count query (since 6.1.1)
- Remove non-functional peek batch size config: MaxRecordsToPeek is a no-op in the SQL Server transport (assigned but never read; API is [PreObsolete]). Removes the doc section and the orphaned snippet from SqlTransport_6/7/8/9
- Clarify that a sub-100ms peek delay is rejected, not merely discouraged
- PostgreSQL design page: remove the no-op peek batch size config section
  (parallel to SQL); align receive-tasks wording and the rejected sub-100ms
  delay; bump reviewed date. Remove the orphaned postgresql-queue-peeker-config-batch-size
  snippet from PostgreSqlTransport_8/9
- sqlserver-9to10 upgrade guide: document that the queue peek batch size
  (MaxRecordsToPeek / peekBatchSize) has no effect, is deprecated, and should be removed
- SQL design page: cross-link the non-clustered index note to the existing
  non-clustered index upgrade guide
@ramonsmits ramonsmits changed the title 📝 Legacy docs review: SQL Transport Design 📝 Legacy docs review: SQL/PostgreSQL transport design + peek batch size deprecation Jun 29, 2026
Warning in the next Version 9 minor; obsolete compilation error in Version 10.
In Version 9 it produces both a compile-time warning and a runtime log warning; in Version 10 it becomes a compilation error.
@mauroservienti mauroservienti marked this pull request as ready for review July 3, 2026 12:49
@mauroservienti mauroservienti merged commit 5dde0bd into master Jul 3, 2026
4 checks passed
@mauroservienti mauroservienti deleted the docs-review-sql-transport-design branch July 3, 2026 12:50
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.

2 participants