mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update DECLARE_INDEX documentation

Browse Source 
Update source code comment changes belonging to the changes in
6a6389a08b.

Discussion: https://www.postgresql.org/message-id/flat/75ae5875-3abc-dafc-8aec-73247ed41cde@eisentraut.org
This commit is contained in:
Peter Eisentraut 2023-08-24 13:59:40 +02:00
parent 4f3514f201
commit 3c09d11594
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/include/catalog/genbki.h
View File

@ -71,12 +71,13 @@
* DECLARE_UNIQUE_INDEX_PKEY. ("PKEY" marks the index as being the catalog's
* primary key; currently this is only cosmetically different from a regular
* unique index. By convention, we usually make a catalog's OID column its
* pkey, if it has one.) The first two arguments are the index's name and
* OID, the rest is much like a standard 'create index' SQL command.
* pkey, if it has one.)
*
* For each index, we also provide a #define for its OID. References to
* the index in the C code should always use these #defines, not the actual
* index name (much less the numeric OID).
* The first two arguments are the index's name and OID. The third argument
* is the name of a #define to generate for its OID. References to the index
* in the C code should always use these #defines, not the actual index name
* (much less the numeric OID). The rest is much like a standard 'create
* index' SQL command.
*
* The macro definitions are just to keep the C compiler from spitting up.
*/