Add oracle prices index on ("marketId", "effectiveAtHeight")

[dydxwill]

Changelist

Add oracle prices index on ("marketId", "effectiveAtHeight")

Test Plan

Tested internally

Author/Reviewer Checklist

• If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
• If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
• If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
• If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
• If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
• Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

• New Features
  • Introduced an index on the oracle_prices table to enhance query performance.
• Bug Fixes
  • Improved database migration process to allow for non-blocking index creation and deletion.

[coderabbitai]

Walkthrough

A new migration file has been added to create an index on the oracle_prices table in a PostgreSQL database. This index is defined on the marketId and effectiveAtHeight columns, allowing for concurrent creation and removal without locking the table. The migration includes methods for both applying and reverting the index, with specific configurations to enhance flexibility during the migration process.

Changes

File	Change Summary
indexer/packages/postgres/src/db/migrations/migration_files/20240926133526_create_oracle_prices_market_id_effective_at_height_index.ts	Added migration methods up and down for creating and dropping an index on oracle_prices. Included configuration for concurrent operations.

Suggested labels

indexer

Suggested reviewers

• shrenujb
• vincentwschau

Poem

In the database where prices play,
A new index hops in, hip-hip-hooray!
With marketId and height in sight,
It dances through queries, oh what a delight!
Concurrently built, it won’t cause a fuss,
Just like a rabbit, quick and robust! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 35a70aa and 2987074.

📒 Files selected for processing (1)

• indexer/packages/postgres/src/db/migrations/migration_files/20240926133526_create_oracle_prices_market_id_effective_at_height_index.ts (1 hunks)

🔇 Additional comments (5)

indexer/packages/postgres/src/db/migrations/migration_files/20240926133526_create_oracle_prices_market_id_effective_at_height_index.ts (5)

1-1: LGTM: Import statement is correct.

The import of Knex is appropriate for this database migration file.

---

3-7: LGTM: Well-implemented index creation.

The up function correctly creates the index as per the PR objectives. Notable points:

1. Use of CREATE INDEX CONCURRENTLY allows for index creation without table locks.
2. IF NOT EXISTS clause prevents errors if the index already exists.
3. The index name and columns align with the PR objectives.

---

9-13: LGTM: Well-implemented index removal.

The down function correctly removes the index created by the up function. Key points:

1. Use of DROP INDEX CONCURRENTLY allows for index removal without table locks.
2. IF EXISTS clause prevents errors if the index doesn't exist.
3. The index name matches the one created in the up function, ensuring proper cleanup.

---

15-17: LGTM: Correct configuration for concurrent index operations.

The config object correctly sets transaction: false. This is crucial because:

1. CREATE INDEX CONCURRENTLY and DROP INDEX CONCURRENTLY cannot run inside a transaction.
2. This configuration allows the migration to perform these concurrent operations successfully.

---

1-17: Overall assessment: Excellent implementation of the index migration.

This migration file is well-structured and implements the index creation and removal as per the PR objectives. Key strengths:

1. Proper use of concurrent index operations to avoid table locks.
2. Defensive programming with IF NOT EXISTS and IF EXISTS clauses.
3. Correct configuration to allow concurrent operations.
4. Clear and consistent naming conventions.

The implementation aligns perfectly with the goal of adding an index for oracle prices based on 'marketId' and 'effectiveAtHeight'.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[dydxwill]

@Mergifyio backport release/indexer/v5.x

[dydxwill]

@Mergifyio backport release/indexer/v6.x

[mergify]

backport release/indexer/v5.x

✅ Backports have been created

• #2372 Add oracle prices index on ("marketId", "effectiveAtHeight") (backport #2368) has been created for branch release/indexer/v5.x

[dydxwill]

@Mergifyio backport release/indexer/v7.x

[mergify]

backport release/indexer/v6.x

✅ Backports have been created

• #2373 Add oracle prices index on ("marketId", "effectiveAtHeight") (backport #2368) has been created for branch release/indexer/v6.x

[mergify]

backport release/indexer/v7.x

✅ Backports have been created

• #2374 Add oracle prices index on ("marketId", "effectiveAtHeight") (backport #2368) has been created for branch release/indexer/v7.x