File: vt_create_ftt.xml

package info (click to toggle)
virtuoso-opensource 6.1.4%2Bdfsg1-7
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 245,116 kB
  • sloc: ansic: 639,631; sql: 439,225; xml: 287,085; java: 61,048; sh: 38,723; cpp: 36,889; cs: 25,240; php: 12,562; yacc: 9,036; lex: 7,149; makefile: 6,093; jsp: 4,447; awk: 1,643; perl: 1,017; ruby: 1,003; python: 329
file content (88 lines) | stat: -rw-r--r-- 3,555 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- 
 -  
 -  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
 -  project.
 -  
 -  Copyright (C) 1998-2006 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_vt_create_ftt">
  <refmeta>
    <refentrytitle>VT_CREATE_FTT</refentrytitle>
    <refmiscinfo>ft</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>VT_CREATE_FTT</refname>
    <refpurpose>create a free text trigger</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_vt_create_ftt"> 
      <funcprototype id="fproto_vt_create_ftt">
	  <funcdef>DB.DBA.<function>VT_CREATE_FTT</function></funcdef>
	  <paramdef>in <parameter>target_table </parameter>varchar </paramdef>
	  <paramdef>in <parameter>opt_id_column or NULL </parameter>varchar </paramdef>
	  <paramdef>in <parameter>opt_data_column or NULL </parameter>varchar </paramdef>
        <paramdef>in <parameter>suppress_error_return </parameter>integer </paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_vt_create_ftt"><title>Description</title>
    <para>Creates a free text trigger on the target table</para>
  </refsect1>
  <refsect1 id="params_vt_create_ftt"><title>Parameters</title>
    <refsect2><title>target_table</title>
      <para>the table to create the trigger for</para></refsect2>
    <refsect2><title>opt_id_column</title>
      <para>the column for unique identification of document</para></refsect2>
    <refsect2><title>opt_data_column</title>
      <para>the column where content is stored</para></refsect2>
    <refsect2><title>suppress_error_return</title>
      <para>a boolean integer, 1 meaning true</para></refsect2>
  </refsect1>
  <refsect1 id="ret_vt_create_ftt"><title>Return Types</title><para></para></refsect1>
  <refsect1 id="errors_vt_create_ftt"><title>Errors</title>
    <table><title>Errors signalled by</title>
      <tgroup cols="4">
       <thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
	<tbody>
	  <row>
	    <entry><errorcode></errorcode></entry>
	    <entry><errorcode></errorcode></entry>
	    <entry><errorname></errorname></entry>
	    <entry></entry>
	  </row>
	</tbody>
      </tgroup>
    </table>
  </refsect1>
<!--  <refsect1 id="examples_vt_create_ftt"><title>Examples</title>
    <example id="ex_vt_create_ftt"><title></title>
      <para></para>
      <screen></screen>
    </example>
  </refsect1>
-->
  <refsect1 id="seealso_vt_create_ftt"><title>See Also</title>
    <para><link linkend="fn_vt_drop_ftt">vt_drop_ftt</link></para>
    <para><link linkend="fn_vt_batch">vt_batch</link></para>
    <para><link linkend="fn_vt_batch_update">vt_batch_update</link></para>
    <para><link linkend="fn_vt_batch_feed">vt_batch_feed</link></para>
  </refsect1>
</refentry>