mirror/postgresql
2
0
Fork 0
mirror of https://git.postgresql.org/git/postgresql.git synced 2025-02-17 19:30:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add stratnum GiST support function

Browse Source 
This is support function 12 for the GiST AM and translates
"well-known" RT*StrategyNumber values into whatever strategy number is
used by the opclass (since no particular numbers are actually
required).  We will use this to support temporal PRIMARY
KEY/UNIQUE/FOREIGN KEY/FOR PORTION OF functionality.

This commit adds two implementations, one for internal GiST opclasses
(just an identity function) and another for btree_gist opclasses.  It
updates btree_gist from 1.7 to 1.8, adding the support function for
all its opclasses.

(previously committed as 6db4598fcb, reverted by 8aee330af55; this is
essentially unchanged from those)

Author: Paul A. Jungwirth <pj@illuminatedcomputing.com>
Reviewed-by: Peter Eisentraut <peter@eisentraut.org>
Reviewed-by: jian he <jian.universality@gmail.com>
Discussion: https://www.postgresql.org/message-id/flat/CA+renyUApHgSZF9-nd-a0+OPGharLQLO=mDHcY4_qQ0+noCUVg@mail.gmail.com
This commit is contained in:
Peter Eisentraut 2024-09-17 10:19:26 +02:00
parent 95d6e9af07
commit 7406ab623f
17 changed files with 273 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
contrib/btree_gist/Makefile
View File

@ -33,12 +33,14 @@ EXTENSION = btree_gist
DATA = btree_gist--1.0--1.1.sql \
btree_gist--1.1--1.2.sql btree_gist--1.2.sql btree_gist--1.2--1.3.sql \
btree_gist--1.3--1.4.sql btree_gist--1.4--1.5.sql \
btree_gist--1.5--1.6.sql btree_gist--1.6--1.7.sql
btree_gist--1.5--1.6.sql btree_gist--1.6--1.7.sql \
btree_gist--1.7--1.8.sql
PGFILEDESC = "btree_gist - B-tree equivalent GiST operator classes"
REGRESS = init int2 int4 int8 float4 float8 cash oid timestamp timestamptz \
time timetz date interval macaddr macaddr8 inet cidr text varchar char \
bytea bit varbit numeric uuid not_equal enum bool partitions
bytea bit varbit numeric uuid not_equal enum bool partitions \
stratnum
SHLIB_LINK += $(filter -lm, $(LIBS))

87
contrib/btree_gist/btree_gist--1.7--1.8.sql Normal file
View File

@ -0,0 +1,87 @@
/* contrib/btree_gist/btree_gist--1.7--1.8.sql */
-- complain if script is sourced in psql, rather than via CREATE EXTENSION
\echo Use "ALTER EXTENSION btree_gist UPDATE TO '1.8'" to load this file. \quit
CREATE FUNCTION gist_stratnum_btree(smallint)
RETURNS smallint
AS 'MODULE_PATHNAME'
LANGUAGE C IMMUTABLE PARALLEL SAFE STRICT;
ALTER OPERATOR FAMILY gist_oid_ops USING gist ADD
FUNCTION 12 (oid, oid) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_int2_ops USING gist ADD
FUNCTION 12 (int2, int2) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_int4_ops USING gist ADD
FUNCTION 12 (int4, int4) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_int8_ops USING gist ADD
FUNCTION 12 (int8, int8) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_float4_ops USING gist ADD
FUNCTION 12 (float4, float4) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_float8_ops USING gist ADD
FUNCTION 12 (float8, float8) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_timestamp_ops USING gist ADD
FUNCTION 12 (timestamp, timestamp) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_timestamptz_ops USING gist ADD
FUNCTION 12 (timestamptz, timestamptz) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_time_ops USING gist ADD
FUNCTION 12 (time, time) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_date_ops USING gist ADD
FUNCTION 12 (date, date) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_interval_ops USING gist ADD
FUNCTION 12 (interval, interval) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_cash_ops USING gist ADD
FUNCTION 12 (money, money) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_macaddr_ops USING gist ADD
FUNCTION 12 (macaddr, macaddr) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_text_ops USING gist ADD
FUNCTION 12 (text, text) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_bpchar_ops USING gist ADD
FUNCTION 12 (bpchar, bpchar) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_bytea_ops USING gist ADD
FUNCTION 12 (bytea, bytea) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_numeric_ops USING gist ADD
FUNCTION 12 (numeric, numeric) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_bit_ops USING gist ADD
FUNCTION 12 (bit, bit) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_vbit_ops USING gist ADD
FUNCTION 12 (varbit, varbit) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_inet_ops USING gist ADD
FUNCTION 12 (inet, inet) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_cidr_ops USING gist ADD
FUNCTION 12 (cidr, cidr) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_timetz_ops USING gist ADD
FUNCTION 12 (timetz, timetz) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_uuid_ops USING gist ADD
FUNCTION 12 (uuid, uuid) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_macaddr8_ops USING gist ADD
FUNCTION 12 (macaddr8, macaddr8) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_enum_ops USING gist ADD
FUNCTION 12 (anyenum, anyenum) gist_stratnum_btree (int2) ;
ALTER OPERATOR FAMILY gist_bool_ops USING gist ADD
FUNCTION 12 (bool, bool) gist_stratnum_btree (int2) ;

27
contrib/btree_gist/btree_gist.c
View File

@ -3,6 +3,7 @@
*/
#include "postgres.h"
#include "access/stratnum.h"
#include "utils/builtins.h"
PG_MODULE_MAGIC;
@ -10,6 +11,7 @@ PG_MODULE_MAGIC;
PG_FUNCTION_INFO_V1(gbt_decompress);
PG_FUNCTION_INFO_V1(gbtreekey_in);
PG_FUNCTION_INFO_V1(gbtreekey_out);
PG_FUNCTION_INFO_V1(gist_stratnum_btree);
/**************************************************
* In/Out for keys
@ -51,3 +53,28 @@ gbt_decompress(PG_FUNCTION_ARGS)
{
PG_RETURN_POINTER(PG_GETARG_POINTER(0));
}
/*
* Returns the btree number for supported operators, otherwise invalid.
*/
Datum
gist_stratnum_btree(PG_FUNCTION_ARGS)
{
StrategyNumber strat = PG_GETARG_UINT16(0);
switch (strat)
{
case RTEqualStrategyNumber:
PG_RETURN_UINT16(BTEqualStrategyNumber);
case RTLessStrategyNumber:
PG_RETURN_UINT16(BTLessStrategyNumber);
case RTLessEqualStrategyNumber:
PG_RETURN_UINT16(BTLessEqualStrategyNumber);
case RTGreaterStrategyNumber:
PG_RETURN_UINT16(BTGreaterStrategyNumber);
case RTGreaterEqualStrategyNumber:
PG_RETURN_UINT16(BTGreaterEqualStrategyNumber);
default:
PG_RETURN_UINT16(InvalidStrategy);
}
}

2
contrib/btree_gist/btree_gist.control
View File

@ -1,6 +1,6 @@
# btree_gist extension
comment = 'support for indexing common datatypes in GiST'
default_version = '1.7'
default_version = '1.8'
module_pathname = '$libdir/btree_gist'
relocatable = true
trusted = true

13
contrib/btree_gist/expected/stratnum.out Normal file
View File

@ -0,0 +1,13 @@
-- test stratnum support func
SELECT gist_stratnum_btree(3::smallint);
gist_stratnum_btree
---------------------
0
(1 row)
SELECT gist_stratnum_btree(18::smallint);
gist_stratnum_btree
---------------------
3
(1 row)

2
contrib/btree_gist/meson.build
View File

@ -50,6 +50,7 @@ install_data(
'btree_gist--1.4--1.5.sql',
'btree_gist--1.5--1.6.sql',
'btree_gist--1.6--1.7.sql',
'btree_gist--1.7--1.8.sql',
kwargs: contrib_data_args,
)
@ -89,6 +90,7 @@ tests += {
'enum',
'bool',
'partitions',
'stratnum',
],
},
}

3
contrib/btree_gist/sql/stratnum.sql Normal file
View File

@ -0,0 +1,3 @@
-- test stratnum support func
SELECT gist_stratnum_btree(3::smallint);
SELECT gist_stratnum_btree(18::smallint);

65
doc/src/sgml/gist.sgml
View File

@ -266,7 +266,7 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
<para>
There are five methods that an index operator class for
<acronym>GiST</acronym> must provide, and six that are optional.
<acronym>GiST</acronym> must provide, and seven that are optional.
Correctness of the index is ensured
by proper implementation of the <function>same</function>, <function>consistent</function>
and <function>union</function> methods, while efficiency (size and speed) of the
@ -289,6 +289,10 @@ CREATE INDEX ON my_table USING GIST (my_inet_column inet_ops);
user-specified parameters.
The optional eleventh method <function>sortsupport</function> is used to
speed up building a <acronym>GiST</acronym> index.
The optional twelfth method <function>stratnum</function> is used to
translate well-known <literal>RT*StrategyNumber</literal>s (from
<filename>src/include/access/stratnum.h</filename>) into strategy numbers
used by the operator class.
</para>
<variablelist>
@ -1163,6 +1167,65 @@ my_sortsupport(PG_FUNCTION_ARGS)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><function>stratnum</function></term>
<listitem>
<para>
Given an <literal>RT*StrategyNumber</literal> value from
<filename>src/include/access/stratnum.h</filename>, returns a strategy
number used by this operator class for matching functionality. The
function should return <literal>InvalidStrategy</literal> if the
operator class has no matching strategy.
</para>
<para>
The <acronym>SQL</acronym> declaration of the function must look like
this:
<programlisting>
CREATE OR REPLACE FUNCTION my_stratnum(integer)
RETURNS integer
AS 'MODULE_PATHNAME'
LANGUAGE C STRICT;
</programlisting>
</para>
<para>
The matching code in the C module could then follow this skeleton:
<programlisting>
PG_FUNCTION_INFO_V1(my_stratnum);
Datum
my_stratnum(PG_FUNCTION_ARGS)
{
StrategyNumber strategy = (StrategyNumber) PG_GETARG_UINT16(1);
StrategyNumber ret = InvalidStrategy;
switch (strategy)
{
case RTEqualStrategyNumber:
ret = BTEqualStrategyNumber;
}
PG_RETURN_UINT16(ret);
}
</programlisting>
</para>
<para>
One translation function is provided by
<productname>PostgreSQL</productname>:
<literal>gist_stratnum_identity</literal> is for operator classes that
already use the <literal>RT*StrategyNumber</literal> constants. It
returns whatever is passed to it. The <literal>btree_gist</literal>
extension defines a second translation function,
<literal>gist_stratnum_btree</literal>, for operator classes that use
the <literal>BT*StrategyNumber</literal> constants.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>

8
doc/src/sgml/xindex.sgml
View File

@ -508,7 +508,7 @@
</table>
<para>
GiST indexes have eleven support functions, six of which are optional,
GiST indexes have twelve support functions, seven of which are optional,
as shown in <xref linkend="xindex-gist-support-table"/>.
(For more information see <xref linkend="gist"/>.)
</para>
@ -590,6 +590,12 @@
(optional)</entry>
<entry>11</entry>
</row>
<row>
<entry><function>stratnum</function></entry>
<entry>translate well-known strategy numbers to ones
used by the operator class (optional)</entry>
<entry>12</entry>
</row>
</tbody>
</tgroup>
</table>

14
src/backend/access/gist/gistutil.c
View File

@ -21,6 +21,7 @@
#include "common/pg_prng.h"
#include "storage/indexfsm.h"
#include "utils/float.h"
#include "utils/fmgrprotos.h"
#include "utils/lsyscache.h"
#include "utils/rel.h"
#include "utils/snapmgr.h"
@ -1055,3 +1056,16 @@ gistGetFakeLSN(Relation rel)
return GetFakeLSNForUnloggedRel();
}
}
/*
* Returns the same number that was received.
*
* This is for GiST opclasses that use the RT*StrategyNumber constants.
*/
Datum
gist_stratnum_identity(PG_FUNCTION_ARGS)
{
StrategyNumber strat = PG_GETARG_UINT16(0);
PG_RETURN_UINT16(strat);
}

8
src/backend/access/gist/gistvalidate.c
View File

@ -146,6 +146,10 @@ gistvalidate(Oid opclassoid)
ok = check_amproc_signature(procform->amproc, VOIDOID, true,
1, 1, INTERNALOID);
break;
case GIST_STRATNUM_PROC:
ok = check_amproc_signature(procform->amproc, INT2OID, true,
1, 1, INT2OID);
break;
default:
ereport(INFO,
(errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
@ -266,7 +270,8 @@ gistvalidate(Oid opclassoid)
continue; /* got it */
if (i == GIST_DISTANCE_PROC || i == GIST_FETCH_PROC ||
i == GIST_COMPRESS_PROC || i == GIST_DECOMPRESS_PROC ||
i == GIST_OPTIONS_PROC || i == GIST_SORTSUPPORT_PROC)
i == GIST_OPTIONS_PROC || i == GIST_SORTSUPPORT_PROC ||
i == GIST_STRATNUM_PROC)
continue; /* optional methods */
ereport(INFO,
(errcode(ERRCODE_INVALID_OBJECT_DEFINITION),
@ -338,6 +343,7 @@ gistadjustmembers(Oid opfamilyoid,
case GIST_FETCH_PROC:
case GIST_OPTIONS_PROC:
case GIST_SORTSUPPORT_PROC:
case GIST_STRATNUM_PROC:
/* Optional, so force it to be a soft family dependency */
op->ref_is_hard = false;
op->ref_is_family = true;

3
src/include/access/gist.h
View File

@ -38,7 +38,8 @@
#define GIST_FETCH_PROC 9
#define GIST_OPTIONS_PROC 10
#define GIST_SORTSUPPORT_PROC 11
#define GISTNProcs 11
#define GIST_STRATNUM_PROC 12
#define GISTNProcs 12
/*
* Page opaque data in a GiST index page.

2
src/include/catalog/catversion.h
View File

@ -57,6 +57,6 @@
*/
/* yyyymmddN */
#define CATALOG_VERSION_NO 202409122
#define CATALOG_VERSION_NO 202409171
#endif

18
src/include/catalog/pg_amproc.dat
View File

@ -506,6 +506,9 @@
amprocrighttype => 'box', amprocnum => '7', amproc => 'gist_box_same' },
{ amprocfamily => 'gist/box_ops', amproclefttype => 'box',
amprocrighttype => 'box', amprocnum => '8', amproc => 'gist_box_distance' },
{ amprocfamily => 'gist/box_ops', amproclefttype => 'box',
amprocrighttype => 'box', amprocnum => '12',
amproc => 'gist_stratnum_identity' },
{ amprocfamily => 'gist/poly_ops', amproclefttype => 'polygon',
amprocrighttype => 'polygon', amprocnum => '1',
amproc => 'gist_poly_consistent' },
@ -525,6 +528,9 @@
{ amprocfamily => 'gist/poly_ops', amproclefttype => 'polygon',
amprocrighttype => 'polygon', amprocnum => '8',
amproc => 'gist_poly_distance' },
{ amprocfamily => 'gist/poly_ops', amproclefttype => 'polygon',
amprocrighttype => 'polygon', amprocnum => '12',
amproc => 'gist_stratnum_identity' },
{ amprocfamily => 'gist/circle_ops', amproclefttype => 'circle',
amprocrighttype => 'circle', amprocnum => '1',
amproc => 'gist_circle_consistent' },
@ -543,6 +549,9 @@
{ amprocfamily => 'gist/circle_ops', amproclefttype => 'circle',
amprocrighttype => 'circle', amprocnum => '8',
amproc => 'gist_circle_distance' },
{ amprocfamily => 'gist/circle_ops', amproclefttype => 'circle',
amprocrighttype => 'circle', amprocnum => '12',
amproc => 'gist_stratnum_identity' },
{ amprocfamily => 'gist/tsvector_ops', amproclefttype => 'tsvector',
amprocrighttype => 'tsvector', amprocnum => '1',
amproc => 'gtsvector_consistent(internal,tsvector,int2,oid,internal)' },
@ -597,6 +606,9 @@
{ amprocfamily => 'gist/range_ops', amproclefttype => 'anyrange',
amprocrighttype => 'anyrange', amprocnum => '7',
amproc => 'range_gist_same' },
{ amprocfamily => 'gist/range_ops', amproclefttype => 'anyrange',
amprocrighttype => 'anyrange', amprocnum => '12',
amproc => 'gist_stratnum_identity' },
{ amprocfamily => 'gist/network_ops', amproclefttype => 'inet',
amprocrighttype => 'inet', amprocnum => '1',
amproc => 'inet_gist_consistent' },
@ -613,6 +625,9 @@
amprocrighttype => 'inet', amprocnum => '7', amproc => 'inet_gist_same' },
{ amprocfamily => 'gist/network_ops', amproclefttype => 'inet',
amprocrighttype => 'inet', amprocnum => '9', amproc => 'inet_gist_fetch' },
{ amprocfamily => 'gist/network_ops', amproclefttype => 'inet',
amprocrighttype => 'inet', amprocnum => '12',
amproc => 'gist_stratnum_identity' },
{ amprocfamily => 'gist/multirange_ops', amproclefttype => 'anymultirange',
amprocrighttype => 'anymultirange', amprocnum => '1',
amproc => 'multirange_gist_consistent' },
@ -631,6 +646,9 @@
{ amprocfamily => 'gist/multirange_ops', amproclefttype => 'anymultirange',
amprocrighttype => 'anymultirange', amprocnum => '7',
amproc => 'range_gist_same' },
{ amprocfamily => 'gist/multirange_ops', amproclefttype => 'anymultirange',
amprocrighttype => 'anymultirange', amprocnum => '12',
amproc => 'gist_stratnum_identity' },
# gin
{ amprocfamily => 'gin/array_ops', amproclefttype => 'anyarray',

6
src/include/catalog/pg_proc.dat
View File

@ -12310,4 +12310,10 @@
proargnames => '{summarized_tli,summarized_lsn,pending_lsn,summarizer_pid}',
prosrc => 'pg_get_wal_summarizer_state' },
# GiST stratnum implementations
{ oid => '8047', descr => 'GiST support',
proname => 'gist_stratnum_identity', prorettype => 'int2',
proargtypes => 'int2',
prosrc => 'gist_stratnum_identity' },
]

13
src/test/regress/expected/misc_functions.out
View File

@ -819,3 +819,16 @@ SELECT pg_column_toast_chunk_id(a) IS NULL,
DROP TABLE test_chunk_id;
DROP FUNCTION explain_mask_costs(text, bool, bool, bool, bool);
-- test stratnum support functions
SELECT gist_stratnum_identity(3::smallint);
gist_stratnum_identity
------------------------
3
(1 row)
SELECT gist_stratnum_identity(18::smallint);
gist_stratnum_identity
------------------------
18
(1 row)

4
src/test/regress/sql/misc_functions.sql
View File

@ -360,3 +360,7 @@ SELECT pg_column_toast_chunk_id(a) IS NULL,
FROM test_chunk_id;
DROP TABLE test_chunk_id;
DROP FUNCTION explain_mask_costs(text, bool, bool, bool, bool);
-- test stratnum support functions
SELECT gist_stratnum_identity(3::smallint);
SELECT gist_stratnum_identity(18::smallint);