]> 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)
commit0f3637ace36bf42f5385a3304e28f8530c5691d1
tree4564e0142f5d45c14deec5401c1ac362a9d8ff8b
parentb7156cfe1bc105691baf40578076187e1e6436d5
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