Re: GIN readme is out of date - Mailing list pgsql-hackers
From | Bruce Momjian |
---|---|
Subject | Re: GIN readme is out of date |
Date | |
Msg-id | 200709141628.l8EGSOq28540@momjian.us Whole thread Raw |
In response to | GIN readme is out of date ("Heikki Linnakangas" <heikki@enterprisedb.com>) |
List | pgsql-hackers |
Patch applied. Thanks. --------------------------------------------------------------------------- Heikki Linnakangas wrote: > access/gin/README describes the Gin interface, but it hasn't been > updated since the change to extractQuery interface to allow "no query > can match" return value. > > Since that interface documentation has been copied to the manual, > gin.sgml, section 52.2, which is up to date, how about we just remove it > from the README? > > -- > Heikki Linnakangas > EnterpriseDB http://www.enterprisedb.com > > ---------------------------(end of broadcast)--------------------------- > TIP 9: In versions below 8.0, the planner will ignore your desire to > choose an index scan if your joining column's datatypes do not > match -- Bruce Momjian <bruce@momjian.us> http://momjian.us EnterpriseDB http://www.enterprisedb.com + If your life is a hard drive, Christ can be your backup. + Index: src/backend/access/gin/README =================================================================== RCS file: /cvsroot/pgsql/src/backend/access/gin/README,v retrieving revision 1.2 diff -c -c -r1.2 README *** src/backend/access/gin/README 10 Sep 2006 00:29:34 -0000 1.2 --- src/backend/access/gin/README 14 Sep 2007 16:27:17 -0000 *************** *** 88,122 **** * Gin doesn't support full scans of indices. * Gin doesn't index NULL values. - Gin Interface - ------------- - - Opclass interface pseudocode. An example for a Gin opclass can be found in - ginarayproc.c. - - Datum* extractValue(Datum inputValue, uint32* nentries) - - Returns an array of Datum of entries of the value to be indexed. nentries - should contain the number of returned entries. - - int compareEntry(Datum a, Datum b) - - Compares two entries (not the indexing values) - - Datum* extractQuery(Datum query, uint32* nentries, StrategyNumber n) - - Returns an array of Datum of entries of the query to be executed. - n contains the strategy number of the operation. - - bool consistent(bool[] check, StrategyNumber n, Datum query) - - The size of the check array is the same as sizeof of the array returned by - extractQuery. Each element of the check array is true if the indexed value - has a corresponding entry in the query. i.e. if (check[i] == TRUE) then - the i-th entry of the query is present in the indexed value. The Function - should return true if the indexed value matches by StrategyNumber and - the query. - Open Items ---------- --- 88,93 ----
pgsql-hackers by date: