mirror of
https://git.postgresql.org/git/postgresql.git
synced 2024-08-30 16:27:20 +02:00
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.
189 lines
5.7 KiB
SQL
189 lines
5.7 KiB
SQL
/* contrib/pg_trgm/pg_trgm--1.2.sql */
|
|
|
|
-- complain if script is sourced in psql, rather than via CREATE EXTENSION
|
|
\echo Use "CREATE EXTENSION pg_trgm" to load this file. \quit
|
|
|
|
CREATE FUNCTION set_limit(float4)
|
|
RETURNS float4
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT VOLATILE;
|
|
|
|
CREATE FUNCTION show_limit()
|
|
RETURNS float4
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT STABLE;
|
|
|
|
CREATE FUNCTION show_trgm(text)
|
|
RETURNS _text
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT IMMUTABLE;
|
|
|
|
CREATE FUNCTION similarity(text,text)
|
|
RETURNS float4
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT IMMUTABLE;
|
|
|
|
CREATE FUNCTION similarity_op(text,text)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT STABLE; -- stable because depends on trgm_limit
|
|
|
|
CREATE OPERATOR % (
|
|
LEFTARG = text,
|
|
RIGHTARG = text,
|
|
PROCEDURE = similarity_op,
|
|
COMMUTATOR = '%',
|
|
RESTRICT = contsel,
|
|
JOIN = contjoinsel
|
|
);
|
|
|
|
CREATE FUNCTION similarity_dist(text,text)
|
|
RETURNS float4
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT IMMUTABLE;
|
|
|
|
CREATE OPERATOR <-> (
|
|
LEFTARG = text,
|
|
RIGHTARG = text,
|
|
PROCEDURE = similarity_dist,
|
|
COMMUTATOR = '<->'
|
|
);
|
|
|
|
-- gist key
|
|
CREATE FUNCTION gtrgm_in(cstring)
|
|
RETURNS gtrgm
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT IMMUTABLE;
|
|
|
|
CREATE FUNCTION gtrgm_out(gtrgm)
|
|
RETURNS cstring
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C STRICT IMMUTABLE;
|
|
|
|
CREATE TYPE gtrgm (
|
|
INTERNALLENGTH = -1,
|
|
INPUT = gtrgm_in,
|
|
OUTPUT = gtrgm_out
|
|
);
|
|
|
|
-- support functions for gist
|
|
CREATE FUNCTION gtrgm_consistent(internal,text,smallint,oid,internal)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gtrgm_distance(internal,text,smallint,oid,internal)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gtrgm_compress(internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gtrgm_decompress(internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gtrgm_penalty(internal,internal,internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gtrgm_picksplit(internal, internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gtrgm_union(internal, internal)
|
|
RETURNS gtrgm
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gtrgm_same(gtrgm, gtrgm, internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
-- create the operator class for gist
|
|
CREATE OPERATOR CLASS gist_trgm_ops
|
|
FOR TYPE text USING gist
|
|
AS
|
|
OPERATOR 1 % (text, text),
|
|
FUNCTION 1 gtrgm_consistent (internal, text, smallint, oid, internal),
|
|
FUNCTION 2 gtrgm_union (internal, internal),
|
|
FUNCTION 3 gtrgm_compress (internal),
|
|
FUNCTION 4 gtrgm_decompress (internal),
|
|
FUNCTION 5 gtrgm_penalty (internal, internal, internal),
|
|
FUNCTION 6 gtrgm_picksplit (internal, internal),
|
|
FUNCTION 7 gtrgm_same (gtrgm, gtrgm, internal),
|
|
STORAGE gtrgm;
|
|
|
|
-- Add operators and support functions that are new in 9.1. We do it like
|
|
-- this, leaving them "loose" in the operator family rather than bound into
|
|
-- the gist_trgm_ops opclass, because that's the only state that can be
|
|
-- reproduced during an upgrade from 9.0 (see pg_trgm--unpackaged--1.0.sql).
|
|
|
|
ALTER OPERATOR FAMILY gist_trgm_ops USING gist ADD
|
|
OPERATOR 2 <-> (text, text) FOR ORDER BY pg_catalog.float_ops,
|
|
OPERATOR 3 pg_catalog.~~ (text, text),
|
|
OPERATOR 4 pg_catalog.~~* (text, text),
|
|
FUNCTION 8 (text, text) gtrgm_distance (internal, text, smallint, oid, internal);
|
|
|
|
-- Add operators that are new in 9.3.
|
|
|
|
ALTER OPERATOR FAMILY gist_trgm_ops USING gist ADD
|
|
OPERATOR 5 pg_catalog.~ (text, text),
|
|
OPERATOR 6 pg_catalog.~* (text, text);
|
|
|
|
-- support functions for gin
|
|
CREATE FUNCTION gin_extract_value_trgm(text, internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gin_extract_query_trgm(text, internal, int2, internal, internal, internal, internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION gin_trgm_consistent(internal, int2, text, int4, internal, internal, internal, internal)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
-- create the operator class for gin
|
|
CREATE OPERATOR CLASS gin_trgm_ops
|
|
FOR TYPE text USING gin
|
|
AS
|
|
OPERATOR 1 % (text, text),
|
|
FUNCTION 1 btint4cmp (int4, int4),
|
|
FUNCTION 2 gin_extract_value_trgm (text, internal),
|
|
FUNCTION 3 gin_extract_query_trgm (text, internal, int2, internal, internal, internal, internal),
|
|
FUNCTION 4 gin_trgm_consistent (internal, int2, text, int4, internal, internal, internal, internal),
|
|
STORAGE int4;
|
|
|
|
-- Add operators that are new in 9.1.
|
|
|
|
ALTER OPERATOR FAMILY gin_trgm_ops USING gin ADD
|
|
OPERATOR 3 pg_catalog.~~ (text, text),
|
|
OPERATOR 4 pg_catalog.~~* (text, text);
|
|
|
|
-- Add operators that are new in 9.3.
|
|
|
|
ALTER OPERATOR FAMILY gin_trgm_ops USING gin ADD
|
|
OPERATOR 5 pg_catalog.~ (text, text),
|
|
OPERATOR 6 pg_catalog.~* (text, text);
|
|
|
|
-- Add functions that are new in 9.6 (pg_trgm 1.2).
|
|
|
|
CREATE FUNCTION gin_trgm_triconsistent(internal, int2, text, int4, internal, internal, internal)
|
|
RETURNS "char"
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
ALTER OPERATOR FAMILY gin_trgm_ops USING gin ADD
|
|
FUNCTION 6 (text,text) gin_trgm_triconsistent (internal, int2, text, int4, internal, internal, internal);
|