Commit2af0971

committed

Clarify documentation of EXPLAIN (TIMING OFF) option.

Clarify that this option doesn't suppress measurement of the statement'stotal runtime.Greg Smith

1 parentd4337a0 commit2af0971Copy full SHA for 2af0971

File tree

-3

lines changed

-3

lines changed

Lines changed: 5 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -182,11 +182,13 @@ ROLLBACK;`
`182`	`182`	`<term><literal>TIMING</literal></term>`
`183`	`183`	`<listitem>`
`184`	`184`	`<para>`
`185`		`- Includetheactual startup time and time spent inthe node in the output.`
	`185`	`+ Include actual startup time and time spent ineach node in the output.`
`186`	`186`	`The overhead of repeatedly reading the system clock can slow down the`
`187`	`187`	`query significantly on some systems, so it may be useful to set this`
`188`		`- parameter to <literal>FALSE</literal> when only actual row counts, and not`
`189`		`- exact times, are needed.`
	`188`	`+ parameter to <literal>FALSE</literal> when only actual row counts, and`
	`189`	`+ not exact times, are needed. Run time of the entire statement is`
	`190`	`+ always measured, even when node-level timing is turned off with this`
	`191`	`+ option.`
`190`	`192`	`This parameter may only be used when <literal>ANALYZE</literal> is also`
`191`	`193`	`enabled. It defaults to <literal>TRUE</literal>.`
`192`	`194`	`</para>`

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -414,6 +414,10 @@ ExplainOnePlan(PlannedStmt plannedstmt, IntoClause into, ExplainState *es,`
`414`	`414`	`if (es->buffers)`
`415`	`415`	`instrument_option \|=INSTRUMENT_BUFFERS;`
`416`	`416`
	`417`	`+/*`
	`418`	`+ * We always collect timing for the entire statement, even when`
	`419`	`+ * node-level timing is off, so we don't look at es->timing here.`
	`420`	`+ */`
`417`	`421`	`INSTR_TIME_SET_CURRENT(starttime);`
`418`	`422`
`419`	`423`	`/*`

Comments

(0)