diff options
author | Tom Lane | 2016-05-05 18:51:00 +0000 |
---|---|---|
committer | Tom Lane | 2016-05-05 18:51:00 +0000 |
commit | 7a622b2731db5d0f6db8a3d0af88177f96d1cb2e (patch) | |
tree | 50391a3012587c3882cd87d5b7a3ab4738cb87a7 /doc/src | |
parent | c311f7887376f7f3ce24c4c0dac4f9cb6ad3bee3 (diff) |
Rename pgbench min/max to least/greatest, and fix handling of double args.
These functions behave like the backend's least/greatest functions,
not like min/max, so the originally-chosen names invite confusion.
Per discussion, rename to least/greatest.
I also took it upon myself to make them return double if any input is
double. The previous behavior of silently coercing all inputs to int
surely does not meet the principle of least astonishment.
Copy-edit some of the other new functions' documentation, too.
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/ref/pgbench.sgml | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/doc/src/sgml/ref/pgbench.sgml b/doc/src/sgml/ref/pgbench.sgml index a6c69ff344d..e6c7c94fe25 100644 --- a/doc/src/sgml/ref/pgbench.sgml +++ b/doc/src/sgml/ref/pgbench.sgml @@ -935,14 +935,15 @@ pgbench <optional> <replaceable>options</> </optional> <replaceable>dbname</> <row> <entry><literal><function>abs(<replaceable>a</>)</></></> <entry>same as <replaceable>a</></> - <entry>integer or double absolute value</> + <entry>absolute value</> <entry><literal>abs(-17)</></> <entry><literal>17</></> </row> <row> <entry><literal><function>debug(<replaceable>a</>)</></></> <entry>same as <replaceable>a</> </> - <entry>print to <systemitem>stderr</systemitem> the given argument</> + <entry>print <replaceable>a</> to <systemitem>stderr</systemitem>, + and return <replaceable>a</></> <entry><literal>debug(5432.1)</></> <entry><literal>5432.1</></> </row> @@ -961,23 +962,23 @@ pgbench <optional> <replaceable>options</> </optional> <replaceable>dbname</> <entry><literal>9</></> </row> <row> - <entry><literal><function>max(<replaceable>i</> [, <replaceable>...</> ] )</></></> - <entry>integer</> - <entry>maximum value</> - <entry><literal>max(5, 4, 3, 2)</></> + <entry><literal><function>greatest(<replaceable>a</> [, <replaceable>...</> ] )</></></> + <entry>double if any <replaceable>a</> is double, else integer</> + <entry>largest value among arguments</> + <entry><literal>greatest(5, 4, 3, 2)</></> <entry><literal>5</></> </row> <row> - <entry><literal><function>min(<replaceable>i</> [, <replaceable>...</> ] )</></></> - <entry>integer</> - <entry>minimum value</> - <entry><literal>min(5, 4, 3, 2)</></> - <entry><literal>2</></> + <entry><literal><function>least(<replaceable>a</> [, <replaceable>...</> ] )</></></> + <entry>double if any <replaceable>a</> is double, else integer</> + <entry>smallest value among arguments</> + <entry><literal>least(5, 4, 3, 2.1)</></> + <entry><literal>2.1</></> </row> <row> <entry><literal><function>pi()</></></> <entry>double</> - <entry>value of the PI constant</> + <entry>value of the constant PI</> <entry><literal>pi()</></> <entry><literal>3.14159265358979323846</></> </row> |