Rename postgres_fdw's use_remote_explain option to use_remote_estimate.

tglsfdc · tglsfdc · commit 09a7cd409e76 · 2013-02-23T12:20:48.000-05:00
The new name was originally my typo, but per discussion it seems like a
better name anyway.  So make the code match the docs, not vice versa.
diff --git a/contrib/postgres_fdw/expected/postgres_fdw.out b/contrib/postgres_fdw/expected/postgres_fdw.out
@@ -78,7 +78,7 @@ ALTER FOREIGN TABLE ft2 DROP COLUMN c0;
 -- requiressl, krbsrvname and gsslib are omitted because they depend on
 -- configure options
 ALTER SERVER testserver1 OPTIONS (
-	use_remote_explain 'false',
+	use_remote_estimate 'false',
 	fdw_startup_cost '123.456',
 	fdw_tuple_cost '0.123',
 	service 'value',
@@ -121,9 +121,9 @@ ALTER FOREIGN TABLE ft2 ALTER COLUMN c1 OPTIONS (column_name 'C 1');
 
 -- Now we should be able to run ANALYZE.
 -- To exercise multiple code paths, we use local stats on ft1
--- and remote_explain mode on ft2.
+-- and remote-estimate mode on ft2.
 ANALYZE ft1;
-ALTER FOREIGN TABLE ft2 OPTIONS (use_remote_explain 'true');
+ALTER FOREIGN TABLE ft2 OPTIONS (use_remote_estimate 'true');
 -- ===================================================================
 -- simple queries
 -- ===================================================================
diff --git a/contrib/postgres_fdw/option.c b/contrib/postgres_fdw/option.c
@@ -106,9 +106,9 @@ postgres_fdw_validator(PG_FUNCTION_ARGS)
 		/*
 		 * Validate option value, when we can do so without any context.
 		 */
-		if (strcmp(def->defname, "use_remote_explain") == 0)
+		if (strcmp(def->defname, "use_remote_estimate") == 0)
 		{
-			/* use_remote_explain accepts only boolean values */
+			/* use_remote_estimate accepts only boolean values */
 			(void) defGetBoolean(def);
 		}
 		else if (strcmp(def->defname, "fdw_startup_cost") == 0 ||
@@ -145,9 +145,9 @@ InitPgFdwOptions(void)
 		{"schema_name", ForeignTableRelationId, false},
 		{"table_name", ForeignTableRelationId, false},
 		{"column_name", AttributeRelationId, false},
-		/* use_remote_explain is available on both server and table */
-		{"use_remote_explain", ForeignServerRelationId, false},
-		{"use_remote_explain", ForeignTableRelationId, false},
+		/* use_remote_estimate is available on both server and table */
+		{"use_remote_estimate", ForeignServerRelationId, false},
+		{"use_remote_estimate", ForeignTableRelationId, false},
 		/* cost factors */
 		{"fdw_startup_cost", ForeignServerRelationId, false},
 		{"fdw_tuple_cost", ForeignServerRelationId, false},
diff --git a/contrib/postgres_fdw/postgres_fdw.c b/contrib/postgres_fdw/postgres_fdw.c
@@ -248,7 +248,7 @@ postgresGetForeignRelSize(PlannerInfo *root,
 						  RelOptInfo *baserel,
 						  Oid foreigntableid)
 {
-	bool		use_remote_explain = false;
+	bool		use_remote_estimate = false;
 	ListCell   *lc;
 	PgFdwRelationInfo *fpinfo;
 	StringInfo	sql;
@@ -285,19 +285,19 @@ postgresGetForeignRelSize(PlannerInfo *root,
 	{
 		DefElem    *def = (DefElem *) lfirst(lc);
 
-		if (strcmp(def->defname, "use_remote_explain") == 0)
+		if (strcmp(def->defname, "use_remote_estimate") == 0)
 		{
-			use_remote_explain = defGetBoolean(def);
+			use_remote_estimate = defGetBoolean(def);
 			break;
 		}
 	}
 	foreach(lc, table->options)
 	{
 		DefElem    *def = (DefElem *) lfirst(lc);
 
-		if (strcmp(def->defname, "use_remote_explain") == 0)
+		if (strcmp(def->defname, "use_remote_estimate") == 0)
 		{
-			use_remote_explain = defGetBoolean(def);
+			use_remote_estimate = defGetBoolean(def);
 			break;
 		}
 	}
@@ -315,12 +315,12 @@ postgresGetForeignRelSize(PlannerInfo *root,
 		appendWhereClause(sql, true, remote_conds, root);
 
 	/*
-	 * If the table or the server is configured to use remote EXPLAIN, connect
-	 * to the foreign server and execute EXPLAIN with the quals that don't
-	 * contain any Param nodes.  Otherwise, estimate rows using whatever
+	 * If the table or the server is configured to use remote estimates,
+	 * connect to the foreign server and execute EXPLAIN with the quals that
+	 * don't contain any Param nodes.  Otherwise, estimate rows using whatever
 	 * statistics we have locally, in a way similar to ordinary tables.
 	 */
-	if (use_remote_explain)
+	if (use_remote_estimate)
 	{
 		RangeTblEntry *rte;
 		Oid			userid;
diff --git a/contrib/postgres_fdw/sql/postgres_fdw.sql b/contrib/postgres_fdw/sql/postgres_fdw.sql
@@ -87,7 +87,7 @@ ALTER FOREIGN TABLE ft2 DROP COLUMN c0;
 -- requiressl, krbsrvname and gsslib are omitted because they depend on
 -- configure options
 ALTER SERVER testserver1 OPTIONS (
-	use_remote_explain 'false',
+	use_remote_estimate 'false',
 	fdw_startup_cost '123.456',
 	fdw_tuple_cost '0.123',
 	service 'value',
@@ -124,9 +124,9 @@ ALTER FOREIGN TABLE ft2 ALTER COLUMN c1 OPTIONS (column_name 'C 1');
 
 -- Now we should be able to run ANALYZE.
 -- To exercise multiple code paths, we use local stats on ft1
--- and remote_explain mode on ft2.
+-- and remote-estimate mode on ft2.
 ANALYZE ft1;
-ALTER FOREIGN TABLE ft2 OPTIONS (use_remote_explain 'true');
+ALTER FOREIGN TABLE ft2 OPTIONS (use_remote_estimate 'true');
 
 -- ===================================================================
 -- simple queries

Original file line number	Diff line number	Diff line change
`@@ -248,7 +248,7 @@ postgresGetForeignRelSize(PlannerInfo *root,`
`248`	`248`	`RelOptInfo *baserel,`
`249`	`249`	`Oid foreigntableid)`
`250`	`250`	`{`
`251`		`- bool use_remote_explain = false;`
	`251`	`+ bool use_remote_estimate = false;`
`252`	`252`	`ListCell *lc;`
`253`	`253`	`PgFdwRelationInfo *fpinfo;`
`254`	`254`	`StringInfo sql;`
`@@ -285,19 +285,19 @@ postgresGetForeignRelSize(PlannerInfo *root,`
`285`	`285`	`{`
`286`	`286`	`DefElem def = (DefElem ) lfirst(lc);`
`287`	`287`
`288`		`- if (strcmp(def->defname, "use_remote_explain") == 0)`
	`288`	`+ if (strcmp(def->defname, "use_remote_estimate") == 0)`
`289`	`289`	`{`
`290`		`- use_remote_explain = defGetBoolean(def);`
	`290`	`+ use_remote_estimate = defGetBoolean(def);`
`291`	`291`	`break;`
`292`	`292`	`}`
`293`	`293`	`}`
`294`	`294`	`foreach(lc, table->options)`
`295`	`295`	`{`
`296`	`296`	`DefElem def = (DefElem ) lfirst(lc);`
`297`	`297`
`298`		`- if (strcmp(def->defname, "use_remote_explain") == 0)`
	`298`	`+ if (strcmp(def->defname, "use_remote_estimate") == 0)`
`299`	`299`	`{`
`300`		`- use_remote_explain = defGetBoolean(def);`
	`300`	`+ use_remote_estimate = defGetBoolean(def);`
`301`	`301`	`break;`
`302`	`302`	`}`
`303`	`303`	`}`
`@@ -315,12 +315,12 @@ postgresGetForeignRelSize(PlannerInfo *root,`
`315`	`315`	`appendWhereClause(sql, true, remote_conds, root);`
`316`	`316`
`317`	`317`	`/*`
`318`		`- * If the table or the server is configured to use remote EXPLAIN, connect`
`319`		`- * to the foreign server and execute EXPLAIN with the quals that don't`
`320`		`- * contain any Param nodes. Otherwise, estimate rows using whatever`
	`318`	`+ * If the table or the server is configured to use remote estimates,`
	`319`	`+ * connect to the foreign server and execute EXPLAIN with the quals that`
	`320`	`+ * don't contain any Param nodes. Otherwise, estimate rows using whatever`
`321`	`321`	`* statistics we have locally, in a way similar to ordinary tables.`
`322`	`322`	`*/`
`323`		`- if (use_remote_explain)`
	`323`	`+ if (use_remote_estimate)`
`324`	`324`	`{`
`325`	`325`	`RangeTblEntry *rte;`
`326`	`326`	`Oid userid;`