Commit b2fd8ebe authored by Tom Lane's avatar Tom Lane

Doc: update remaining tables of functions/operators for new layout.

This converts the contrib documentation to the new style, and mops up
a couple of function tables that were outside chapter 9 in the main
docs.

A few contrib modules choose not to present their functions in the
standard tabular format.  There might be room to rethink those decisions
now that the standard format is more friendly to verbose descriptions.
But I have not undertaken to do that here; I just converted existing
tables.
parent c265ed9b
...@@ -29,47 +29,67 @@ ...@@ -29,47 +29,67 @@
<table id="functions-adminpack-table"> <table id="functions-adminpack-table">
<title><filename>adminpack</filename> Functions</title> <title><filename>adminpack</filename> Functions</title>
<tgroup cols="3"> <tgroup cols="1">
<thead> <thead>
<row><entry>Name</entry> <entry>Return Type</entry> <entry>Description</entry> <row>
<entry role="func_table_entry"><para role="func_signature">
Function
</para>
<para>
Description
</para></entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry><function>pg_catalog.pg_file_write(filename text, data text, append boolean)</function></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>bigint</type></entry> <function>pg_catalog.pg_file_write</function> ( <parameter>filename</parameter> <type>text</type>, <parameter>data</parameter> <type>text</type>, <parameter>append</parameter> <type>boolean</type> )
<entry> <returnvalue>bigint</returnvalue>
Write, or append to, a text file </para>
</entry> <para>
Writes, or appends to, a text file.
</para></entry>
</row> </row>
<row> <row>
<entry><function>pg_catalog.pg_file_sync(filename text)</function></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>void</type></entry> <function>pg_catalog.pg_file_sync</function> ( <parameter>filename</parameter> <type>text</type> )
<entry> <returnvalue>void</returnvalue>
Flush a file or directory to disk </para>
</entry> <para>
Flushes a file or directory to disk.
</para></entry>
</row> </row>
<row> <row>
<entry><function>pg_catalog.pg_file_rename(oldname text, newname text <optional>, archivename text</optional>)</function></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>boolean</type></entry> <function>pg_catalog.pg_file_rename</function> ( <parameter>oldname</parameter> <type>text</type>, <parameter>newname</parameter> <type>text</type> <optional>, <parameter>archivename</parameter> <type>text</type> </optional> )
<entry> <returnvalue>boolean</returnvalue>
Rename a file </para>
</entry> <para>
Renames a file.
</para></entry>
</row> </row>
<row> <row>
<entry><function>pg_catalog.pg_file_unlink(filename text)</function></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>boolean</type></entry> <function>pg_catalog.pg_file_unlink</function> ( <parameter>filename</parameter> <type>text</type> )
<entry> <returnvalue>boolean</returnvalue>
Remove a file </para>
</entry> <para>
Removes a file.
</para></entry>
</row> </row>
<row> <row>
<entry><function>pg_catalog.pg_logdir_ls()</function></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>setof record</type></entry> <function>pg_catalog.pg_logdir_ls</function> ()
<entry> <returnvalue>setof record</returnvalue>
List the log files in the <varname>log_directory</varname> directory </para>
</entry> <para>
Lists the log files in the <varname>log_directory</varname> directory.
</para></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
This diff is collapsed.
...@@ -67,74 +67,118 @@ ...@@ -67,74 +67,118 @@
<table id="earthdistance-cube-functions"> <table id="earthdistance-cube-functions">
<title>Cube-Based Earthdistance Functions</title> <title>Cube-Based Earthdistance Functions</title>
<tgroup cols="3"> <tgroup cols="1">
<thead> <thead>
<row> <row>
<entry>Function</entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Returns</entry> Function
<entry>Description</entry> </para>
<para>
Description
</para></entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry><function>earth()</function><indexterm><primary>earth</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>float8</type></entry> <indexterm><primary>earth</primary></indexterm>
<entry>Returns the assumed radius of the Earth.</entry> <function>earth</function> ()
<returnvalue>float8</returnvalue>
</para>
<para>
Returns the assumed radius of the Earth.
</para></entry>
</row> </row>
<row> <row>
<entry><function>sec_to_gc(float8)</function><indexterm><primary>sec_to_gc</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>float8</type></entry> <indexterm><primary>sec_to_gc</primary></indexterm>
<entry>Converts the normal straight line <function>sec_to_gc</function> ( <type>float8</type> )
<returnvalue>float8</returnvalue>
</para>
<para>
Converts the normal straight line
(secant) distance between two points on the surface of the Earth (secant) distance between two points on the surface of the Earth
to the great circle distance between them. to the great circle distance between them.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><function>gc_to_sec(float8)</function><indexterm><primary>gc_to_sec</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>float8</type></entry> <indexterm><primary>gc_to_sec</primary></indexterm>
<entry>Converts the great circle distance between two points on the <function>gc_to_sec</function> ( <type>float8</type> )
<returnvalue>float8</returnvalue>
</para>
<para>
Converts the great circle distance between two points on the
surface of the Earth to the normal straight line (secant) distance surface of the Earth to the normal straight line (secant) distance
between them. between them.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><function>ll_to_earth(float8, float8)</function><indexterm><primary>ll_to_earth</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>earth</type></entry> <indexterm><primary>ll_to_earth</primary></indexterm>
<entry>Returns the location of a point on the surface of the Earth given <function>ll_to_earth</function> ( <type>float8</type>, <type>float8</type> )
<returnvalue>earth</returnvalue>
</para>
<para>
Returns the location of a point on the surface of the Earth given
its latitude (argument 1) and longitude (argument 2) in degrees. its latitude (argument 1) and longitude (argument 2) in degrees.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><function>latitude(earth)</function><indexterm><primary>latitude</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>float8</type></entry> <indexterm><primary>latitude</primary></indexterm>
<entry>Returns the latitude in degrees of a point on the surface of the <function>latitude</function> ( <type>earth</type> )
<returnvalue>float8</returnvalue>
</para>
<para>
Returns the latitude in degrees of a point on the surface of the
Earth. Earth.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><function>longitude(earth)</function><indexterm><primary>longitude</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>float8</type></entry> <indexterm><primary>longitude</primary></indexterm>
<entry>Returns the longitude in degrees of a point on the surface of the <function>longitude</function> ( <type>earth</type> )
<returnvalue>float8</returnvalue>
</para>
<para>
Returns the longitude in degrees of a point on the surface of the
Earth. Earth.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><function>earth_distance(earth, earth)</function><indexterm><primary>earth_distance</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>float8</type></entry> <indexterm><primary>earth_distance</primary></indexterm>
<entry>Returns the great circle distance between two points on the <function>earth_distance</function> ( <type>earth</type>, <type>earth</type> )
<returnvalue>float8</returnvalue>
</para>
<para>
Returns the great circle distance between two points on the
surface of the Earth. surface of the Earth.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><function>earth_box(earth, float8)</function><indexterm><primary>earth_box</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>cube</type></entry> <indexterm><primary>earth_box</primary></indexterm>
<entry>Returns a box suitable for an indexed search using the cube <function>earth_box</function> ( <type>earth</type>, <type>float8</type> )
<returnvalue>cube</returnvalue>
</para>
<para>
Returns a box suitable for an indexed search using the <type>cube</type>
<literal>@&gt;</literal> <literal>@&gt;</literal>
operator for points within a given great circle distance of a location. operator for points within a given great circle distance of a location.
Some points in this box are further than the specified great circle Some points in this box are further than the specified great circle
distance from the location, so a second check using distance from the location, so a second check using
<function>earth_distance</function> should be included in the query. <function>earth_distance</function> should be included in the query.
</entry> </para></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
...@@ -161,21 +205,27 @@ ...@@ -161,21 +205,27 @@
<table id="earthdistance-point-operators"> <table id="earthdistance-point-operators">
<title>Point-Based Earthdistance Operators</title> <title>Point-Based Earthdistance Operators</title>
<tgroup cols="3"> <tgroup cols="1">
<thead> <thead>
<row> <row>
<entry>Operator</entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Returns</entry> Operator
<entry>Description</entry> </para>
<para>
Description
</para></entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry><type>point</type> <literal>&lt;@&gt;</literal> <type>point</type></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>float8</type></entry> <type>point</type> <literal>&lt;@&gt;</literal> <type>point</type>
<entry>Gives the distance in statute miles between <returnvalue>float8</returnvalue>
</para>
<para>
Computes the distance in statute miles between
two points on the Earth's surface. two points on the Earth's surface.
</entry> </para></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
This diff is collapsed.
This diff is collapsed.
...@@ -38,6 +38,8 @@ ...@@ -38,6 +38,8 @@
<table id="isn-datatypes"> <table id="isn-datatypes">
<title><filename>isn</filename> Data Types</title> <title><filename>isn</filename> Data Types</title>
<tgroup cols="2"> <tgroup cols="2">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="2*"/>
<thead> <thead>
<row> <row>
<entry>Data Type</entry> <entry>Data Type</entry>
...@@ -235,35 +237,60 @@ ...@@ -235,35 +237,60 @@
<table id="isn-functions"> <table id="isn-functions">
<title><filename>isn</filename> Functions</title> <title><filename>isn</filename> Functions</title>
<tgroup cols="3"> <tgroup cols="1">
<thead> <thead>
<row> <row>
<entry>Function</entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Returns</entry> Function
<entry>Description</entry> </para>
<para>
Description
</para></entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry><function>isn_weak(boolean)</function><indexterm><primary>isn_weak</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>boolean</type></entry> <indexterm><primary>isn_weak</primary></indexterm>
<entry>Sets the weak input mode (returns new setting)</entry> <function>isn_weak</function> ( <type>boolean</type> )
<returnvalue>boolean</returnvalue>
</para>
<para>
Sets the weak input mode, and returns new setting.
</para></entry>
</row> </row>
<row> <row>
<entry><function>isn_weak()</function></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>boolean</type></entry> <function>isn_weak</function> ()
<entry>Gets the current status of the weak mode</entry> <returnvalue>boolean</returnvalue>
</para>
<para>
Returns the current status of the weak mode.
</para></entry>
</row> </row>
<row> <row>
<entry><function>make_valid(isn)</function><indexterm><primary>make_valid</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>isn</type></entry> <indexterm><primary>make_valid</primary></indexterm>
<entry>Validates an invalid number (clears the invalid flag)</entry> <function>make_valid</function> ( <type>isn</type> )
<returnvalue>isn</returnvalue>
</para>
<para>
Validates an invalid number (clears the invalid flag).
</para></entry>
</row> </row>
<row> <row>
<entry><function>is_valid(isn)</function><indexterm><primary>is_valid</primary></indexterm></entry> <entry role="func_table_entry"><para role="func_signature">
<entry><type>boolean</type></entry> <indexterm><primary>is_valid</primary></indexterm>
<entry>Checks for the presence of the invalid flag</entry> <function>is_valid</function> ( <type>isn</type> )
<returnvalue>boolean</returnvalue>
</para>
<para>
Checks for the presence of the invalid flag.
</para></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -544,64 +544,77 @@ int lo_unlink(PGconn *conn, Oid lobjId); ...@@ -544,64 +544,77 @@ int lo_unlink(PGconn *conn, Oid lobjId);
<table id="lo-funcs-table"> <table id="lo-funcs-table">
<title>SQL-Oriented Large Object Functions</title> <title>SQL-Oriented Large Object Functions</title>
<tgroup cols="5"> <tgroup cols="1">
<thead> <thead>
<row> <row>
<entry>Function</entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Return Type</entry> Function
<entry>Description</entry> </para>
<entry>Example</entry> <para>
<entry>Result</entry> Description
</para>
<para>
Example(s)
</para></entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry> <entry role="func_table_entry"><para role="func_signature">
<indexterm> <indexterm>
<primary>lo_from_bytea</primary> <primary>lo_from_bytea</primary>
</indexterm> </indexterm>
<literal><function>lo_from_bytea(<parameter>loid</parameter> <type>oid</type>, <parameter>string</parameter> <type>bytea</type>)</function></literal> <function>lo_from_bytea</function> ( <parameter>loid</parameter> <type>oid</type>, <parameter>data</parameter> <type>bytea</type> )
</entry> <returnvalue>oid</returnvalue>
<entry><type>oid</type></entry> </para>
<entry> <para>
Create a large object and store data there, returning its OID. Creates a large object and stores <parameter>data</parameter> in it.
Pass <literal>0</literal> to have the system choose an OID. If <parameter>loid</parameter> is zero then the system will choose a
</entry> free OID, otherwise that OID is used (with an error if some large
<entry><literal>lo_from_bytea(0, '\xffffff00')</literal></entry> object already has that OID). On success, the large object's OID is
<entry><literal>24528</literal></entry> returned.
</para>
<para>
<literal>lo_from_bytea(0, '\xffffff00')</literal>
<returnvalue>24528</returnvalue>
</para></entry>
</row> </row>
<row> <row>
<entry> <entry role="func_table_entry"><para role="func_signature">
<indexterm> <indexterm>
<primary>lo_put</primary> <primary>lo_put</primary>
</indexterm> </indexterm>
<literal><function>lo_put(<parameter>loid</parameter> <type>oid</type>, <parameter>offset</parameter> <type>bigint</type>, <parameter>str</parameter> <type>bytea</type>)</function></literal> <function>lo_put</function> ( <parameter>loid</parameter> <type>oid</type>, <parameter>offset</parameter> <type>bigint</type>, <parameter>data</parameter> <type>bytea</type> )
</entry> <returnvalue>void</returnvalue>
<entry><type>void</type></entry> </para>
<entry> <para>
Write data at the given offset. Writes <parameter>data</parameter> starting at the given offset within
</entry> the large object; the large object is enlarged if necessary.
<entry><literal>lo_put(24528, 1, '\xaa')</literal></entry> </para>
<entry></entry> <para>
<literal>lo_put(24528, 1, '\xaa')</literal>
<returnvalue></returnvalue>
</para></entry>
</row> </row>
<row> <row>
<entry> <entry role="func_table_entry"><para role="func_signature">
<indexterm> <indexterm>
<primary>lo_get</primary> <primary>lo_get</primary>
</indexterm> </indexterm>
<literal><function>lo_get(<parameter>loid</parameter> <type>oid</type> <optional>, <parameter>from</parameter> <type>bigint</type>, <parameter>for</parameter> <type>int</type></optional>)</function></literal> <function>lo_get</function> ( <parameter>loid</parameter> <type>oid</type> <optional>, <parameter>offset</parameter> <type>bigint</type>, <parameter>length</parameter> <type>integer</type> </optional> )
</entry> <returnvalue>bytea</returnvalue>
<entry><type>bytea</type></entry> </para>
<entry> <para>
Extract contents or a substring thereof. Extracts the large object's contents, or a substring thereof.
</entry> </para>
<entry><literal>lo_get(24528, 0, 3)</literal></entry> <para>
<entry><literal>\xffaaff</literal></entry> <literal>lo_get(24528, 0, 3)</literal>
<returnvalue>\xffaaff</returnvalue>
</para></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
</table> </table>
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
...@@ -141,6 +141,8 @@ test=&gt; select '6.25 .. 6.50'::seg as "pH"; ...@@ -141,6 +141,8 @@ test=&gt; select '6.25 .. 6.50'::seg as "pH";
<table id="seg-input-examples"> <table id="seg-input-examples">
<title>Examples of Valid <type>seg</type> Input</title> <title>Examples of Valid <type>seg</type> Input</title>
<tgroup cols="2"> <tgroup cols="2">
<colspec colname="col1" colwidth="1*"/>
<colspec colname="col2" colwidth="2*"/>
<tbody> <tbody>
<row> <row>
<entry><literal>5.0</literal></entry> <entry><literal>5.0</literal></entry>
...@@ -248,62 +250,103 @@ test=&gt; select '6.25 .. 6.50'::seg as "pH"; ...@@ -248,62 +250,103 @@ test=&gt; select '6.25 .. 6.50'::seg as "pH";
<table id="seg-gist-operators"> <table id="seg-gist-operators">
<title>Seg GiST Operators</title> <title>Seg GiST Operators</title>
<tgroup cols="2"> <tgroup cols="1">
<thead> <thead>
<row> <row>
<entry>Operator</entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Description</entry> Operator
</para>
<para>
Description
</para></entry>
</row> </row>
</thead> </thead>
<tbody> <tbody>
<row> <row>
<entry><literal>[a, b] &lt;&lt; [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>[a, b] is entirely to the left of [c, d]. That is, [a, <type>seg</type> <literal>&lt;&lt;</literal> <type>seg</type>
b] &lt;&lt; [c, d] is true if b &lt; c and false otherwise.</entry> <returnvalue>boolean</returnvalue>
</para>
<para>
Is the first <type>seg</type> entirely to the left of the second?
[a, b] &lt;&lt; [c, d] is true if b &lt; c.
</para></entry>
</row> </row>
<row> <row>
<entry><literal>[a, b] &gt;&gt; [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>[a, b] is entirely to the right of [c, d]. That is, [a, <type>seg</type> <literal>&gt;&gt;</literal> <type>seg</type>
b] &gt;&gt; [c, d] is true if a &gt; d and false otherwise.</entry> <returnvalue>boolean</returnvalue>
</para>
<para>
Is the first <type>seg</type> entirely to the right of the second?
[a, b] &gt;&gt; [c, d] is true if a &gt; d.
</para></entry>
</row> </row>
<row> <row>
<entry><literal>[a, b] &amp;&lt; [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Overlaps or is left of &mdash; This might be better read <type>seg</type> <literal>&amp;&lt;</literal> <type>seg</type>
as <quote>does not extend to right of</quote>. It is true when <returnvalue>boolean</returnvalue>
b &lt;= d.</entry> </para>
<para>
Does the first <type>seg</type> not extend to the right of the
second?
[a, b] &amp;&lt; [c, d] is true if b &lt;= d.
</para></entry>
</row> </row>
<row> <row>
<entry><literal>[a, b] &amp;&gt; [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Overlaps or is right of &mdash; This might be better read <type>seg</type> <literal>&amp;&gt;</literal> <type>seg</type>
as <quote>does not extend to left of</quote>. It is true when <returnvalue>boolean</returnvalue>
a &gt;= c.</entry> </para>
<para>
Does the first <type>seg</type> not extend to the left of the
second?
[a, b] &amp;&gt; [c, d] is true if a &gt;= c.
</para></entry>
</row> </row>
<row> <row>
<entry><literal>[a, b] = [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Same as &mdash; The segments [a, b] and [c, d] are <type>seg</type> <literal>=</literal> <type>seg</type>
identical, that is, a = c and b = d.</entry> <returnvalue>boolean</returnvalue>
</para>
<para>
Are the two <type>seg</type>s equal?
</para></entry>
</row> </row>
<row> <row>
<entry><literal>[a, b] &amp;&amp; [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>The segments [a, b] and [c, d] overlap.</entry> <type>seg</type> <literal>&amp;&amp;</literal> <type>seg</type>
<returnvalue>boolean</returnvalue>
</para>
<para>
Do the two <type>seg</type>s overlap?
</para></entry>
</row> </row>
<row> <row>
<entry><literal>[a, b] @&gt; [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>The segment [a, b] contains the segment [c, d], that is, <type>seg</type> <literal>@&gt;</literal> <type>seg</type>
a &lt;= c and b &gt;= d.</entry> <returnvalue>boolean</returnvalue>
</para>
<para>
Does the first <type>seg</type> contain the second?
</para></entry>
</row> </row>
<row> <row>
<entry><literal>[a, b] &lt;@ [c, d]</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>The segment [a, b] is contained in [c, d], that is, a <type>seg</type> <literal>&lt;@</literal> <type>seg</type>
&gt;= c and b &lt;= d.</entry> <returnvalue>boolean</returnvalue>
</para>
<para>
Is the first <type>seg</type> contained in the second?
</para></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
...@@ -318,33 +361,10 @@ test=&gt; select '6.25 .. 6.50'::seg as "pH"; ...@@ -318,33 +361,10 @@ test=&gt; select '6.25 .. 6.50'::seg as "pH";
</para> </para>
<para> <para>
The standard B-tree operators are also provided, for example In addition to the above operators, the usual comparison
operators shown in <xref linkend="functions-comparison-op-table"/> are
<informaltable> available for type <type>seg</type>. These operators
<tgroup cols="2"> first compare (a) to (c),
<thead>
<row>
<entry>Operator</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>[a, b] &lt; [c, d]</literal></entry>
<entry>Less than</entry>
</row>
<row>
<entry><literal>[a, b] &gt; [c, d]</literal></entry>
<entry>Greater than</entry>
</row>
</tbody>
</tgroup>
</informaltable>
These operators do not make a lot of sense for any practical
purpose but sorting. These operators first compare (a) to (c),
and if these are equal, compare (b) to (d). That results in and if these are equal, compare (b) to (d). That results in
reasonably good sorting in most cases, which is useful if reasonably good sorting in most cases, which is useful if
you want to use ORDER BY with this type. you want to use ORDER BY with this type.
......
...@@ -659,42 +659,74 @@ ERROR: SELinux: security policy violation ...@@ -659,42 +659,74 @@ ERROR: SELinux: security policy violation
<table id="sepgsql-functions-table"> <table id="sepgsql-functions-table">
<title>Sepgsql Functions</title> <title>Sepgsql Functions</title>
<tgroup cols="2"> <tgroup cols="1">
<thead>
<row>
<entry role="func_table_entry"><para role="func_signature">
Function
</para>
<para>
Description
</para></entry>
</row>
</thead>
<tbody> <tbody>
<row> <row>
<entry><literal>sepgsql_getcon() returns text</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry> <function>sepgsql_getcon</function> ()
<returnvalue>text</returnvalue>
</para>
<para>
Returns the client domain, the current security label of the client. Returns the client domain, the current security label of the client.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><literal>sepgsql_setcon(text) returns bool</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry> <function>sepgsql_setcon</function> ( <type>text</type> )
<returnvalue>boolean</returnvalue>
</para>
<para>
Switches the client domain of the current session to the new domain, Switches the client domain of the current session to the new domain,
if allowed by the security policy. if allowed by the security policy.
It also accepts <literal>NULL</literal> input as a request to transition It also accepts <literal>NULL</literal> input as a request to transition
to the client's original domain. to the client's original domain.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><literal>sepgsql_mcstrans_in(text) returns text</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Translates the given qualified MLS/MCS range into raw format if <function>sepgsql_mcstrans_in</function> ( <type>text</type> )
<returnvalue>text</returnvalue>
</para>
<para>
Translates the given qualified MLS/MCS range into raw format if
the mcstrans daemon is running. the mcstrans daemon is running.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><literal>sepgsql_mcstrans_out(text) returns text</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry>Translates the given raw MLS/MCS range into qualified format if <function>sepgsql_mcstrans_out</function> ( <type>text</type> )
<returnvalue>text</returnvalue>
</para>
<para>
Translates the given raw MLS/MCS range into qualified format if
the mcstrans daemon is running. the mcstrans daemon is running.
</entry> </para></entry>
</row> </row>
<row> <row>
<entry><literal>sepgsql_restorecon(text) returns bool</literal></entry> <entry role="func_table_entry"><para role="func_signature">
<entry> <function>sepgsql_restorecon</function> ( <type>text</type> )
<returnvalue>boolean</returnvalue>
</para>
<para>
Sets up initial security labels for all objects within the Sets up initial security labels for all objects within the
current database. The argument may be NULL, or the name of a specfile current database. The argument may be <literal>NULL</literal>, or the
to be used as alternative of the system default. name of a specfile to be used as alternative of the system default.
</entry> </para></entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment