Skip to content

Commit eb3adab

Browse files
tglsfdctglsfdc
committed
Provide an upgrade strategy for dump files containing functions declared
with OPAQUE. CREATE LANGUAGE, CREATE TRIGGER, and CREATE TYPE will all accept references to functions declared with OPAQUE --- but they will issue a NOTICE, and will modify the function entries in pg_proc to have the preferred type-safe argument or result types instead of OPAQUE. Per recent pghackers discussions.
1 parent bc49968 commit eb3adab

File tree

12 files changed

+237
-91
lines changed

12 files changed

+237
-91
lines changed

‎doc/src/sgml/ref/create_language.sgml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.27 2002/08/22 00:01:40 tgl Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_language.sgml,v 1.28 2002/09/21 18:39:25 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -200,6 +200,16 @@ ERROR: PL handler function <replaceable class="parameter">funcname</replaceable
200200
will call <command>CREATE LANGUAGE</command> internally.)
201201
</para>
202202

203+
<para>
204+
In <productname>PostgreSQL</productname> versions before 7.3, it was
205+
necessary to declare handler functions as returning the placeholder
206+
type <type>opaque</>, rather than <type>language_handler</>.
207+
To support loading
208+
of old dump files, <command>CREATE LANGUAGE</> will accept a function
209+
declared as returning <type>opaque</>, but it will issue a NOTICE and
210+
change the function's declared return type to <type>language_handler</>.
211+
</para>
212+
203213
<para>
204214
Use the <xref linkend="sql-createfunction" endterm="sql-createfunction-title"> command to create a new
205215
function.

‎doc/src/sgml/ref/create_trigger.sgml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.27 2002/08/22 00:01:40 tgl Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_trigger.sgml,v 1.28 2002/09/21 18:39:25 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -170,9 +170,10 @@ CREATE TRIGGER
170170
<para>
171171
In <productname>PostgreSQL</productname> versions before 7.3, it was
172172
necessary to declare trigger functions as returning the placeholder
173-
type <type>opaque</>, rather than <type>trigger</>. This is still
174-
supported, but is deprecated because it is obscure and causes loss of
175-
type safety.
173+
type <type>opaque</>, rather than <type>trigger</>. To support loading
174+
of old dump files, <command>CREATE TRIGGER</> will accept a function
175+
declared as returning <type>opaque</>, but it will issue a NOTICE and
176+
change the function's declared return type to <type>trigger</>.
176177
</para>
177178

178179
<para>

‎doc/src/sgml/ref/create_type.sgml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.35 2002/09/21 18:32:54 petere Exp $
2+
$Header: /cvsroot/pgsql/doc/src/sgml/ref/create_type.sgml,v 1.36 2002/09/21 18:39:25 tgl Exp $
33
PostgreSQL documentation
44
-->
55

@@ -262,8 +262,10 @@ CREATE TYPE
262262
forward references to the type name with the placeholder pseudo-type
263263
<type>OPAQUE</>. The <type>cstring</> inputs and
264264
results also had to be declared as <type>OPAQUE</> before 7.3.
265-
Use of <type>OPAQUE</> for this purpose is still supported, but it is
266-
deprecated because it causes loss of type safety.
265+
To support loading
266+
of old dump files, <command>CREATE TYPE</> will accept functions
267+
declared using <type>opaque</>, but it will issue a NOTICE and
268+
change the function's declaration to use the correct types.
267269
</para>
268270
</note>
269271

‎src/backend/commands/define.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
*
1010
*
1111
* IDENTIFICATION
12-
* $Header: /cvsroot/pgsql/src/backend/commands/define.c,v 1.80 2002/09/04 20:31:15 momjian Exp $
12+
* $Header: /cvsroot/pgsql/src/backend/commands/define.c,v 1.81 2002/09/21 18:39:25 tgl Exp $
1313
*
1414
* DESCRIPTION
1515
* The "DefineFoo" routines take the parse tree and pick out the
@@ -44,17 +44,17 @@
4444
/*
4545
* Translate the input language name to lower case.
4646
*
47-
* Output buffer should be NAMEDATALEN long.
47+
* Output buffer must be NAMEDATALEN long.
4848
*/
4949
void
5050
case_translate_language_name(const char *input, char *output)
5151
{
5252
int i;
5353

54+
MemSet(output, 0, NAMEDATALEN); /* ensure result Name is zero-filled */
55+
5456
for (i = 0; i < NAMEDATALEN - 1 && input[i]; ++i)
5557
output[i] = tolower((unsigned char) input[i]);
56-
57-
output[i] = '\0';
5858
}
5959

6060

‎src/backend/commands/functioncmds.c

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
*
1010
*
1111
* IDENTIFICATION
12-
* $Header: /cvsroot/pgsql/src/backend/commands/functioncmds.c,v 1.21 2002/09/18 21:35:20 tgl Exp $
12+
* $Header: /cvsroot/pgsql/src/backend/commands/functioncmds.c,v 1.22 2002/09/21 18:39:25 tgl Exp $
1313
*
1414
* DESCRIPTION
1515
* These routines take the parse tree and pick out the
@@ -591,6 +591,85 @@ RemoveFunctionById(Oid funcOid)
591591
}
592592

593593

594+
/*
595+
* SetFunctionReturnType - change declared return type of a function
596+
*
597+
* This is presently only used for adjusting legacy functions that return
598+
* OPAQUE to return whatever we find their correct definition should be.
599+
* The caller should emit a suitable NOTICE explaining what we did.
600+
*/
601+
void
602+
SetFunctionReturnType(Oid funcOid, Oid newRetType)
603+
{
604+
Relation pg_proc_rel;
605+
HeapTuple tup;
606+
Form_pg_proc procForm;
607+
608+
pg_proc_rel = heap_openr(ProcedureRelationName, RowExclusiveLock);
609+
610+
tup = SearchSysCacheCopy(PROCOID,
611+
ObjectIdGetDatum(funcOid),
612+
0, 0, 0);
613+
if (!HeapTupleIsValid(tup)) /* should not happen */
614+
elog(ERROR, "SetFunctionReturnType: couldn't find tuple for function %u",
615+
funcOid);
616+
procForm = (Form_pg_proc) GETSTRUCT(tup);
617+
618+
if (procForm->prorettype != OPAQUEOID)
619+
elog(ERROR, "SetFunctionReturnType: function %u doesn't return OPAQUE",
620+
funcOid);
621+
622+
/* okay to overwrite copied tuple */
623+
procForm->prorettype = newRetType;
624+
625+
/* update the catalog and its indexes */
626+
simple_heap_update(pg_proc_rel, &tup->t_self, tup);
627+
628+
CatalogUpdateIndexes(pg_proc_rel, tup);
629+
630+
heap_close(pg_proc_rel, RowExclusiveLock);
631+
}
632+
633+
634+
/*
635+
* SetFunctionArgType - change declared argument type of a function
636+
*
637+
* As above, but change an argument's type.
638+
*/
639+
void
640+
SetFunctionArgType(Oid funcOid, int argIndex, Oid newArgType)
641+
{
642+
Relation pg_proc_rel;
643+
HeapTuple tup;
644+
Form_pg_proc procForm;
645+
646+
pg_proc_rel = heap_openr(ProcedureRelationName, RowExclusiveLock);
647+
648+
tup = SearchSysCacheCopy(PROCOID,
649+
ObjectIdGetDatum(funcOid),
650+
0, 0, 0);
651+
if (!HeapTupleIsValid(tup)) /* should not happen */
652+
elog(ERROR, "SetFunctionArgType: couldn't find tuple for function %u",
653+
funcOid);
654+
procForm = (Form_pg_proc) GETSTRUCT(tup);
655+
656+
if (argIndex < 0 || argIndex >= procForm->pronargs ||
657+
procForm->proargtypes[argIndex] != OPAQUEOID)
658+
elog(ERROR, "SetFunctionArgType: function %u doesn't take OPAQUE",
659+
funcOid);
660+
661+
/* okay to overwrite copied tuple */
662+
procForm->proargtypes[argIndex] = newArgType;
663+
664+
/* update the catalog and its indexes */
665+
simple_heap_update(pg_proc_rel, &tup->t_self, tup);
666+
667+
CatalogUpdateIndexes(pg_proc_rel, tup);
668+
669+
heap_close(pg_proc_rel, RowExclusiveLock);
670+
}
671+
672+
594673

595674
/*
596675
* CREATE CAST

‎src/backend/commands/proclang.c

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* Portions Copyright (c) 1994, Regents of the University of California
88
*
99
* IDENTIFICATION
10-
* $Header: /cvsroot/pgsql/src/backend/commands/proclang.c,v 1.42 2002/09/04 20:31:15 momjian Exp $
10+
* $Header: /cvsroot/pgsql/src/backend/commands/proclang.c,v 1.43 2002/09/21 18:39:25 tgl Exp $
1111
*
1212
*-------------------------------------------------------------------------
1313
*/
@@ -43,6 +43,7 @@ CreateProceduralLanguage(CreatePLangStmt *stmt)
4343
char languageName[NAMEDATALEN];
4444
Oid procOid,
4545
valProcOid;
46+
Oid funcrettype;
4647
Oid typev[FUNC_MAX_ARGS];
4748
char nulls[Natts_pg_language];
4849
Datum values[Natts_pg_language];
@@ -80,10 +81,24 @@ CreateProceduralLanguage(CreatePLangStmt *stmt)
8081
if (!OidIsValid(procOid))
8182
elog(ERROR, "function %s() doesn't exist",
8283
NameListToString(stmt->plhandler));
83-
if (get_func_rettype(procOid) != LANGUAGE_HANDLEROID)
84-
elog(ERROR, "function %s() does not return type %s",
85-
NameListToString(stmt->plhandler),
86-
format_type_be(LANGUAGE_HANDLEROID));
84+
funcrettype = get_func_rettype(procOid);
85+
if (funcrettype != LANGUAGE_HANDLEROID)
86+
{
87+
/*
88+
* We allow OPAQUE just so we can load old dump files. When we
89+
* see a handler function declared OPAQUE, change it to
90+
* LANGUAGE_HANDLER.
91+
*/
92+
if (funcrettype == OPAQUEOID)
93+
{
94+
elog(NOTICE, "CreateProceduralLanguage: changing return type of function %s() from OPAQUE to LANGUAGE_HANDLER",
95+
NameListToString(stmt->plhandler));
96+
SetFunctionReturnType(procOid, LANGUAGE_HANDLEROID);
97+
}
98+
else
99+
elog(ERROR, "CreateProceduralLanguage: function %s() must return LANGUAGE_HANDLER",
100+
NameListToString(stmt->plhandler));
101+
}
87102

88103
/* validate the validator function */
89104
if (stmt->plvalidator)

‎src/backend/commands/trigger.c

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* Portions Copyright (c) 1994, Regents of the University of California
88
*
99
* IDENTIFICATION
10-
* $Header: /cvsroot/pgsql/src/backend/commands/trigger.c,v 1.131 2002/09/04 20:31:15 momjian Exp $
10+
* $Header: /cvsroot/pgsql/src/backend/commands/trigger.c,v 1.132 2002/09/21 18:39:25 tgl Exp $
1111
*
1212
*-------------------------------------------------------------------------
1313
*/
@@ -24,6 +24,7 @@
2424
#include "catalog/pg_proc.h"
2525
#include "catalog/pg_trigger.h"
2626
#include "catalog/pg_type.h"
27+
#include "commands/defrem.h"
2728
#include "commands/trigger.h"
2829
#include "executor/executor.h"
2930
#include "miscadmin.h"
@@ -75,6 +76,7 @@ CreateTrigger(CreateTrigStmt *stmt, bool forConstraint)
7576
HeapTuple tuple;
7677
Oid fargtypes[FUNC_MAX_ARGS];
7778
Oid funcoid;
79+
Oid funcrettype;
7880
Oid trigoid;
7981
int found = 0;
8082
int i;
@@ -217,22 +219,23 @@ CreateTrigger(CreateTrigStmt *stmt, bool forConstraint)
217219
if (!OidIsValid(funcoid))
218220
elog(ERROR, "CreateTrigger: function %s() does not exist",
219221
NameListToString(stmt->funcname));
220-
tuple = SearchSysCache(PROCOID,
221-
ObjectIdGetDatum(funcoid),
222-
0, 0, 0);
223-
if (!HeapTupleIsValid(tuple))
224-
elog(ERROR, "CreateTrigger: function %s() does not exist",
225-
NameListToString(stmt->funcname));
226-
if (((Form_pg_proc) GETSTRUCT(tuple))->prorettype != TRIGGEROID)
222+
funcrettype = get_func_rettype(funcoid);
223+
if (funcrettype != TRIGGEROID)
227224
{
228-
/* OPAQUE is deprecated, but allowed for backwards compatibility */
229-
if (((Form_pg_proc) GETSTRUCT(tuple))->prorettype == OPAQUEOID)
230-
elog(NOTICE, "CreateTrigger: OPAQUE is deprecated, use type TRIGGER instead to define trigger functions");
225+
/*
226+
* We allow OPAQUE just so we can load old dump files. When we
227+
* see a trigger function declared OPAQUE, change it to TRIGGER.
228+
*/
229+
if (funcrettype == OPAQUEOID)
230+
{
231+
elog(NOTICE, "CreateTrigger: changing return type of function %s() from OPAQUE to TRIGGER",
232+
NameListToString(stmt->funcname));
233+
SetFunctionReturnType(funcoid, TRIGGEROID);
234+
}
231235
else
232236
elog(ERROR, "CreateTrigger: function %s() must return TRIGGER",
233237
NameListToString(stmt->funcname));
234238
}
235-
ReleaseSysCache(tuple);
236239

237240
/*
238241
* Build the new pg_trigger tuple.

0 commit comments

Comments
 (0)