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
89
90
91
92
93
|
<?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_batch">
<refmeta>
<refentrytitle>vt_batch</refentrytitle>
<refmiscinfo>ft</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vt_batch</refname>
<refpurpose>Returns a vt batch object.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_batch">
<funcprototype id="fproto_batch">
<funcdef>batch object <function>vt_batch</function></funcdef>
<paramdef></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vt_batch"><title>Description</title>
<para>
This object can be used to update a free text index by feeding document
information into it using vt_batch_d_id to set the free text document ID and
vt_batch_feed to feed actual words.
</para>
<para>
This object may not be assigned to other variables and may only be passed as
an inout parameter.
</para>
<para>
The batch is applied to the index by calling the
VT_BATCH_PROCESS_<table>_<column> function generated
by <link linkend="createtxtidxstmt">CREATE TEXT INDEX</link>.
</para>
</refsect1>
<!-- <refsect1 id="params_vt_batch"><title>Parameters</title>
<refsect2><title></title>
<para></para></refsect2>
</refsect1>
-->
<refsect1 id="ret_vt_batch"><title>Return Types</title><para></para></refsect1>
<refsect1 id="errors_vt_batch"><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_batch"><title>Examples</title>
<example id="ex_"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_vt_batch"><title>See Also</title>
<para><link linkend="fn_vt_drop_ftt">vt_drop_ftt</link></para>
<para><link linkend="fn_vt_batch_d_id">vt_batch_d_id</link></para>
<para><link linkend="fn_vt_batch_update">vt_batch_update</link></para>
<para><link linkend="fn_vt_create_text_index">vt_create_text_index</link></para>
</refsect1>
</refentry>
|
