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
|
<?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_vt_batch_feed">
<refmeta>
<refentrytitle>vt_batch_feed</refentrytitle>
<refmiscinfo>ft</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vt_batch_feed</refname>
<refpurpose>Add words to a free text update batch.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_batch_feed">
<funcprototype id="fproto_batch_feed">
<funcdef><function>vt_batch_feed</function></funcdef>
<paramdef>in <parameter>vt_batch</parameter> any</paramdef>
<paramdef>in <parameter>text_or_xml</parameter> any</paramdef>
<paramdef>in <parameter>is_del</parameter> integer</paramdef>
<paramdef><optional>in <parameter>is_xml</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vt_batch_feed"><title>Description</title>
<para>This function allows you to add words to a free text update batch.
It can be called in sequence to feed group of documents that share a common document ID
and the result is similar to the single call whose <parameter>text_or_xml</parameter>
parameter is concatenation of documents of that group. It is even allowed to mix
XML and non-XML documents by feeding an XML document and some text documents:
the first document to feed may be an XML document, other documents should be only texts.</para>
<para>
If one wishes to mix XML and non-XML documents, knowledge of details of the indexing method is needed.
<function>vt_batch_feed</function> assigns a sequence number to every word of the provided document
using an internal counter.
The call of <function>vt_batch_d_id</function> not only sets document id but also resets this counter to 0.
The first element of an XML document should have number 0 so it is impossible to feed an XML document if
there were other calls of <function>vt_batch_feed</function> after the last <function>vt_batch_d_id</function>.
Moreover, <function>xcontains</function> will ignore words from text documents
that were fed after the first XML document, only <function>contains</function> will use all data.</para>
</refsect1>
<refsect1 id="params_vt_batch_feed"><title>Parameters</title>
<refsect2><title>vt_batch</title>
<para>must be an object returned by <function>vt_batch</function> on which
<function>vt_batch_d_id</function> has been called; e.g. it can be called inside the index hook function</para></refsect2>
<refsect2><title>text_or_xml</title>
<para>must be a blob, wide blob, varchar, nvarchar or XML entity object.</para></refsect2>
<refsect2><title>is_del</title>
<para>if 0 means that the data is to be added, 1 means the data is to
be deleted.</para></refsect2>
<refsect2><title>is_xml</title>
<para>if 1, means that the <parameter>text_or_xml</parameter> must be a well formed XML fragment and
that it will be indexed for use with <function>xcontains</function>. The default is 0 that means
"plain text".</para></refsect2>
</refsect1>
<refsect1 id="ret_vt_batch_feed"><title>Return Types</title><para>None.</para></refsect1>
<refsect1 id="examples_vt_batch_feed"><title>Examples</title>
<para>Please refer to examples for function <link linkend="fn_vt_batch_feed_offband">vt_batch_feed_offband()</link>.</para>
</refsect1>
<refsect1 id="seealso_vt_batch_feed"><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_feed_offband">vt_batch_feed_offband()</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>
|
