create_rule.sgml 10.6 KB
Newer Older
1
<REFENTRY ID="SQL-CREATERULE">
2 3 4 5 6 7 8 9 10 11 12
 <REFMETA>
  <REFENTRYTITLE>
   CREATE RULE
  </REFENTRYTITLE>
  <REFMISCINFO>SQL - Language Statements</REFMISCINFO>
 </REFMETA>
 <REFNAMEDIV>
  <REFNAME>
   CREATE RULE
  </REFNAME>
  <REFPURPOSE>
13
   Defines a new rule
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
  </REFPURPOSE>
 <REFSYNOPSISDIV>
  <REFSYNOPSISDIVINFO>
   <DATE>1998-04-15</DATE>
  </REFSYNOPSISDIVINFO>
  <SYNOPSIS>
   CREATE RULE <replaceable class="parameter">name</replaceable>
       AS ON <replaceable class="parameter">event</replaceable>
       TO <replaceable class="parameter">object</replaceable> [WHERE <replaceable class="parameter">condition</replaceable>]
       DO [INSTEAD]
       [<replaceable class="parameter">action</replaceable> | NOTHING ]
  </SYNOPSIS>
  
  <REFSECT2 ID="R2-SQL-CREATERULE-1">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Inputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">name</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   The name of a rule to create.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">event</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Event is one of <literal>select</literal>, <literal>update</literal>, <literal>delete</literal> or <literal>insert</literal>.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">object</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Object is either <replaceable class="parameter">table</replaceable> or <replaceable class="parameter">table</replaceable>.<replaceable class="parameter">column</replaceable>.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">condition</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Any SQL <literal>where</literal> clause. <literal>new</literal> or
	   <literal>current</literal> can appear instead of an instance
	   variable whenever an instance variable is permissible in SQL.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue><replaceable class="parameter">action</replaceable></ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Any SQL-statement. <literal>new</literal> or
	   <literal>current</literal> can appear instead of an instance
	   variable whenever an instance variable is permissible in SQL.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </VARIABLELIST>
     </LISTITEM>
    </VARLISTENTRY>
   </VARIABLELIST>
  </REFSECT2>
  
  <REFSECT2 ID="R2-SQL-CREATERULE-2">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Outputs
   </TITLE>
   <PARA>
   </PARA>
   <VARIABLELIST>
    <VARLISTENTRY>
     <TERM>
     </TERM>
     <LISTITEM>
      <PARA>
       <VARIABLELIST>
	<VARLISTENTRY>
	 <TERM>
	  <ReturnValue>CREATE</ReturnValue>
	 </TERM>
	 <LISTITEM>
	  <PARA>
	   Message returned if the rule is successfully created.
	  </PARA>
	 </LISTITEM>
	</VARLISTENTRY>
       </variablelist>
     </LISTITEM>
    </VARLISTENTRY>
   </VARIABLELIST>
   
  </REFSECT2>
 </REFSYNOPSISDIV>
 
 <REFSECT1 ID="R1-SQL-CREATERULE-1">
  <REFSECT1INFO>
   <DATE>1998-04-15</DATE>
  </REFSECT1INFO>
  <TITLE>
   Description
  </TITLE>
  <PARA>
   The semantics of a rule is that at the time an individual instance is
   accessed, updated, inserted or deleted, there is a current instance (for
   retrieves, updates and deletes) and a new instance (for updates and
   appends).  If the <replaceable class="parameter">event</replaceable>
   specified in the <literal>on</literal> clause and the
   <replaceable class="parameter">condition</replaceable> specified in the
   <literal>where</literal> clause are true for the current instance, the
   <replaceable class="parameter">action</replaceable> part of the rule is
   executed. First, however, values from fields in the current instance
   and/or the new instance are substituted for
   <literal> current.</literal><replaceable class="parameter">attribute-name</replaceable>
   and <literal>new.</literal><replaceable class="parameter">attribute-name</replaceable>.
  </para>
  <para>
   The <replaceable class="parameter">action</replaceable> part of the rule
   executes with the same command and transaction identifier as the user
   command that caused activation.
  </para>
  
  <REFSECT2 ID="R2-SQL-CREATERULE-3">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    Notes
   </TITLE>
   <para>
    A note of caution about SQL rules is in  order.  If the same class name
    or instance variable appears in the
    <replaceable class="parameter">event</replaceable>, the
    <replaceable class="parameter">condition</replaceable> and the
    <replaceable class="parameter">action</replaceable> parts of a rule,
    they are all considered different tuple variables. More accurately,
    <literal>new</literal> and <literal>current</literal> are the only tuple
    variables that are shared between these clauses. For example, the following
    two rules have the same semantics:
    <programlisting>
     on update to EMP.salary where EMP.name = "Joe"
	  do update EMP ( ... ) where ...

     on update to EMP-1.salary where EMP-2.name = "Joe"
	  do update EMP-3 ( ... ) where ...
    </programlisting>
    Each rule can have the optional tag <literal>instead</literal>. Without
    this tag, <replaceable class="parameter">action</replaceable> will be
    performed in addition to the user command when the
    <replaceable class="parameter">event</replaceable> in the
    <replaceable class="parameter">condition</replaceable> part of the rule
    occurs. Alternately, the
    <replaceable class="parameter">action</replaceable> part will be done
    instead of the user command. In this later case, the
    <replaceable class="parameter">action</replaceable> can be the keyword
    <literal>nothing</literal>.
   </para>
   <para>
    When choosing between the rewrite and instance rule systems for a
    particular rule application, remember that in the rewrite system,
    <literal>current</literal> refers to a relation and some qualifiers
    whereas in the instance system it refers to an instance (tuple).
   </para>
   <para>
    It is very important to note that the rewrite rule system
    will neither detect nor process circular rules. For example, though each
    of the following two rule definitions are accepted by Postgres, the
    retrieve command will cause Postgres to crash:
    <example>
     <title>Example of a circular rewrite rule combination.</title>
     <programlisting>
	  create rule bad_rule_combination_1 is
		  on select to EMP
		  do instead select to TOYEMP

	  create rule bad_rule_combination_2 is
		  on select to TOYEMP
		  do instead select to EMP
     </programlisting>
     <para>	 
      This attempt to retrieve from EMP will cause Postgres to crash.
      <programlisting>
	  select * from EMP
      </programlisting></para>
    </example>
   </para>
   <para>
    You must have rule definition access to a class in order
    to define a rule on it (see change acl(l)).
    <comment>
     There is no manpage change or change_acl.  What is intended?
    </comment>
   </PARA>
  </REFSECT2>
 </refsect1>
 
 <REFSECT1 ID="R1-SQL-CREATERULE-2">
  <TITLE>
   Usage
  </TITLE>
  <PARA>
   Make Sam get the same salary adjustment as Joe
   
   <programlisting>
	  create rule example_1 is
		 on update EMP.salary where current.name = "Joe"
		 do update EMP (salary = new.salary)
		  where EMP.name = "Sam"
   </programlisting>
   
   At the time Joe receives a salary adjustment, the event
   will become true and Joe's current instance and proposed
   new instance are available to the execution routines.
   Hence, his new salary is substituted into the action part
   of the rule which is subsequently executed.  This propagates
   Joe's salary on to Sam.
  </para>
  <para>
   Make Bill get Joe's salary when it is accessed
   <programlisting>
	  create rule example_2 is

		 on select to EMP.salary
			where current.name = "Bill"
		 do instead
		  select (EMP.salary) from EMP where EMP.name = "Joe"
   </programlisting>
  </para>
  <para>
   Deny Joe access to the salary of employees in the shoe
   department. (<function>pg_username()</function> returns the name of
   the current user)
   <programlisting>  
	  create rule example_3 is
		 on select to EMP.salary
		 where current.dept = "shoe" and pg_username() = "Joe"
		 do instead nothing
   </programlisting>
  </para>
  <para>
   Create a view of the employees working in the toy department.
   <programlisting>
	  create TOYEMP(name = char16, salary = int4)

	  create rule example_4 is
		 on select to TOYEMP
		 do instead select (EMP.name, EMP.salary) from EMP
		 where EMP.dept = "toy"
   </programlisting>
  </para>
  <para>
   All new employees must make 5,000 or less
   <programlisting>
	  create rule example_5 is
		  on insert to EMP where new.salary > 5000
		  do update newset salary = 5000
   </programlisting>
  </PARA>
 </REFSECT1>
 
 <REFSECT1 ID="R1-SQL-CREATERULE-3">
  <TITLE>
   Bugs
  </TITLE>
  <PARA>
   <literal>instead</literal> rules do not work properly.
  </para>
  <para>
   The object in a SQL rule cannot be an array reference and
   cannot have parameters.
  </para>
  <para>
   Aside from the "oid" field, system attributes cannot be
   referenced anywhere in a rule. Among other things, this
   means that functions of instances (e.g., "<literal>foo(emp)</literal>" where
   "<literal>emp</literal>" is a class) cannot be called anywhere in a rule.
  </para>
  <para>
   The rule system stores the rule text and query plans as
   text attributes. This implies that creation of rules may
   fail if the rule plus its various internal representations
   exceed some value that is on the order of one page (8KB).
   </PARA>
  
 <REFSECT1 ID="R1-SQL-CREATERULE-4">
  <TITLE>
   Compatibility
  </TITLE>
  <PARA>
   CREATE RULE statement is a PostgreSQL language extension.
  </PARA>
  
  <REFSECT2 ID="R2-SQL-CREATERULE-4">
   <REFSECT2INFO>
    <DATE>1998-04-15</DATE>
   </REFSECT2INFO>
   <TITLE>
    SQL92
   </TITLE>
   <para>
    There is no CREATE RULE statement in SQL92.
   </para>
  </refsect2>
 </refsect1>
</REFENTRY>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
363
-->