docs: ORM-first README, refreshed setup docs, 1 MB result limit#176
Merged
Conversation
…nt the 1 MB result limit - Lead the intro with the ORM/query-builder compatibility layers, then raw SQL, then the built-in transactions + retry logic - Add a What's New section for v2.4 (Prisma support) and move v2.3 (Knex) into the changelog - Replace the outdated Enabling Data API walkthrough (2019 screenshots, old console flow) with links to the current AWS docs; keep the Required Permissions and drop the deprecated rds-data:ExecuteSql action this SDK v3 client never calls - Document the ~1 MB per-statement result limit and that the Data API has no server-side pagination, with guidance to use keyset pagination (ORM layers already handle it) - Remove a 2018 blog link, fix past-tense version references, and clear out em-dash-heavy phrasing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only changes ahead of the v2.4 release (which adds the Prisma compat layer). No code changes.
mysql2,pg, Knex, Prisma), then raw SQL, then the built-in transactions and scale-to-zero retry. The compatibility story is the main reason to reach for this library, so it goes first.rds-data:ExecuteSql, the deprecated v1 action this SDK v3 client never calls.Test plan