]> granicus.if.org Git - postgresql/commit
Make argument names of pg_get_object_address consistent, and fix docs.
authorTom Lane <tgl@sss.pgh.pa.us>
Wed, 5 Sep 2018 17:47:16 +0000 (13:47 -0400)
committerTom Lane <tgl@sss.pgh.pa.us>
Wed, 5 Sep 2018 17:47:16 +0000 (13:47 -0400)
commit5b114b045a479e584be9252dedac4c357c456311
treeda513befaa0b82ba1d43c4c44691d3489fb2eeaa
parenta704f8327f56b9a6b38e8d88e465ae021a01bc52
Make argument names of pg_get_object_address consistent, and fix docs.

pg_get_object_address and pg_identify_object_as_address are supposed
to be inverses, but they disagreed as to the names of the arguments
representing the textual form of an object address.  Moreover, the
documented argument names didn't agree with reality at all, either
for these functions or pg_identify_object.

In HEAD and v11, I think we can get away with renaming the input
arguments of pg_get_object_address to match the outputs of
pg_identify_object_as_address.  In theory that might break queries
using named-argument notation to call pg_get_object_address, but
it seems really unlikely that anybody is doing that, or that they'd
have much trouble adjusting if they were.  In older branches, we'll
just live with the lack of consistency.

Aside from fixing the documentation of these functions to match reality,
I couldn't resist the temptation to do some copy-editing.

Per complaint from Jean-Pierre Pelletier.  Back-patch to 9.5 where these
functions were introduced.  (Before v11, this is a documentation change
only.)

Discussion: https://postgr.es/m/CANGqjDnWH8wsTY_GzDUxbt4i=y-85SJreZin4Hm8uOqv1vzRQA@mail.gmail.com
doc/src/sgml/func.sgml