<!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 - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: vt_batch_feed - 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 - 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" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - vt_batch_feed</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_vt_batch_d_id.html" title="vt_batch_d_id">Prev</a> | <a class="link" href="fn_vt_batch_feed_offband.html" title="vt_batch_feed_offband">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 class="selected" href="fn_vt_batch_feed.html">vt_batch_feed</a>
</div>
<div>
<a 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</h2>
<div class="refpurpose">Add words to a free text update batch.</div>
<div class="funcsynopsis">
<span class="funcdef">
<span class="function">vt_batch_feed</span>
</span>
(<span class="paramdef">in <span class="parameter">vt_batch</span> any</span>,
<span class="paramdef">in <span class="parameter">text_or_xml</span> any</span>,
<span class="paramdef">in <span class="parameter">is_del</span> integer</span>,
<span class="paramdefoptional">[in <span class="optional">is_xml</span> integer]</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>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 <span class="computeroutput">text_or_xml</span>
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.</p>
<p>
If one wishes to mix XML and non-XML documents, knowledge of details of the indexing method is needed.
<span class="computeroutput">vt_batch_feed</span> assigns a sequence number to every word of the provided document
using an internal counter.
The call of <span class="computeroutput">vt_batch_d_id</span> 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 <span class="computeroutput">vt_batch_feed</span> after the last <span class="computeroutput">vt_batch_d_id</span>.
Moreover, <span class="computeroutput">xcontains</span> will ignore words from text documents
that were fed after the first XML document, only <span class="computeroutput">contains</span> will use all data.</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; e.g. it can be called inside the index hook function</div>
<div class="refsect2">
<span class="refsect2title">text_or_xml – </span>
must be a blob, wide blob, varchar, nvarchar or XML entity object.</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 class="refsect2">
<span class="refsect2title">is_xml – </span>
if 1, means that the <span class="computeroutput">text_or_xml</span> must be a well formed XML fragment and
that it will be indexed for use with <span class="computeroutput">xcontains</span>. The default is 0 that means
"plain text".</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>None.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<p>Please refer to examples for function <a href="fn_vt_batch_feed_offband.html">vt_batch_feed_offband</a>.</p>
</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_offband.html">vt_batch_feed_offband</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
>
678
