📝 docs(schema): add namespace-prefixed keys migration guide (#371)#391
Merged
Conversation
Add a step-by-step guide for migrating existing deployments from bare DynamoDB keys to namespace-prefixed keys introduced in v0.10.0. Includes a complete Python migration script, cost estimates, rollback procedures, and a critical warning about the archiver Lambda crash on unprefixed PKs. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sodre
added
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #391 +/- ##
==========================================
+ Coverage 91.84% 91.87% +0.02%
==========================================
Files 33 33
Lines 7435 7435
==========================================
+ Hits 6829 6831 +2
+ Misses 606 604 -2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Mark code blocks that require a deployed stack (namespace registry, namespace resolution) as lint-only so the doctest runner skips execution while still linting syntax. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Pre-create "my-app" table with registered default namespace in doctest_globals so the migration guide examples run against moto. Set sys.argv with migration script args so argparse succeeds. Also register "default" namespace in _auto_create_ensure for any table created by doc examples. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
⚠️ Performance Alert ⚠️
Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.40.
| Benchmark suite | Current: 3164a9b | Previous: 4e0dc4f | Ratio |
|---|---|---|---|
tests/benchmark/test_operations.py::TestCascadeOverheadBenchmarks::test_cascade_with_stored_limits |
130.68301711387937 iter/sec (stddev: 0.01659655063959443) |
184.4799256546788 iter/sec (stddev: 0.00011647925339987844) |
1.41 |
This comment was automatically generated by workflow using github-action-benchmark.
Explain that GSI4 starts empty after backfill because existing items lack GSI4PK, and note the table enters UPDATING state which blocks other schema changes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
mkdocs.ymland a link from the existingdocs/migrations.mdindex pageTest plan
uv run mkdocs build --strictpasses with no errors for the new pageuv run pytest tests/doctest/test_docs_run.py -k "namespace-keys" -v -o "addopts="— all 4 Python examples execute successfully (not skipped)uv run pytest tests/doctest/test_docs_run.py -v -o "addopts="— full doctest suite passes (148 passed, 32 skipped, 0 failed)docs/migrations/namespace-keys.mdrenders correctly withuv run mkdocs serve --livereload --dirtydocs/migrations.mdresolves correctlyCloses #371
🤖 Generated with Claude Code