10000 doc: Improve ALTER VIEW / SET documentation · postgrespro/postgres_cluster@db75e52 · GitHub
[go: up one dir, main page]
Skip to content

Commit db75e52

Browse files
peterepetere
committed
doc: Improve ALTER VIEW / SET documentation
The way the ALTER VIEW / SET options were listed in the synopsis was very confusing. Move the list to the main description, similar to how the ALTER TABLE reference page does it.
1 parent 5dc4b50 commit db75e52

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

‎doc/src/sgml/ref/alter_view.sgml

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,6 @@ ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RENAM
2828
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> SET SCHEMA <replaceable class="parameter">new_schema</replaceable>
2929
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> SET ( <replaceable class="parameter">view_option_name</replaceable> [= <replaceable class="parameter">view_option_value</replaceable>] [, ... ] )
3030
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RESET ( <replaceable class="parameter">view_option_name</replaceable> [, ... ] )
31-
32-
<phrase>where <replaceable class="parameter">view_option_name</replaceable> can be one of:</phrase>
33-
34-
security_barrier [ <replaceable class="parameter">boolean</replaceable> ]
35-
check_option [ <replaceable class="parameter">text</replaceable> (<literal>local</literal> or <literal>cascaded</literal>) ]
3631
</synopsis>
3732
</refsynopsisdiv>
3833

@@ -122,19 +117,32 @@ ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RESET
122117
</varlistentry>
123118

124119
<varlistentry>
125-
<term><replaceable class="parameter">view_option_name</replaceable></term>
126-
<listitem>
127-
<para>
128-
The name of a view option to be set or reset.
129-
</para>
130-
</listitem>
131-
</varlistentry>
132-
133-
<varlistentry>
134-
<term><replaceable class="parameter">view_option_value</replaceable></term>
120+
<term><literal>SET ( <replaceable class="parameter">view_option_name</replaceable> [= <replaceable class="parameter">view_option_value</replaceable>] [, ... ] )</literal></term>
121+
<term><literal>RESET ( <replaceable class="parameter">view_option_name</replaceable> [, ... ] )</literal></term>
135122
<listitem>
136123
<para>
137-
The new value for a view option.
124+
Sets or resets a view option. Currently supported options are:
125+
<variablelist>
126+
<varlistentry>
127+
<term><literal>check_option</literal> (<type>string</type>)</term>
128+
<listitem>
129+
<para>
130+
Changes the check option of the view. The value must
131+
be <literal>local</literal> or <literal>cascaded</literal>.
132+
</para>
133+
</listitem>
134+
</varlistentry>
135+
<varlistentry>
136+
<term><literal>security_barrier</literal> (<type>boolean</type>)</term>
137+
<listitem>
138+
<para>
139+
Changes the security-barrier property of the view. The value must
140+
be Boolean value, such as <literal>true</literal>
141+
or <literal>false</literal>.
142+
</para>
143+
</listitem>
144+
</varlistentry>
145+
</variablelist>
138146
</para>
139147
</listitem>
140148
</varlistentry>

0 commit comments

Comments
 (0)
0