document generic query plans #18753

taroface · 2024-07-19T21:51:05Z

DOC-10470

Document generic query plans.
Expand descriptions of custom plans and plan cache.
Add session setting.
Add new EXPLAIN field.

github-actions · 2024-07-19T21:51:30Z

Files changed:

src/current/_includes/v24.2/misc/enterprise-features.md:

src/current/_includes/v24.2/misc/session-vars.md:

src/current/v24.2/cost-based-optimizer.md
src/current/v24.2/explain-analyze.md

netlify · 2024-07-19T21:51:35Z

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name	Link
🔨 Latest commit	`fad6076`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/66b518b3e26850000895cb07

netlify · 2024-07-19T21:51:37Z

✅ Deploy Preview for cockroachdb-api-docs canceled.

Name	Link
🔨 Latest commit	`fad6076`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-api-docs/deploys/66b518b3353d530008a1ec59

netlify · 2024-07-19T21:56:50Z

✅ Netlify Preview

Name	Link
🔨 Latest commit	`fad6076`
🔍 Latest deploy log	https://app.netlify.com/sites/cockroachdb-docs/deploys/66b518b37c16a90009c00bc1
😎 Deploy Preview	https://deploy-preview-18753--cockroachdb-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mgartner

Very nice! I left a few suggestions inline.

We might also want to cal lout that you'll only get the benefits of generic query plans if you're using prepared statements, either with an explicit PREPARE statement, or with the extended query protocol (which many ORMs and clients will use automaticall): https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-EXT-QUERY

But we don't have any documentation on the extended query protocol, that I can find.

src/current/v24.2/cost-based-optimizer.md

taroface · 2024-08-05T22:04:35Z

Very nice! I left a few suggestions inline.

We might also want to cal lout that you'll only get the benefits of generic query plans if you're using prepared statements, either with an explicit PREPARE statement, or with the extended query protocol (which many ORMs and clients will use automaticall): https://www.postgresql.org/docs/current/protocol-flow.html#PROTOCOL-FLOW-EXT-QUERY

But we don't have any documentation on the extended query protocol, that I can find.

@mgartner TFTR! Is it a significant gap that we don't document the extended query protocol? Or would its meaning be clear enough if I say, e.g., ... the extended query protocol that many ORMs and clients will use automatically?

EDIT: I sort of wrote around this.

mgartner

Looking good. Left a few more comments.

I do think we should call out that generic query plans come with a trade-off: the plans produced may be less efficient than a custom plan. For that reason, we should urge users to use plan_cache_mode=auto instead of force_generic_plan because under this setting the database should avoid bad generic query plans and fallback to custom plans.

src/current/v24.2/cost-based-optimizer.md

taroface · 2024-08-07T16:25:27Z

@mgartner I made some adjustments based on your feedback - PTAL.

mgartner

looks great! as discussed in slack, we may want to link to the guidance on reorder_joins_limit where many-join queries are mentioned

florence-crl

lgtm, non-blocking nits

src/current/_includes/v24.2/misc/session-vars.md

src/current/v24.2/cost-based-optimizer.md

Co-authored-by: Florence Morris <[email protected]>

* document generic query plans --------- Co-authored-by: Florence Morris <[email protected]>

taroface changed the title ~~[wip] document generic query plans~~ document generic query plans Jul 29, 2024

taroface requested review from mgartner and dikshant July 29, 2024 18:54

mgartner reviewed Aug 5, 2024

View reviewed changes

src/current/v24.2/cost-based-optimizer.md Outdated Show resolved Hide resolved

src/current/v24.2/cost-based-optimizer.md Outdated Show resolved Hide resolved

taroface force-pushed the generic-query-plans branch 2 times, most recently from 7ea49fd to 9be05ca Compare August 6, 2024 17:08

mgartner reviewed Aug 6, 2024

View reviewed changes

src/current/v24.2/cost-based-optimizer.md Outdated Show resolved Hide resolved

src/current/v24.2/cost-based-optimizer.md Outdated Show resolved Hide resolved

mgartner reviewed Aug 6, 2024

View reviewed changes

src/current/v24.2/cost-based-optimizer.md Outdated Show resolved Hide resolved

mgartner approved these changes Aug 8, 2024

View reviewed changes

taroface requested a review from florence-crl August 8, 2024 16:13

florence-crl approved these changes Aug 8, 2024

View reviewed changes

src/current/_includes/v24.2/misc/session-vars.md Outdated Show resolved Hide resolved

src/current/v24.2/cost-based-optimizer.md Outdated Show resolved Hide resolved

src/current/v24.2/cost-based-optimizer.md Outdated Show resolved Hide resolved

taroface enabled auto-merge (squash) August 8, 2024 19:00

taroface disabled auto-merge August 8, 2024 19:02

taroface and others added 7 commits August 8, 2024 15:11

document generic query plans

d488314

clarify wording

ac62f56

address review comments

74c6ff4

address mgartner comments

9345aeb

link to many-join query guidance

7bc4f52

Apply suggestions from code review

17cca72

Co-authored-by: Florence Morris <[email protected]>

add enterprise license

fad6076

taroface force-pushed the generic-query-plans branch from 5322c13 to fad6076 Compare August 8, 2024 19:12

taroface enabled auto-merge (squash) August 8, 2024 19:13

taroface merged commit d65f868 into main Aug 8, 2024
7 checks passed

taroface deleted the generic-query-plans branch August 8, 2024 19:16

This was referenced Aug 8, 2024

[WIP] port generic query plans to 24.1, 23.2 #18803

Merged

generic query plans are in preview #18805

Merged

mdlinville pushed a commit that referenced this pull request Aug 9, 2024

document generic query plans (#18753)

ce7a538

* document generic query plans --------- Co-authored-by: Florence Morris <[email protected]>

mdlinville pushed a commit that referenced this pull request Aug 12, 2024

document generic query plans (#18753)

a535f0c

* document generic query plans --------- Co-authored-by: Florence Morris <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

document generic query plans #18753

document generic query plans #18753

taroface commented Jul 19, 2024 •

edited

Loading

github-actions bot commented Jul 19, 2024 •

edited

Loading

netlify bot commented Jul 19, 2024 •

edited

Loading

netlify bot commented Jul 19, 2024 •

edited

Loading

netlify bot commented Jul 19, 2024 •

edited

Loading

mgartner left a comment

taroface commented Aug 5, 2024 •

edited

Loading

mgartner left a comment

taroface commented Aug 7, 2024

mgartner left a comment

florence-crl left a comment

document generic query plans #18753

document generic query plans #18753

Conversation

taroface commented Jul 19, 2024 • edited Loading

github-actions bot commented Jul 19, 2024 • edited Loading

Files changed:

netlify bot commented Jul 19, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

netlify bot commented Jul 19, 2024 • edited Loading

✅ Deploy Preview for cockroachdb-api-docs canceled.

netlify bot commented Jul 19, 2024 • edited Loading

✅ Netlify Preview

mgartner left a comment

Choose a reason for hiding this comment

taroface commented Aug 5, 2024 • edited Loading

mgartner left a comment

Choose a reason for hiding this comment

taroface commented Aug 7, 2024

mgartner left a comment

Choose a reason for hiding this comment

florence-crl left a comment

Choose a reason for hiding this comment

taroface commented Jul 19, 2024 •

edited

Loading

github-actions bot commented Jul 19, 2024 •

edited

Loading

netlify bot commented Jul 19, 2024 •

edited

Loading

netlify bot commented Jul 19, 2024 •

edited

Loading

netlify bot commented Jul 19, 2024 •

edited

Loading

taroface commented Aug 5, 2024 •

edited

Loading