ossc-db / pg_hint_plan

Extension adding support for optimizer hints in PostgreSQL
Other
710 stars 103 forks source link

Improved repository description? #178

Closed justinclift closed 6 months ago

justinclift commented 6 months ago

The existing description for this repository isn't great English:

Give PostgreSQL ability to manually force some decisions in execution plans. 

Is it ok to suggest improvements, maybe something like this?

Force PostgreSQL to execute query plans the way you want

... or maybe use "Tell PostgreSQL ..." there instead of "Force PostgreSQL ..."

What do you reckon? :smile:

michaelpq commented 6 months ago

I would suggest something even simpler, because we have a README that explains what this extension does:

Extension adding support for query hint plans in PostgreSQL.

@yamatattsu It happens that I don't have an access to that. Perhaps you could improve the description of this repository?

justinclift commented 6 months ago

Extension adding support for query hint plans in PostgreSQL.

Yeah, that sounds good too. :smile:

yamatattsu commented 6 months ago

https://github.com/yamatattsu

Hi Michael-san,

@yamatattsu https://github.com/yamatattsu It happens that I don't have an

access to that. Perhaps you could improve the description of this repository?

Yeah, I can improve that probably. So I'll fix that on this weekend.

yamatattsu commented 6 months ago

Hi Michael and Justin,

Extension adding support for query hint plans in PostgreSQL

I realized "query hint plans" as Michael-san proposed seems like a typo: s/query hint plans/query hint/ ?

Even if it was typo, the word "query hint" is not popular, so I'd like to propose the following:

Extension adding support for optimizer hints in PostgreSQL

It is good for the description because the word "optimizer hints" is used on PostgreSQL wiki like this:

https://wiki.postgresql.org/wiki/OptimizerHintsDiscussion

What do you guys think about that?

Regards, Tatsuro Yamada

justinclift commented 6 months ago

Extension adding support for optimizer hints in PostgreSQL

The phrase structure sounds good. I'm unsure if "optimizer" is better than "query plan" hints though? If "optimizer" is more accurate, then this has my vote (for whatever that's worth). :wink:

horiguti commented 6 months ago

If the term 'optimizaer hints' is sufficiently widespread, I think it's appropriate to use it, considering that this tool doesn't always end up completely correcting plans.

yamatattsu commented 6 months ago

Hi Justin and Horiguti,

Thanks for the comments. Since there is the PostgreSQL wiki page related to "optimizer hints" as I mentioned above, I believe it is a well-known term, so I'll use it in the description.

If it has a problem or something, let's consider a more suitable word and fix it again later.

Thanks,

yamatattsu commented 6 months ago

I'm going to close this issue because I fixed the description,

justinclift commented 6 months ago

Cool, seems good. Thanks for getting it done. :smile: