Skip to content

GH-4551: Add foreign key index recommendations to schema appendix#5419

Open
won-seoop wants to merge 1 commit into
spring-projects:mainfrom
won-seoop:GH-4551-doc-indexing-fk
Open

GH-4551: Add foreign key index recommendations to schema appendix#5419
won-seoop wants to merge 1 commit into
spring-projects:mainfrom
won-seoop:GH-4551-doc-indexing-fk

Conversation

@won-seoop

Copy link
Copy Markdown
Contributor

What

Closes #4551.

Extends the Recommendations for Indexing Metadata Tables section in schema-appendix.adoc with a new Foreign Key Columns subsection.

Changes

The existing table lists WHERE-clause columns as indexing candidates but does not mention foreign key columns. On databases that do not automatically create indexes for FK columns (notably PostgreSQL, as mentioned in the issue), this leads to unindexed FK lookups on the frequent JOIN queries that Spring Batch issues via its DAO layer.

New subsection includes:

  • A table listing each FK column in the five related metadata tables
  • A NOTE explaining which databases create FK indexes automatically (MySQL, Oracle) vs which do not (PostgreSQL)
  • A link to the PostgreSQL unindexed FK detection query referenced in the issue

Test plan

  • Review the rendered AsciiDoc to verify the new table and NOTE block render correctly.

🤖 Generated with Claude Code

…ma appendix

Expands the "Recommendations for Indexing Metadata Tables" section with
a new "Foreign Key Columns" subsection that lists the FK columns in each
Spring Batch metadata table as candidates for additional indexes.

The issue points out that the existing recommendations only covered
WHERE-clause columns while omitting FK columns. On databases like
PostgreSQL that do not automatically index FK columns (unlike MySQL or
Oracle), unindexed FK columns cause performance problems on the frequent
JOIN queries issued by Spring Batch's DAO layer.

Also adds a NOTE directing users to their database's documentation for
detecting unindexed foreign keys, with a link to the PostgreSQL query
referenced in the issue.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

Improve recommendations for indexing metadata tables

1 participant