From 458857cc9d7d00711b272a0dabbcb591b506d6b8 Mon Sep 17 00:00:00 2001
From: Tom Lane
Date: Wed, 12 Oct 2011 15:45:03 -0400
Subject: Throw a useful error message if an extension script file is fed to
 psql.

We have seen one too many reports of people trying to use 9.1 extension
files in the old-fashioned way of sourcing them in psql.  Not only does
that usually not work (due to failure to substitute for MODULE_PATHNAME
and/or @extschema@), but if it did work they'd get a collection of loose
objects not an extension.  To prevent this, insert an \echo ... \quit
line that prints a suitable error message into each extension script file,
and teach commands/extension.c to ignore lines starting with \echo.
That should not only prevent any adverse consequences of loading a script
file the wrong way, but make it crystal clear to users that they need to
do it differently now.

Tom Lane, following an idea of Andrew Dunstan's.  Back-patch into 9.1
... there is not going to be much value in this if we wait till 9.2.
---
 contrib/btree_gist/btree_gist--1.0.sql             | 3 +++
 contrib/btree_gist/btree_gist--unpackaged--1.0.sql | 3 +++
 2 files changed, 6 insertions(+)

(limited to 'contrib/btree_gist')

diff --git a/contrib/btree_gist/btree_gist--1.0.sql b/contrib/btree_gist/btree_gist--1.0.sql
index dd428995c18..c5c958753e3 100644
--- a/contrib/btree_gist/btree_gist--1.0.sql
+++ b/contrib/btree_gist/btree_gist--1.0.sql
@@ -1,5 +1,8 @@
 /* contrib/btree_gist/btree_gist--1.0.sql */
 
+-- complain if script is sourced in psql, rather than via CREATE EXTENSION
+\echo Use "CREATE EXTENSION btree_gist" to load this file. \quit
+
 CREATE FUNCTION gbtreekey4_in(cstring)
 RETURNS gbtreekey4
 AS 'MODULE_PATHNAME', 'gbtreekey_in'
diff --git a/contrib/btree_gist/btree_gist--unpackaged--1.0.sql b/contrib/btree_gist/btree_gist--unpackaged--1.0.sql
index 00252bf7c38..838ad7ec1e1 100644
--- a/contrib/btree_gist/btree_gist--unpackaged--1.0.sql
+++ b/contrib/btree_gist/btree_gist--unpackaged--1.0.sql
@@ -1,5 +1,8 @@
 /* contrib/btree_gist/btree_gist--unpackaged--1.0.sql */
 
+-- complain if script is sourced in psql, rather than via CREATE EXTENSION
+\echo Use "CREATE EXTENSION btree_gist" to load this file. \quit
+
 ALTER EXTENSION btree_gist ADD type gbtreekey4;
 ALTER EXTENSION btree_gist ADD function gbtreekey4_in(cstring);
 ALTER EXTENSION btree_gist ADD function gbtreekey4_out(gbtreekey4);
-- 
cgit v1.2.3