database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-17 06:41:09 +03:00
Code Activity

Improve documentation of random() function.

Browse Source 
Move random() and setseed() to a separate table, to have them grouped
together. Also add a notice that random() is not cryptographically secure.

Back-patch of commit 75fdcec145 into
all supported versions, per discussion of the need to document that
random() is just a wrapper around random(3).
This commit is contained in:
Tom Lane
2015-01-20 21:21:47 -05:00
parent 338ff75fc4
commit a113a66a7a
1 changed files with 50 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

73
doc/src/sgml/func.sgml
View File

@ -650,15 +650,9 @@
<indexterm> <indexterm>
<primary>radians</primary> <primary>radians</primary>
</indexterm> </indexterm>
<indexterm>
<primary>random</primary>
</indexterm>
<indexterm> <indexterm>
<primary>round</primary> <primary>round</primary>
</indexterm> </indexterm>
<indexterm>
<primary>setseed</primary>
</indexterm>
<indexterm> <indexterm>
<primary>sign</primary> <primary>sign</primary>
</indexterm> </indexterm>
@ -819,14 +813,6 @@
<entry><literal>0.785398163397448</literal></entry> <entry><literal>0.785398163397448</literal></entry>
</row> </row>
<row>
<entry><literal><function>random()</function></literal></entry>
<entry><type>dp</type></entry>
<entry>random value in the range 0.0 &lt;= x &lt; 1.0</entry>
<entry><literal>random()</literal></entry>
<entry></entry>
</row>
<row> <row>
<entry><literal><function>round(<type>dp</type> or <type>numeric</type>)</function></literal></entry> <entry><literal><function>round(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry> <entry>(same as input)</entry>
@ -843,15 +829,6 @@
<entry><literal>42.44</literal></entry> <entry><literal>42.44</literal></entry>
</row> </row>
<row>
<entry><literal><function>setseed(<type>dp</type>)</function></literal></entry>
<entry><type>void</type></entry>
<entry>set seed for subsequent <literal>random()</literal> calls (value between -1.0 and
1.0, inclusive)</entry>
<entry><literal>setseed(0.54823)</literal></entry>
<entry></entry>
</row>
<row> <row>
<entry><literal><function>sign(<type>dp</type> or <type>numeric</type>)</function></literal></entry> <entry><literal><function>sign(<type>dp</type> or <type>numeric</type>)</function></literal></entry>
<entry>(same as input)</entry> <entry>(same as input)</entry>
@ -907,6 +884,56 @@
</tgroup> </tgroup>
</table> </table>
<para>
<xref linkend="functions-math-random-table"> shows functions for
generating random numbers.
</para>
<table id="functions-math-random-table">
<title>Random Functions</title>
<tgroup cols="3">
<thead>
<row>
<entry>Function</entry>
<entry>Return Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<indexterm>
<primary>random</primary>
</indexterm>
<literal><function>random()</function></literal>
</entry>
<entry><type>dp</type></entry>
<entry>random value in the range 0.0 &lt;= x &lt; 1.0</entry>
</row>
<row>
<entry>
<indexterm>
<primary>setseed</primary>
</indexterm>
<literal><function>setseed(<type>dp</type>)</function></literal>
</entry>
<entry><type>void</type></entry>
<entry>set seed for subsequent <literal>random()</literal> calls (value between -1.0 and
1.0, inclusive)</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The characteristics of the values returned by
<literal><function>random()</function></literal> depend
on the system implementation. It is not suitable for cryptographic
applications; see <xref linkend="pgcrypto"> module for an alternative.
</para>
<para> <para>
Finally, <xref linkend="functions-math-trig-table"> shows the Finally, <xref linkend="functions-math-trig-table"> shows the
available trigonometric functions. All trigonometric functions available trigonometric functions. All trigonometric functions