Skip to content

Commit 9ff6027

Browse files
tglsfdctglsfdc
committed
Fix assorted inconsistencies in GiST opclass support function declarations.
The conventions specified by the GiST SGML documentation were widely ignored. For example, the strategy-number argument for "consistent" and "distance" functions is specified to be a smallint, but most of the built-in support functions declared it as an integer, and for that matter the core code passed it using Int32GetDatum not Int16GetDatum. None of that makes any real difference at runtime, but it's quite confusing for newcomers to the code, and it makes it very hard to write an amvalidate() function that checks support function signatures. So let's try to instill some consistency here. Another similar issue is that the "query" argument is not of a single well-defined type, but could have different types depending on the strategy (corresponding to search operators with different righthand-side argument types). Some of the functions threw up their hands and declared the query argument as being of "internal" type, which surely isn't right ("any" would have been more appropriate); but the majority position seemed to be to declare it as being of the indexed data type, corresponding to a search operator with both input types the same. So I've specified a convention that that's what to do always. Also, the result of the "union" support function actually must be of the index's storage type, but the documentation suggested declaring it to return "internal", and some of the functions followed that. Standardize on telling the truth, instead. Similarly, standardize on declaring the "same" function's inputs as being of the storage type, not "internal". Also, somebody had forgotten to add the "recheck" argument to both the documentation of the "distance" support function and all of their SQL declarations, even though the C code was happily using that argument. Clean that up too. Fix up some other omissions in the docs too, such as documenting that union's second input argument is vestigial. So far as the errors in core function declarations go, we can just fix pg_proc.h and bump catversion. Adjusting the erroneous declarations in contrib modules is more debatable: in principle any change in those scripts should involve an extension version bump, which is a pain. However, since these changes are purely cosmetic and make no functional difference, I think we can get away without doing that.
1 parent 53c949c commit 9ff6027

File tree

18 files changed

+266
-193
lines changed

18 files changed

+266
-193
lines changed

‎contrib/btree_gist/btree_gist--1.1.sql

Lines changed: 103 additions & 103 deletions
Large diffs are not rendered by default.

‎contrib/cube/cube--1.1.sql

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ CREATE OPERATOR ~ (
304304

305305

306306
-- define the GiST support methods
307-
CREATE FUNCTION g_cube_consistent(internal,cube,int,oid,internal)
307+
CREATE FUNCTION g_cube_consistent(internal,cube,smallint,oid,internal)
308308
RETURNS bool
309309
AS 'MODULE_PATHNAME'
310310
LANGUAGE C IMMUTABLE STRICT;
@@ -339,8 +339,8 @@ RETURNS internal
339339
AS 'MODULE_PATHNAME'
340340
LANGUAGE C IMMUTABLE STRICT;
341341

342-
CREATE FUNCTION g_cube_distance (internal, cube, smallint, oid)
343-
RETURNS internal
342+
CREATE FUNCTION g_cube_distance (internal, cube, smallint, oid, internal)
343+
RETURNS float8
344344
AS 'MODULE_PATHNAME'
345345
LANGUAGE C IMMUTABLE STRICT;
346346

@@ -368,11 +368,11 @@ CREATE OPERATOR CLASS gist_cube_ops
368368
OPERATOR 17 <-> (cube, cube) FOR ORDER BY float_ops,
369369
OPERATOR 18 <=> (cube, cube) FOR ORDER BY float_ops,
370370

371-
FUNCTION 1 g_cube_consistent (internal, cube, int, oid, internal),
371+
FUNCTION 1 g_cube_consistent (internal, cube, smallint, oid, internal),
372372
FUNCTION 2 g_cube_union (internal, internal),
373373
FUNCTION 3 g_cube_compress (internal),
374374
FUNCTION 4 g_cube_decompress (internal),
375375
FUNCTION 5 g_cube_penalty (internal, internal, internal),
376376
FUNCTION 6 g_cube_picksplit (internal, internal),
377377
FUNCTION 7 g_cube_same (cube, cube, internal),
378-
FUNCTION 8 g_cube_distance (internal, cube, smallint, oid);
378+
FUNCTION 8 g_cube_distance (internal, cube, smallint, oid, internal);

‎contrib/hstore/hstore--1.3.sql

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -486,16 +486,16 @@ AS 'MODULE_PATHNAME'
486486
LANGUAGE C IMMUTABLE STRICT;
487487

488488
CREATE FUNCTION ghstore_union(internal, internal)
489-
RETURNS internal
489+
RETURNS ghstore
490490
AS 'MODULE_PATHNAME'
491491
LANGUAGE C IMMUTABLE STRICT;
492492

493-
CREATE FUNCTION ghstore_same(internal, internal, internal)
493+
CREATE FUNCTION ghstore_same(ghstore, ghstore, internal)
494494
RETURNS internal
495495
AS 'MODULE_PATHNAME'
496496
LANGUAGE C IMMUTABLE STRICT;
497497

498-
CREATE FUNCTION ghstore_consistent(internal,internal,int,oid,internal)
498+
CREATE FUNCTION ghstore_consistent(internal,hstore,smallint,oid,internal)
499499
RETURNS bool
500500
AS 'MODULE_PATHNAME'
501501
LANGUAGE C IMMUTABLE STRICT;
@@ -510,13 +510,13 @@ AS
510510
--OPERATOR 8 <@ ,
511511
OPERATOR 13 @ ,
512512
--OPERATOR 14 ~ ,
513-
FUNCTION 1 ghstore_consistent (internal, internal, int, oid, internal),
513+
FUNCTION 1 ghstore_consistent (internal, hstore, smallint, oid, internal),
514514
FUNCTION 2 ghstore_union (internal, internal),
515515
FUNCTION 3 ghstore_compress (internal),
516516
FUNCTION 4 ghstore_decompress (internal),
517517
FUNCTION 5 ghstore_penalty (internal, internal, internal),
518518
FUNCTION 6 ghstore_picksplit (internal, internal),
519-
FUNCTION 7 ghstore_same (internal, internal, internal),
519+
FUNCTION 7 ghstore_same (ghstore, ghstore, internal),
520520
STORAGE ghstore;
521521

522522
-- GIN support

‎contrib/intarray/intarray--1.1.sql

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ CREATE OPERATOR & (
358358
--------------
359359

360360
-- define the GiST support methods
361-
CREATE FUNCTION g_int_consistent(internal,_int4,int,oid,internal)
361+
CREATE FUNCTION g_int_consistent(internal,_int4,smallint,oid,internal)
362362
RETURNS bool
363363
AS 'MODULE_PATHNAME'
364364
LANGUAGE C IMMUTABLE STRICT;
@@ -405,7 +405,7 @@ DEFAULT FOR TYPE _int4 USING gist AS
405405
OPERATOR 13 @,
406406
OPERATOR 14 ~,
407407
OPERATOR 20 @@ (_int4, query_int),
408-
FUNCTION 1 g_int_consistent (internal, _int4, int, oid, internal),
408+
FUNCTION 1 g_int_consistent (internal, _int4, smallint, oid, internal),
409409
FUNCTION 2 g_int_union (internal, internal),
410410
FUNCTION 3 g_int_compress (internal),
411411
FUNCTION 4 g_int_decompress (internal),
@@ -435,7 +435,7 @@ CREATE TYPE intbig_gkey (
435435
OUTPUT = _intbig_out
436436
);
437437

438-
CREATE FUNCTION g_intbig_consistent(internal,internal,int,oid,internal)
438+
CREATE FUNCTION g_intbig_consistent(internal,_int4,smallint,oid,internal)
439439
RETURNS bool
440440
AS 'MODULE_PATHNAME'
441441
LANGUAGE C IMMUTABLE STRICT;
@@ -461,11 +461,11 @@ AS 'MODULE_PATHNAME'
461461
LANGUAGE C IMMUTABLE STRICT;
462462

463463
CREATE FUNCTION g_intbig_union(internal, internal)
464-
RETURNS _int4
464+
RETURNS intbig_gkey
465465
AS 'MODULE_PATHNAME'
466466
LANGUAGE C IMMUTABLE STRICT;
467467

468-
CREATE FUNCTION g_intbig_same(internal, internal, internal)
468+
CREATE FUNCTION g_intbig_same(intbig_gkey, intbig_gkey, internal)
469469
RETURNS internal
470470
AS 'MODULE_PATHNAME'
471471
LANGUAGE C IMMUTABLE STRICT;
@@ -482,13 +482,13 @@ AS
482482
OPERATOR 13 @,
483483
OPERATOR 14 ~,
484484
OPERATOR 20 @@ (_int4, query_int),
485-
FUNCTION 1 g_intbig_consistent (internal, internal, int, oid, internal),
485+
FUNCTION 1 g_intbig_consistent (internal, _int4, smallint, oid, internal),
486486
FUNCTION 2 g_intbig_union (internal, internal),
487487
FUNCTION 3 g_intbig_compress (internal),
488488
FUNCTION 4 g_intbig_decompress (internal),
489489
FUNCTION 5 g_intbig_penalty (internal, internal, internal),
490490
FUNCTION 6 g_intbig_picksplit (internal, internal),
491-
FUNCTION 7 g_intbig_same (internal, internal, internal),
491+
FUNCTION 7 g_intbig_same (intbig_gkey, intbig_gkey, internal),
492492
STORAGE intbig_gkey;
493493

494494
--GIN

‎contrib/ltree/ltree--1.0.sql

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ CREATE TYPE ltree_gist (
496496
);
497497

498498

499-
CREATE FUNCTION ltree_consistent(internal,internal,int2,oid,internal)
499+
CREATE FUNCTION ltree_consistent(internal,ltree,int2,oid,internal)
500500
RETURNS bool as 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT;
501501

502502
CREATE FUNCTION ltree_compress(internal)
@@ -512,9 +512,9 @@ CREATE FUNCTION ltree_picksplit(internal, internal)
512512
RETURNS internal as 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT;
513513

514514
CREATE FUNCTION ltree_union(internal, internal)
515-
RETURNS int4 as 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT;
515+
RETURNS ltree_gist as 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT;
516516

517-
CREATE FUNCTION ltree_same(internal, internal, internal)
517+
CREATE FUNCTION ltree_same(ltree_gist, ltree_gist, internal)
518518
RETURNS internal as 'MODULE_PATHNAME' LANGUAGE C IMMUTABLE STRICT;
519519

520520
CREATE OPERATOR CLASS gist_ltree_ops
@@ -532,13 +532,13 @@ CREATE OPERATOR CLASS gist_ltree_ops
532532
OPERATOR 15 @ (ltxtquery, ltree) ,
533533
OPERATOR 16 ? (ltree, _lquery) ,
534534
OPERATOR 17 ? (_lquery, ltree) ,
535-
FUNCTION 1 ltree_consistent (internal, internal, int2, oid, internal),
535+
FUNCTION 1 ltree_consistent (internal, ltree, int2, oid, internal),
536536
FUNCTION 2 ltree_union (internal, internal),
537537
FUNCTION 3 ltree_compress (internal),
538538
FUNCTION 4 ltree_decompress (internal),
539539
FUNCTION 5 ltree_penalty (internal, internal, internal),
540540
FUNCTION 6 ltree_picksplit (internal, internal),
541-
FUNCTION 7 ltree_same (internal, internal, internal),
541+
FUNCTION 7 ltree_same (ltree_gist, ltree_gist, internal),
542542
STORAGE ltree_gist;
543543

544544

@@ -822,7 +822,7 @@ CREATE OPERATOR ?@ (
822822
);
823823

824824
--GiST support for ltree[]
825-
CREATE FUNCTION _ltree_consistent(internal,internal,int2,oid,internal)
825+
CREATE FUNCTION _ltree_consistent(internal,_ltree,int2,oid,internal)
826826
RETURNS bool
827827
AS 'MODULE_PATHNAME'
828828
LANGUAGE C IMMUTABLE STRICT;
@@ -843,11 +843,11 @@ AS 'MODULE_PATHNAME'
843843
LANGUAGE C IMMUTABLE STRICT;
844844

845845
CREATE FUNCTION _ltree_union(internal, internal)
846-
RETURNS int4
846+
RETURNS ltree_gist
847847
AS 'MODULE_PATHNAME'
848848
LANGUAGE C IMMUTABLE STRICT;
849849

850-
CREATE FUNCTION _ltree_same(internal, internal, internal)
850+
CREATE FUNCTION _ltree_same(ltree_gist, ltree_gist, internal)
851851
RETURNS internal
852852
AS 'MODULE_PATHNAME'
853853
LANGUAGE C IMMUTABLE STRICT;
@@ -862,11 +862,11 @@ CREATE OPERATOR CLASS gist__ltree_ops
862862
OPERATOR 15 @ (ltxtquery, _ltree),
863863
OPERATOR 16 ? (_ltree, _lquery),
864864
OPERATOR 17 ? (_lquery, _ltree),
865-
FUNCTION 1 _ltree_consistent (internal, internal, int2, oid, internal),
865+
FUNCTION 1 _ltree_consistent (internal, _ltree, int2, oid, internal),
866866
FUNCTION 2 _ltree_union (internal, internal),
867867
FUNCTION 3 _ltree_compress (internal),
868868
FUNCTION 4 ltree_decompress (internal),
869869
FUNCTION 5 _ltree_penalty (internal, internal, internal),
870870
FUNCTION 6 _ltree_picksplit (internal, internal),
871-
FUNCTION 7 _ltree_same (internal, internal, internal),
871+
FUNCTION 7 _ltree_same (ltree_gist, ltree_gist, internal),
872872
STORAGE ltree_gist;

‎contrib/pg_trgm/pg_trgm--1.2.sql

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,12 @@ CREATE TYPE gtrgm (
6767
);
6868

6969
-- support functions for gist
70-
CREATE FUNCTION gtrgm_consistent(internal,text,int,oid,internal)
70+
CREATE FUNCTION gtrgm_consistent(internal,text,smallint,oid,internal)
7171
RETURNS bool
7272
AS 'MODULE_PATHNAME'
7373
LANGUAGE C IMMUTABLE STRICT;
7474

75-
CREATE FUNCTION gtrgm_distance(internal,text,int,oid)
75+
CREATE FUNCTION gtrgm_distance(internal,text,smallint,oid,internal)
7676
RETURNS float8
7777
AS 'MODULE_PATHNAME'
7878
LANGUAGE C IMMUTABLE STRICT;
@@ -97,8 +97,8 @@ RETURNS internal
9797
AS 'MODULE_PATHNAME'
9898
LANGUAGE C IMMUTABLE STRICT;
9999

100-
CREATE FUNCTION gtrgm_union(bytea, internal)
101-
RETURNS _int4
100+
CREATE FUNCTION gtrgm_union(internal, internal)
101+
RETURNS gtrgm
102102
AS 'MODULE_PATHNAME'
103103
LANGUAGE C IMMUTABLE STRICT;
104104

@@ -112,8 +112,8 @@ CREATE OPERATOR CLASS gist_trgm_ops
112112
FOR TYPE text USING gist
113113
AS
114114
OPERATOR 1 % (text, text),
115-
FUNCTION 1 gtrgm_consistent (internal, text, int, oid, internal),
116-
FUNCTION 2 gtrgm_union (bytea, internal),
115+
FUNCTION 1 gtrgm_consistent (internal, text, smallint, oid, internal),
116+
FUNCTION 2 gtrgm_union (internal, internal),
117117
FUNCTION 3 gtrgm_compress (internal),
118118
FUNCTION 4 gtrgm_decompress (internal),
119119
FUNCTION 5 gtrgm_penalty (internal, internal, internal),
@@ -130,7 +130,7 @@ ALTER OPERATOR FAMILY gist_trgm_ops USING gist ADD
130130
OPERATOR 2 <-> (text, text) FOR ORDER BY pg_catalog.float_ops,
131131
OPERATOR 3 pg_catalog.~~ (text, text),
132132
OPERATOR 4 pg_catalog.~~* (text, text),
133-
FUNCTION 8 (text, text) gtrgm_distance (internal, text, int, oid);
133+
FUNCTION 8 (text, text) gtrgm_distance (internal, text, smallint, oid, internal);
134134

135135
-- Add operators that are new in 9.3.
136136

‎contrib/seg/seg--1.0.sql

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ CREATE OPERATOR ~ (
326326

327327

328328
-- define the GiST support methods
329-
CREATE FUNCTION gseg_consistent(internal,seg,int,oid,internal)
329+
CREATE FUNCTION gseg_consistent(internal,seg,smallint,oid,internal)
330330
RETURNS bool
331331
AS 'MODULE_PATHNAME'
332332
LANGUAGE C IMMUTABLE STRICT;
@@ -386,7 +386,7 @@ AS
386386
OPERATOR 8 <@ ,
387387
OPERATOR 13 @ ,
388388
OPERATOR 14 ~ ,
389-
FUNCTION 1 gseg_consistent (internal, seg, int, oid, internal),
389+
FUNCTION 1 gseg_consistent (internal, seg, smallint, oid, internal),
390390
FUNCTION 2 gseg_union (internal, internal),
391391
FUNCTION 3 gseg_compress (internal),
392392
FUNCTION 4 gseg_decompress (internal),

‎contrib/tsearch2/tsearch2--1.0.sql

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ CREATE OPERATOR CLASS gist_tsvector_ops
389389
FOR TYPE tsvector USING gist
390390
AS
391391
OPERATOR 1 @@ (tsvector, tsquery),
392-
FUNCTION 1 gtsvector_consistent (internal, gtsvector, int, oid, internal),
392+
FUNCTION 1 gtsvector_consistent (internal, tsvector, smallint, oid, internal),
393393
FUNCTION 2 gtsvector_union (internal, internal),
394394
FUNCTION 3 gtsvector_compress (internal),
395395
FUNCTION 4 gtsvector_decompress (internal),
@@ -536,7 +536,7 @@ FOR TYPE tsquery USING gist
536536
AS
537537
OPERATOR 7 @> (tsquery, tsquery),
538538
OPERATOR 8 <@ (tsquery, tsquery),
539-
FUNCTION 1 gtsquery_consistent (internal, internal, int, oid, internal),
539+
FUNCTION 1 gtsquery_consistent (internal, tsquery, smallint, oid, internal),
540540
FUNCTION 2 gtsquery_union (internal, internal),
541541
FUNCTION 3 gtsquery_compress (internal),
542542
FUNCTION 4 gtsquery_decompress (internal),

0 commit comments

Comments
 (0)