Skip to content

Clarify db index docs #13561

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2025
Merged

Clarify db index docs #13561

merged 1 commit into from
May 1, 2025

Conversation

wedamija
Copy link
Member

@wedamija wedamija commented May 1, 2025

No description provided.

@wedamija wedamija requested a review from saponifi3d May 1, 2025 00:20
Copy link

vercel bot commented May 1, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 1, 2025 0:27am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) May 1, 2025 0:27am
sentry-docs ⬜️ Ignored (Inspect) May 1, 2025 0:27am

@wedamija wedamija enabled auto-merge (squash) May 1, 2025 00:20
Copy link

@saponifi3d saponifi3d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for updating these!


When adding indexes to large tables you should use a `is_post_deployment` migration as creating the index could take longer than the migration statement timeout of 5s.

Note: These are created using `CONCURRENTLY`, so it's important to not set `atomic = True` for migrations that contain indexes. This is disabled by default.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it'd be a little clearer if the atomic = True was part of the first paragraph, like "these are things we should be doing when we want to generate a new index"

Then in the note, it can explain that it's because we use concurrently.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally no action is required about atomic. It's false by default, so it's just a side note in case someone tries to enable it for some reason.

@wedamija wedamija merged commit 5942513 into master May 1, 2025
10 checks passed
@wedamija wedamija deleted the wedamija-patch-1 branch May 1, 2025 00:27
codyde added a commit that referenced this pull request May 1, 2025
* 'master' of https://github.com/getsentry/sentry-docs:
  Add "Data Collected" page for Godot SDK (and more) (#13533)
  Clarify FK docs (#13562)
  Clarify db index docs (#13561)
  Remove non-functioning video embed (#13557)
  Masinette integrations elba (#13503)
  Incorporate Uptime Monitors Into The Crons Management Page (#13507)
  feat(javascript): Add "Data Collected" (#13527)
  docs(relay): remove entries that are not scrubbed by default (#13555)
  flutter: Add note to app start integration (#13479)
  ref(flutter): move custom zone handling code snippet from init to troubleshooting (#13478)
  docs(python): add uv option to python install instructions (#13510)
  add docs for supabase integration (#13545)
  feat(native): add view hierarchy to develop docs (#13544)
  feat(autofix): Update autofix images (#13540)
  Ad alerts and dashboard page to new quickstart guide (#13522)
  Add data enrichment page to new onboarding guide (#13508)
  Add first onboarding guide to docs (#13462)
  (feat) Sentry MCP Documentation  (#13524)
  feat(Capacitor): Migration guides for version 2 (#13022)
  docs(js): move API-related content from Manual Setup to APIs page (#13327)
@github-actions github-actions bot locked and limited conversation to collaborators May 16, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants