The GitHub Actions job "Run Tests with Pekko 1.x builds" on 
pekko-persistence-cassandra.git/main has failed.
Run started by GitHub user pjfanning (triggered by pjfanning).

Head commit for run:
2a83887d4d26314ecc07fe6def46aa941ed39b08 / PJ Fanning 
<[email protected]>
document the Cassandra driver page size (#489)

Motivation:
The driver's page size is the setting that controls how many rows a query
retrieves per round-trip, and it is the correct lever for tuning reads
that return many rows. It was not mentioned anywhere in the documentation,
which makes it easy to reach for a CQL `LIMIT` instead. A `LIMIT` caps the
total rows a query returns and would silently truncate results rather than
page them.

Modification:
Add a "Page size" subsection under "Cassandra driver configuration" in
docs/configuration.md covering the driver default of 5000, how to set it
globally, and how to set it per execution profile. Both profiles the
plugin uses are named: `pekko-persistence-cassandra-profile` for the
journal and query parts, `pekko-persistence-cassandra-snapshot-profile`
for the snapshot store.

The section also states what the setting does not do: it bounds the rows
in flight per round-trip, not the total an operation retains, so it does
not by itself cap the memory of a query whose whole result is collected
before it is acted on.

Result:
The page size is discoverable from the configuration documentation, with
the correct profile names and without overstating what it bounds.

Tests:
- Not run - docs only
- sbt docs/paradox - builds, section renders and existing extref links
  resolve

References:
None - documents an existing Cassandra driver setting

Report URL: 
https://github.com/apache/pekko-persistence-cassandra/actions/runs/33350050462

With regards,
GitHub Actions via GitBox


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to