File: table_set_policy.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (72 lines) | stat: -rw-r--r-- 3,020 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 -  
 -  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
 -  project.
 -  
 -  Copyright (C) 1998-2018 OpenLink Software
 -  
 -  This project is free software; you can redistribute it and/or modify it
 -  under the terms of the GNU General Public License as published by the
 -  Free Software Foundation; only version 2 of the License, dated June 1991.
 -  
 -  This program is distributed in the hope that it will be useful, but
 -  WITHOUT ANY WARRANTY; without even the implied warranty of
 -  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 -  General Public License for more details.
 -  
 -  You should have received a copy of the GNU General Public License along
 -  with this program; if not, write to the Free Software Foundation, Inc.,
 -  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 -  
 -  
-->
<refentry id="fn_table_set_policy">
  <refmeta>
    <refentrytitle>table_set_policy</refentrytitle>
    <refmiscinfo>sql</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>table_set_policy</refname>
    <refpurpose>Sets policy function to table.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_table_set_policy">
      <funcprototype id="fproto_table_set_policy">
        <funcdef><function>table_set_policy</function></funcdef>
          <paramdef>in <parameter>tablename</parameter> varchar</paramdef>
          <paramdef>in <parameter>policypl</parameter> varchar</paramdef>
          <paramdef><optional>in <parameter>policy_scope</parameter> varchar</optional></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_table_set_policy"><title>Description</title>
	<para>Sets policy function to table.</para>
  </refsect1>
  <refsect1 id="params_table_set_policy">
    <title>Parameters</title>
    <refsect2><title>tablename</title>
      <para>is the table to which the policy applies</para>
    </refsect2>
    <refsect2><title>policypl</title>
      <para>is the actual Virtuoso Stored Procedure based policy</para>
    </refsect2>
    <refsect2><title>policy_scope</title>
      <para>defines the scope of the policy in relation to SQL statement processing using one of more of the following values; I (for Inserts), D (for Deletions), U (for Updates), S (for Selects).</para>
    </refsect2>
  </refsect1>
  <refsect1 id="ret_table_set_policy"><title>Return Types</title>
    <para>varchar</para>
  </refsect1>
	<note>
		<title>Note:</title>
		<para>Note that the policy_pl procedure should have the following signature (this is how it's called by the Virtuoso SQL compiler to get the policy) :
    <programlisting><![CDATA[<procedure_name> (in table varchar, in op varchar) returns varchar]]></programlisting>
    </para>
	</note>

  <refsect1 id="seealso_table_set_policy">
    <title>See Also</title>
    <para><link linkend="fn_table_drop_policy"><function>table_drop_policy()</function></link></para>
  </refsect1>
</refentry>