Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitd3d8755

Browse files
committed
Undo double-quoting of index names in non-text EXPLAIN output formats.
explain_get_index_name() applied quote_identifier() to the index name.This is fine for text output, but the non-text output formats all havetheir own quoting conventions and would much rather start from theactual index name. For example in JSON you'd get something like "Index Name": "\"My Index\"",which is surely not desirable, especially when the same does nothappen for table names. Hence, move the responsibility for applyingquoting out to the callers, where it can go into already-existingspecial code paths for text format.This changes the API spec for users of explain_get_index_name_hook:before, they were supposed to apply quote_identifier() if necessary,now they should not. Research suggests that the only publiclyavailable user of the hook is hypopg, and it actually forgot toapply quoting anyway, so it's fine. (In any case, there's nobehavioral change for the output of a hook as seen in non-textEXPLAIN formats, so this won't break any case that programs shouldbe relying on.)Digging in the commit logs, it appears that quoting was included inexplain_get_index_name's duties when commit604ffd2 invented it;and that was fine at the time because we only had text output format.This should have been rethought when non-text formats were invented,but it wasn't.This is a fairly clear bug for users of non-text EXPLAIN formats,so back-patch to all supported branches.Per bug #16502 from Maciek Sakrejda. Patch by me (based oninvestigation by Euler Taveira); thanks to Julien Rouhaud for review.Discussion:https://postgr.es/m/16502-57bd1c9f913ed1d1@postgresql.org
1 parent396a44a commitd3d8755

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

‎src/backend/commands/explain.c

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1383,7 +1383,8 @@ ExplainNode(PlanState *planstate, List *ancestors,
13831383
explain_get_index_name(bitmapindexscan->indexid);
13841384

13851385
if (es->format==EXPLAIN_FORMAT_TEXT)
1386-
appendStringInfo(es->str," on %s",indexname);
1386+
appendStringInfo(es->str," on %s",
1387+
quote_identifier(indexname));
13871388
else
13881389
ExplainPropertyText("Index Name",indexname,es);
13891390
}
@@ -2839,6 +2840,10 @@ show_eval_params(Bitmapset *bms_params, ExplainState *es)
28392840
*
28402841
* We allow plugins to get control here so that plans involving hypothetical
28412842
* indexes can be explained.
2843+
*
2844+
* Note: names returned by this function should be "raw"; the caller will
2845+
* apply quoting if needed. Formerly the convention was to do quoting here,
2846+
* but we don't want that in non-text output formats.
28422847
*/
28432848
staticconstchar*
28442849
explain_get_index_name(OidindexId)
@@ -2851,11 +2856,10 @@ explain_get_index_name(Oid indexId)
28512856
result=NULL;
28522857
if (result==NULL)
28532858
{
2854-
/* default behavior: look in the catalogs and quote it */
2859+
/* default behavior: lookit upin the catalogs */
28552860
result=get_rel_name(indexId);
28562861
if (result==NULL)
28572862
elog(ERROR,"cache lookup failed for index %u",indexId);
2858-
result=quote_identifier(result);
28592863
}
28602864
returnresult;
28612865
}
@@ -2997,7 +3001,7 @@ ExplainIndexScanDetails(Oid indexid, ScanDirection indexorderdir,
29973001
{
29983002
if (ScanDirectionIsBackward(indexorderdir))
29993003
appendStringInfoString(es->str," Backward");
3000-
appendStringInfo(es->str," using %s",indexname);
3004+
appendStringInfo(es->str," using %s",quote_identifier(indexname));
30013005
}
30023006
else
30033007
{

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp