<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="Function: vt_batch_feed_offband - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: vt_batch_feed_offband - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href="functions.html" title="Chapter Contents" />
<link rel="prev" href="appendixa.html" title="Appendix" />
<link rel="next" href="functions.html#.html" title="" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>Function: vt_batch_feed_offband - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="fn_vt_batch_feed_offband" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - vt_batch_feed_offband</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_vt_batch_feed.html" title="vt_batch_feed">Prev</a> | <a class="link" href="fn_vt_batch_update.html" title="VT_BATCH_UPDATE">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a class="selected" href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
<div>
<a href="functions.html#admin">Administration</a>
</div>
<div>
<a href="functions.html#aggr">Aggregate Functions</a>
</div>
<div>
<a href="functions.html#array">Array Manipulation</a>
</div>
<div>
<a href="functions.html#bpel">BPEL APIs</a>
</div>
<div>
<a href="functions.html#backup">Backup</a>
</div>
<div>
<a href="functions.html#compression">Compression</a>
</div>
<div>
<a href="functions.html#cursors">Cursor</a>
</div>
<div>
<a href="functions.html#time">Date & Time Manipulation</a>
</div>
<div>
<a href="functions.html#debug">Debug</a>
</div>
<div>
<a href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div>
<a href="functions.html#encoding">Encoding & Decoding</a>
</div>
<div>
<a href="functions.html#file">File Manipulation</a>
</div>
<div>
<a class="selected" href="functions.html#ft">Free Text</a>
</div>
<div class="selected">
<div>
<a href="fn_vt_batch_update.html">vt_batch_update</a>
</div>
<div>
<a href="fn_vt_drop_ftt.html">vt_drop_ftt</a>
</div>
<div>
<a href="fn_composite.html">composite</a>
</div>
<div>
<a href="fn_composite_ref.html">composite_ref</a>
</div>
<div>
<a href="fn_contains.html">contains</a>
</div>
<div>
<a href="fn_vt_batch.html">vt_batch</a>
</div>
<div>
<a href="fn_vt_batch_d_id.html">vt_batch_d_id</a>
</div>
<div>
<a href="fn_vt_batch_feed.html">vt_batch_feed</a>
</div>
<div>
<a class="selected" href="fn_vt_batch_feed_offband.html">vt_batch_feed_offban...</a>
</div>
<div>
<a href="fn_vt_create_text_index.html">vt_create_text_index</a>
</div>
<div>
<a href="fn_vt_is_noise.html">vt_is_noise</a>
</div>
</div>
<div>
<a href="functions.html#hash">Hashing / Cryptographic</a>
</div>
<div>
<a href="functions.html#ldap">LDAP</a>
</div>
<div>
<a href="functions.html#localization">Locale</a>
</div>
<div>
<a href="functions.html#mail">Mail</a>
</div>
<div>
<a href="functions.html#misc">Miscellaneous</a>
</div>
<div>
<a href="functions.html#number">Number</a>
</div>
<div>
<a href="functions.html#phrz">Phrases</a>
</div>
<div>
<a href="functions.html#rdf">RDF data</a>
</div>
<div>
<a href="functions.html#rmt">Remote SQL Data Source</a>
</div>
<div>
<a href="functions.html#repl">Replication</a>
</div>
<div>
<a href="functions.html#soap">SOAP</a>
</div>
<div>
<a href="functions.html#sql">SQL</a>
</div>
<div>
<a href="functions.html#string">String</a>
</div>
<div>
<a href="functions.html#txn">Transaction</a>
</div>
<div>
<a href="functions.html#type">Type Mapping</a>
</div>
<div>
<a href="functions.html#uddi">UDDI</a>
</div>
<div>
<a href="functions.html#udt">User Defined Types & The CLR</a>
</div>
<div>
<a href="functions.html#vad">VAD</a>
</div>
<div>
<a href="functions.html#jvmpl">Virtuoso Java PL API</a>
</div>
<div>
<a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
</div>
<div>
<a href="functions.html#ws">Web & Internet</a>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>vt_batch_feed_offband</h2>
<div class="refpurpose">Add offband information to a free text update batch.</div>
<div class="funcsynopsis">
<span class="funcdef">
<span class="function">vt_batch_feed_offband</span>
</span>
(<span class="paramdef">in <span class="parameter">vt_batch</span> any</span>,
<span class="paramdef">in <span class="parameter">clustered_values</span> string</span>,
<span class="paramdef">in <span class="parameter">is_del</span> integer</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>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.
</p>
<p>This function is needed only for very unusual free text indexes.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">vt_batch – </span>
must be an object returned by <span class="computeroutput">vt_batch</span> on which
<span class="computeroutput">vt_batch_d_id</span> has been called.</div>
<div class="refsect2">
<span class="refsect2title">clustered_values – </span>
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.</div>
<div class="refsect2">
<span class="refsect2title">is_del – </span>
if 0 means that the data is to be added, 1 means the data is to
be deleted.</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>The returned value may vary from version to version and should not be user by application code</p>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_vt_batch_feed_offband" />
<div class="example">
<div class="exampletitle">Free text indexing of composed text clustered with offband columns</div>
<p>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 <span class="computeroutput">vt_batch_feed_offband</span> 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".
</p>
<div>
<pre class="screen">
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;
</pre>
</div>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="fn_vt_drop_ftt.html">vt_drop_ftt</a>
</p>
<p>
<a href="fn_vt_batch.html">vt_batch</a>
</p>
<p>
<a href="fn_vt_batch_feed.html">vt_batch_feed</a>
</p>
<p>
<a href="fn_vt_batch_update.html">vt_batch_update</a>
</p>
<p>
<a href="fn_vt_create_text_index.html">vt_create_text_index</a>
</p>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
679
