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
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
|
<?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_offband">
<refmeta>
<refentrytitle>vt_batch_feed_offband</refentrytitle>
<refmiscinfo>ft</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vt_batch_feed_offband</refname>
<refpurpose>Add offband information to a free text update batch.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_batch_feed_offband">
<funcprototype id="fproto_batch_feed_offband">
<funcdef><function>vt_batch_feed_offband</function></funcdef>
<paramdef>in <parameter>vt_batch</parameter> any</paramdef>
<paramdef>in <parameter>clustered_values</parameter> string</paramdef>
<paramdef>in <parameter>is_del</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vt_batch_feed_offband"><title>Description</title>
<para>This function allows you to add offband information to a free text update batch.
This should be done by index and unindex hook functions of the free text index
if and only if the index is created with both "CLUSTERED WITH (...)"
and "USING FUNCTION" options and the hook function returns non-zero
value, i.e. disables standard indexing of the document.
</para>
<para>This function is needed only for very unusual free text indexes.</para>
</refsect1>
<refsect1 id="params_vt_batch_feed_offband"><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.</para></refsect2>
<refsect2><title>clustered_values</title>
<para>must be a string that is made by serialization of a vector of offband values:
the length of vector is equal to number of columns listed in
"CLUSTERED WITH (...)" option of "CREATE TEXT INDEX" statement and
elements of the vector should be values of the listed fields for the current document.</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>
</refsect1>
<refsect1 id="ret_vt_batch_feed_offband"><title>Return Types</title><para>The returned value may vary from version to version and should not be user by application code</para></refsect1>
<refsect1 id="examples_vt_batch_feed_offband"><title>Examples</title>
<example id="ex_vt_batch_feed_offband"><title>Free text indexing of composed text clustered with offband columns</title>
<para>Table LEADS contains descriptions of articles of some set of newspapers.
Hook functions compose text that contains not only subject of article, but also title and first name of the author.
The hook function should return non-zero value to disable default processing of text of SUBJECT field but it
also disables the default processing of offband values.
If the call of <function>vt_batch_feed_offband</function> is missing then free text search of documents is still OK
but the call like SELECT ORG_ID FROM LEADS_TEST WHERE CONTAINS (SUBJECT, 'sample lead', OFFBAND, ORG_ID)
will return NULLs instead of correct values from ORG_ID column because they will not be retrieved from
free text index by "OFFBAND, ORG_ID".
</para>
<screen>
<![CDATA[
create table LEADS (
ORG_ID integer not null, -- ID of a newspaper.
LEAD_ID integer not null, -- Internal ID of an article in a newspaper.
FREETEXT_ID integer not null, -- Global document ID of an article.
SUBJECT varchar (255), -- Brief content of an article or a lead.
NAME_FIRST varchar (30), -- First name of the author.
NAME_LAST varchar (30), -- Last name of the author.
TITLE varchar (255), -- Title of an article.
primary key (ORG_ID, LEAD_ID));
create procedure LEADS_SUBJECT_INDEX_HOOK (inout vtb any, inout pkeyid integer)
{
declare text_to_index varchar;
declare oid any;
text_to_index := coalesce (
(select concat (
coalesce (SUBJECT, ''), ' ',
coalesce (TITLE, ''), ' ',
coalesce (NAME_FIRST, '') ) from LEADS
where FREETEXT_ID = pkeyid), null);
if (text_to_index is null)
return 0;
oid := coalesce ((select ORG_ID from LEADS where FREETEXT_ID = pkeyid), null);
vt_batch_feed (vtb, text_to_index, 0);
vt_batch_feed_offband ( vtb, serialize (vector (oid)), 0);
return 1;
}
create procedure
LEADS_SUBJECT_UNINDEX_HOOK (inout vtb any, inout pkeyid integer)
{
declare text_to_index varchar;
declare oid any;
text_to_index := coalesce (
(select concat (
coalesce (SUBJECT, ''), ' ',
coalesce (TITLE, ''),' ',
coalesce (NAME_FIRST, '') ) from LEADS
where FREETEXT_ID = pkeyid), null);
if (text_to_index is null)
return 0;
oid := coalesce ((select ORG_ID from LEADS where FREETEXT_ID = pkeyid), null);
vt_batch_feed (vtb, text_to_index, 1);
vt_batch_feed_offband ( vtb, serialize (vector (oid)), 1);
return 1;
}
create text index on LEADS (SUBJECT) with key FREETEXT_ID
clustered with (ORG_ID) using function;
]]>
</screen>
</example>
</refsect1>
<refsect1 id="seealso_vt_batch_feed_offband"><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">vt_batch_feed</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>
|
