mirror of
https://git.postgresql.org/git/postgresql.git
synced 2024-09-05 08:49: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.
379 lines
9.0 KiB
SQL
379 lines
9.0 KiB
SQL
/* contrib/cube/cube--1.1.sql */
|
|
|
|
-- complain if script is sourced in psql, rather than via CREATE EXTENSION
|
|
\echo Use "CREATE EXTENSION cube" to load this file. \quit
|
|
|
|
-- Create the user-defined type for N-dimensional boxes
|
|
|
|
CREATE FUNCTION cube_in(cstring)
|
|
RETURNS cube
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube(float8[], float8[]) RETURNS cube
|
|
AS 'MODULE_PATHNAME', 'cube_a_f8_f8'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube(float8[]) RETURNS cube
|
|
AS 'MODULE_PATHNAME', 'cube_a_f8'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube_out(cube)
|
|
RETURNS cstring
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE TYPE cube (
|
|
INTERNALLENGTH = variable,
|
|
INPUT = cube_in,
|
|
OUTPUT = cube_out,
|
|
ALIGNMENT = double
|
|
);
|
|
|
|
COMMENT ON TYPE cube IS 'multi-dimensional cube ''(FLOAT-1, FLOAT-2, ..., FLOAT-N), (FLOAT-1, FLOAT-2, ..., FLOAT-N)''';
|
|
|
|
--
|
|
-- External C-functions for R-tree methods
|
|
--
|
|
|
|
-- Comparison methods
|
|
|
|
CREATE FUNCTION cube_eq(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_eq(cube, cube) IS 'same as';
|
|
|
|
CREATE FUNCTION cube_ne(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_ne(cube, cube) IS 'different';
|
|
|
|
CREATE FUNCTION cube_lt(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_lt(cube, cube) IS 'lower than';
|
|
|
|
CREATE FUNCTION cube_gt(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_gt(cube, cube) IS 'greater than';
|
|
|
|
CREATE FUNCTION cube_le(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_le(cube, cube) IS 'lower than or equal to';
|
|
|
|
CREATE FUNCTION cube_ge(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_ge(cube, cube) IS 'greater than or equal to';
|
|
|
|
CREATE FUNCTION cube_cmp(cube, cube)
|
|
RETURNS int4
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_cmp(cube, cube) IS 'btree comparison function';
|
|
|
|
CREATE FUNCTION cube_contains(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_contains(cube, cube) IS 'contains';
|
|
|
|
CREATE FUNCTION cube_contained(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_contained(cube, cube) IS 'contained in';
|
|
|
|
CREATE FUNCTION cube_overlap(cube, cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
COMMENT ON FUNCTION cube_overlap(cube, cube) IS 'overlaps';
|
|
|
|
-- support routines for indexing
|
|
|
|
CREATE FUNCTION cube_union(cube, cube)
|
|
RETURNS cube
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube_inter(cube, cube)
|
|
RETURNS cube
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube_size(cube)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
|
|
-- Misc N-dimensional functions
|
|
|
|
CREATE FUNCTION cube_subset(cube, int4[])
|
|
RETURNS cube
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
-- proximity routines
|
|
|
|
CREATE FUNCTION cube_distance(cube, cube)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION distance_chebyshev(cube, cube)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION distance_taxicab(cube, cube)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
-- Extracting elements functions
|
|
|
|
CREATE FUNCTION cube_dim(cube)
|
|
RETURNS int4
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube_ll_coord(cube, int4)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube_ur_coord(cube, int4)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube_coord(cube, int4)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube_coord_llur(cube, int4)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube(float8) RETURNS cube
|
|
AS 'MODULE_PATHNAME', 'cube_f8'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube(float8, float8) RETURNS cube
|
|
AS 'MODULE_PATHNAME', 'cube_f8_f8'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube(cube, float8) RETURNS cube
|
|
AS 'MODULE_PATHNAME', 'cube_c_f8'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION cube(cube, float8, float8) RETURNS cube
|
|
AS 'MODULE_PATHNAME', 'cube_c_f8_f8'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
-- Test if cube is also a point
|
|
|
|
CREATE FUNCTION cube_is_point(cube)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
-- Increasing the size of a cube by a radius in at least n dimensions
|
|
|
|
CREATE FUNCTION cube_enlarge(cube, float8, int4)
|
|
RETURNS cube
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
--
|
|
-- OPERATORS
|
|
--
|
|
|
|
CREATE OPERATOR < (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_lt,
|
|
COMMUTATOR = '>', NEGATOR = '>=',
|
|
RESTRICT = scalarltsel, JOIN = scalarltjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR > (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_gt,
|
|
COMMUTATOR = '<', NEGATOR = '<=',
|
|
RESTRICT = scalargtsel, JOIN = scalargtjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR <= (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_le,
|
|
COMMUTATOR = '>=', NEGATOR = '>',
|
|
RESTRICT = scalarltsel, JOIN = scalarltjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR >= (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_ge,
|
|
COMMUTATOR = '<=', NEGATOR = '<',
|
|
RESTRICT = scalargtsel, JOIN = scalargtjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR && (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_overlap,
|
|
COMMUTATOR = '&&',
|
|
RESTRICT = areasel, JOIN = areajoinsel
|
|
);
|
|
|
|
CREATE OPERATOR = (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_eq,
|
|
COMMUTATOR = '=', NEGATOR = '<>',
|
|
RESTRICT = eqsel, JOIN = eqjoinsel,
|
|
MERGES
|
|
);
|
|
|
|
CREATE OPERATOR <> (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_ne,
|
|
COMMUTATOR = '<>', NEGATOR = '=',
|
|
RESTRICT = neqsel, JOIN = neqjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR @> (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_contains,
|
|
COMMUTATOR = '<@',
|
|
RESTRICT = contsel, JOIN = contjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR <@ (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_contained,
|
|
COMMUTATOR = '@>',
|
|
RESTRICT = contsel, JOIN = contjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR -> (
|
|
LEFTARG = cube, RIGHTARG = int, PROCEDURE = cube_coord
|
|
);
|
|
|
|
CREATE OPERATOR ~> (
|
|
LEFTARG = cube, RIGHTARG = int, PROCEDURE = cube_coord_llur
|
|
);
|
|
|
|
CREATE OPERATOR <#> (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = distance_taxicab,
|
|
COMMUTATOR = '<#>'
|
|
);
|
|
|
|
CREATE OPERATOR <-> (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_distance,
|
|
COMMUTATOR = '<->'
|
|
);
|
|
|
|
CREATE OPERATOR <=> (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = distance_chebyshev,
|
|
COMMUTATOR = '<=>'
|
|
);
|
|
|
|
-- these are obsolete/deprecated:
|
|
CREATE OPERATOR @ (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_contains,
|
|
COMMUTATOR = '~',
|
|
RESTRICT = contsel, JOIN = contjoinsel
|
|
);
|
|
|
|
CREATE OPERATOR ~ (
|
|
LEFTARG = cube, RIGHTARG = cube, PROCEDURE = cube_contained,
|
|
COMMUTATOR = '@',
|
|
RESTRICT = contsel, JOIN = contjoinsel
|
|
);
|
|
|
|
|
|
-- define the GiST support methods
|
|
CREATE FUNCTION g_cube_consistent(internal,cube,smallint,oid,internal)
|
|
RETURNS bool
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION g_cube_compress(internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION g_cube_decompress(internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION g_cube_penalty(internal,internal,internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION g_cube_picksplit(internal, internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION g_cube_union(internal, internal)
|
|
RETURNS cube
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION g_cube_same(cube, cube, internal)
|
|
RETURNS internal
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
CREATE FUNCTION g_cube_distance (internal, cube, smallint, oid, internal)
|
|
RETURNS float8
|
|
AS 'MODULE_PATHNAME'
|
|
LANGUAGE C IMMUTABLE STRICT;
|
|
|
|
-- Create the operator classes for indexing
|
|
|
|
CREATE OPERATOR CLASS cube_ops
|
|
DEFAULT FOR TYPE cube USING btree AS
|
|
OPERATOR 1 < ,
|
|
OPERATOR 2 <= ,
|
|
OPERATOR 3 = ,
|
|
OPERATOR 4 >= ,
|
|
OPERATOR 5 > ,
|
|
FUNCTION 1 cube_cmp(cube, cube);
|
|
|
|
CREATE OPERATOR CLASS gist_cube_ops
|
|
DEFAULT FOR TYPE cube USING gist AS
|
|
OPERATOR 3 && ,
|
|
OPERATOR 6 = ,
|
|
OPERATOR 7 @> ,
|
|
OPERATOR 8 <@ ,
|
|
OPERATOR 13 @ ,
|
|
OPERATOR 14 ~ ,
|
|
OPERATOR 15 ~> (cube, int) FOR ORDER BY float_ops,
|
|
OPERATOR 16 <#> (cube, cube) FOR ORDER BY float_ops,
|
|
OPERATOR 17 <-> (cube, cube) FOR ORDER BY float_ops,
|
|
OPERATOR 18 <=> (cube, cube) FOR ORDER BY float_ops,
|
|
|
|
FUNCTION 1 g_cube_consistent (internal, cube, smallint, oid, internal),
|
|
FUNCTION 2 g_cube_union (internal, internal),
|
|
FUNCTION 3 g_cube_compress (internal),
|
|
FUNCTION 4 g_cube_decompress (internal),
|
|
FUNCTION 5 g_cube_penalty (internal, internal, internal),
|
|
FUNCTION 6 g_cube_picksplit (internal, internal),
|
|
FUNCTION 7 g_cube_same (cube, cube, internal),
|
|
FUNCTION 8 g_cube_distance (internal, cube, smallint, oid, internal);
|