Skip to content

docs: note Result Reuse semantic-equivalence behavior change (2025-11)#714

Merged
laughingman7743 merged 2 commits into
masterfrom
docs/result-reuse-semantic-equivalence
May 24, 2026
Merged

docs: note Result Reuse semantic-equivalence behavior change (2025-11)#714
laughingman7743 merged 2 commits into
masterfrom
docs/result-reuse-semantic-equivalence

Conversation

@laughingman7743
Copy link
Copy Markdown
Member

@laughingman7743 laughingman7743 commented May 24, 2026

WHAT

  1. Add a note in the Result reuse configuration section of docs/usage.md describing the November 2025 Athena server-side change: result reuse is now triggered by semantic equivalence of queries rather than exact-string match.
  2. Add paths-ignore to .github/workflows/test.yaml so the full test matrix (Python 3.10-3.14 × pyathena/sqla/sqla_async, against real Athena) is skipped for docs-only PRs.

WHY

  • Docs change: users relying on result_reuse_enable may observe more cache hits than before (whitespace/comment/casing differences no longer block reuse). PyAthena code is unaffected, but the behavior change should be documented so users understand what they're seeing.
  • CI change: tests take a long time and don't cover any code path exercised by docs-only changes. Branch protection has no required status check contexts, so skipping is safe. The weekly cron schedule continues to run tests against master.

Closes #711

Athena changed Result Reuse in November 2025 to match queries by
semantic equivalence instead of exact string. Add a note in the
Result reuse configuration section so users understand the
server-side behavior change.

Refs #711
Test suite takes a long time to run across the Python 3.10-3.14 matrix
and against real Athena. Docs-only changes don't exercise any code path
the tests cover, so skip the workflow when the diff is limited to
`docs/**` or top-level Markdown files.

The weekly cron schedule keeps tests running against master regardless.
@laughingman7743 laughingman7743 marked this pull request as ready for review May 24, 2026 05:20
@laughingman7743 laughingman7743 merged commit b2e16dd into master May 24, 2026
16 checks passed
@laughingman7743 laughingman7743 deleted the docs/result-reuse-semantic-equivalence branch May 24, 2026 05:20
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.

Document Result Reuse semantic-equivalence behavior change (2025-11)

1 participant