alter_view.sgml 5.8 KB
Newer Older
1
<!--
2
doc/src/sgml/ref/alter_view.sgml
3 4 5 6 7
PostgreSQL documentation
-->

<refentry id="SQL-ALTERVIEW">
 <refmeta>
8
  <refentrytitle>ALTER VIEW</refentrytitle>
9
  <manvolnum>7</manvolnum>
10 11 12 13 14 15
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>ALTER VIEW</refname>
  <refpurpose>change the definition of a view</refpurpose>
16 17
 </refnamediv>

18 19 20 21 22 23
 <indexterm zone="sql-alterview">
  <primary>ALTER VIEW</primary>
 </indexterm>

 <refsynopsisdiv>
<synopsis>
24 25
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> ALTER [ COLUMN ] <replaceable class="PARAMETER">column_name</replaceable> SET DEFAULT <replaceable class="PARAMETER">expression</replaceable>
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> ALTER [ COLUMN ] <replaceable class="PARAMETER">column_name</replaceable> DROP DEFAULT
26 27 28 29 30
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> OWNER TO <replaceable class="PARAMETER">new_owner</replaceable>
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RENAME TO <replaceable class="parameter">new_name</replaceable>
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> SET SCHEMA <replaceable class="parameter">new_schema</replaceable>
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> SET ( <replaceable class="parameter">view_option_name</replaceable> [= <replaceable class="parameter">view_option_value</replaceable>] [, ... ] )
ALTER VIEW [ IF EXISTS ] <replaceable class="parameter">name</replaceable> RESET ( <replaceable class="parameter">view_option_name</replaceable> [, ... ] )
31 32
</synopsis>
 </refsynopsisdiv>
33

34 35 36 37
 <refsect1>
  <title>Description</title>

  <para>
38 39 40 41 42 43 44 45 46 47 48 49 50 51
   <command>ALTER VIEW</command> changes various auxiliary properties
   of a view.  (If you want to modify the view's defining query,
   use <command>CREATE OR REPLACE VIEW</>.)
  </para>

  <para>
   You must own the view to use <command>ALTER VIEW</>.
   To change a view's schema, you must also have <literal>CREATE</>
   privilege on the new schema.
   To alter the owner, you must also be a direct or indirect member of the new
   owning role, and that role must have <literal>CREATE</literal> privilege on
   the view's schema.  (These restrictions enforce that altering the owner
   doesn't do anything you couldn't do by dropping and recreating the view.
   However, a superuser can alter ownership of any view anyway.)
52 53
  </para>
 </refsect1>
54

55 56 57 58 59 60 61 62 63 64 65 66 67
 <refsect1>
  <title>Parameters</title>

  <variablelist>
   <varlistentry>
    <term><replaceable class="parameter">name</replaceable></term>
    <listitem>
     <para>
      The name (optionally schema-qualified) of an existing view.
     </para>
    </listitem>
   </varlistentry>

68 69 70 71 72 73 74 75 76 77
   <varlistentry>
    <term><literal>IF EXISTS</literal></term>
    <listitem>
     <para>
      Do not throw an error if the view does not exist. A notice is issued
      in this case.
     </para>
    </listitem>
   </varlistentry>

78
   <varlistentry>
79 80 81 82
    <term><literal>SET</literal>/<literal>DROP DEFAULT</literal></term>
    <listitem>
     <para>
      These forms set or remove the default value for a column.
T
Tom Lane 已提交
83 84 85 86 87
      A view column's default value is substituted into any
      <command>INSERT</> or <command>UPDATE</> command whose target is the
      view, before applying any rules or triggers for the view.  The view's
      default will therefore take precedence over any default values from
      underlying relations.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="PARAMETER">new_owner</replaceable></term>
    <listitem>
     <para>
      The user name of the new owner of the view.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">new_name</replaceable></term>
    <listitem>
     <para>
      The new name for the view.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">new_schema</replaceable></term>
112 113
    <listitem>
     <para>
114
      The new schema for the view.
115 116 117
     </para>
    </listitem>
   </varlistentry>
118 119 120 121 122 123 124 125 126 127 128

   <varlistentry>
    <term><replaceable class="parameter">view_option_name</replaceable></term>
    <listitem>
     <para>
      The name of a view option to be set or reset.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
129
    <term><replaceable class="parameter">view_option_value</replaceable></term>
130 131 132 133 134 135
    <listitem>
     <para>
      The new value for a view option.
     </para>
    </listitem>
   </varlistentry>
136 137 138
  </variablelist>
 </refsect1>

139 140 141 142
 <refsect1>
  <title>Notes</title>

  <para>
143 144 145
   For historical reasons, <command>ALTER TABLE</command> can be used with
   views too; but the only variants of <command>ALTER TABLE</command>
   that are allowed with views are equivalent to the ones shown above.
146 147 148
  </para>
 </refsect1>

149 150 151 152 153 154 155 156
 <refsect1>
  <title>Examples</title>

  <para>
   To rename the view <literal>foo</literal> to
   <literal>bar</literal>:
<programlisting>
ALTER VIEW foo RENAME TO bar;
157 158 159 160 161 162 163 164 165 166 167
</programlisting>
  </para>

  <para>
   To attach a default column value to an updatable view:
<programlisting>
CREATE TABLE base_table (id int, ts timestamptz);
CREATE VIEW a_view AS SELECT * FROM base_table;
ALTER VIEW a_view ALTER COLUMN ts SET DEFAULT now();
INSERT INTO base_table(id) VALUES(1);  -- ts will receive a NULL
INSERT INTO a_view(id) VALUES(2);  -- ts will receive the current time
168
</programlisting></para>
T
Tom Lane 已提交
169
 </refsect1>
170 171 172 173 174 175 176 177 178 179 180 181 182 183

 <refsect1>
  <title>Compatibility</title>

  <para>
   <command>ALTER VIEW</command> is a <productname>PostgreSQL</>
   extension of the SQL standard.
  </para>
 </refsect1>

 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
184 185
   <member><xref linkend="sql-createview"></member>
   <member><xref linkend="sql-dropview"></member>
186 187 188
  </simplelist>
 </refsect1>
</refentry>