Improved TaskRun environment indexes #2164
Conversation
### PR: Optimize **TaskRun** indexes for hot-path queries **What changed** | Object | Type | Purpose | | ------------------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `taskrun_runtime_id_desc_idx` | **BTREE** `(runtimeEnvironmentId, id DESC) INCLUDE (createdAt)` | Eliminates explicit sort for the “latest task runs” query (`ORDER BY id DESC`) while remaining index-only. | | `taskrun_runtime_createdat_idx` | **BTREE** `(runtimeEnvironmentId, createdAt DESC) INCLUDE (id)` | Accelerates the filter-only path that scans by `createdAt >= …` without any ordering requirement. | | `taskrun_createdat_brin` | **BRIN** on `createdAt` (`pages_per_range = 128`) | Lets the planner skip whole blocks older than the time window for both queries at < 100 MB cost. | | *(cleanup)* | **DROP** `TaskRun_runtimeEnvironmentId_createdAt_id_idx` | Retires the 3-column index once the new ones are built. | **Key details** * All indexes created **CONCURRENTLY** to avoid write blocking. * `fillfactor = 90` on b-trees for balanced space vs. future growth. * Net disk usage drops **≈ 15–20 GB** while each query now gets a purpose-built access path. **Why** * Remove planner Sort nodes for the top-N “latest runs” view. * Speed up environment-filtered range scans. * Shrink index bloat and improve cache efficiency.
|
WalkthroughThis change updates the indexing strategy for the TaskRun table in the database schema. It removes an existing composite index on runtimeEnvironmentId, createdAt, and id, and introduces three new indexes: one on runtimeEnvironmentId and id (descending), one on runtimeEnvironmentId and createdAt (descending), and a BRIN index on createdAt. Each new index is created concurrently and with specific fillfactor settings to optimize performance. The schema.prisma file is updated to reflect these changes, and the previous composite index is replaced by the new, more granular indexes. No changes are made to exported or public code entities. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
internal-packages/database/prisma/schema.prisma (1)
686-688: Suggest explicit index naming in Prisma schema
Prisma’s default names may diverge from your manual SQL migrations. To guarantee alignment, add thenameattribute to each@@index. For example:model TaskRun { - @@index([runtimeEnvironmentId, id(sort: Desc)]) - @@index([runtimeEnvironmentId, createdAt(sort: Desc)]) - @@index([createdAt], type: Brin) + @@index([runtimeEnvironmentId, id(sort: Desc)], name: "TaskRun_runtimeEnvironmentId_id_idx") + @@index([runtimeEnvironmentId, createdAt(sort: Desc)], name: "TaskRun_runtimeEnvironmentId_createdAt_idx") + @@index([createdAt], type: Brin, name: "TaskRun_createdAt_idx") }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
internal-packages/database/prisma/migrations/20250611075637_remove_task_run_environment_created_at_id_index/migration.sql(1 hunks)internal-packages/database/prisma/migrations/20250611080026_add_task_run_environment_id_index_including_created_at/migration.sql(1 hunks)internal-packages/database/prisma/migrations/20250611080322_add_task_run_environment_created_at_index_including_id/migration.sql(1 hunks)internal-packages/database/prisma/migrations/20250611080537_add_task_run_created_at_brin_index/migration.sql(1 hunks)internal-packages/database/prisma/schema.prisma(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (25)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (10, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (9, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 10)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 10)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
internal-packages/database/prisma/migrations/20250611075637_remove_task_run_environment_created_at_id_index/migration.sql (1)
1-1: Correct index removal
Dropping the old composite index concurrently withIF EXISTSand quoting matches the prior index name.internal-packages/database/prisma/migrations/20250611080322_add_task_run_environment_created_at_index_including_id/migration.sql (1)
1-1: Approve createdAt DESC index
New BTREE index on(runtimeEnvironmentId, createdAt DESC)includingidwith fillfactor 90 is correctly defined and concurrent.internal-packages/database/prisma/migrations/20250611080026_add_task_run_environment_id_index_including_created_at/migration.sql (1)
1-1: Approve id DESC index
New BTREE index on(runtimeEnvironmentId, id DESC)includingcreatedAtwith fillfactor 90 is correctly defined and concurrent.
...s/database/prisma/migrations/20250611080537_add_task_run_created_at_brin_index/migration.sql
Show resolved
Hide resolved
PR: Optimize TaskRun indexes for hot-path queries
What changed
taskrun_runtime_id_desc_idx(runtimeEnvironmentId, id DESC) INCLUDE (createdAt)ORDER BY id DESC) while remaining index-only.taskrun_runtime_createdat_idx(runtimeEnvironmentId, createdAt DESC) INCLUDE (id)createdAt >= …without any ordering requirement.taskrun_createdat_brincreatedAt(pages_per_range = 128)TaskRun_runtimeEnvironmentId_createdAt_id_idxKey details
fillfactor = 90on b-trees for balanced space vs. future growth.Why