<!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: contains - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: contains - 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: contains - 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_contains" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - contains</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_composite_ref.html" title="composite_ref">Prev</a> | <a class="link" href="fn_vt_batch.html" title="vt_batch">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 class="selected" 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 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>contains</h2>
<div class="refpurpose">A text contains predicate</div>
<div class="funcsynopsis">
<span class="funcdef">boolean <span class="function">contains</span>
</span>
(<span class="paramdef">
<span class="parameter">column</span> varchar</span>,
<span class="paramdef">
<span class="parameter">expression</span> varchar</span>,
<span class="paramdefoptional">[<span class="optional">opt_or_value</span>integer]</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p> This is a SQL predicate that specifies a condition on a column
on which a free text index exists. The expression is a
<span class="computeroutput">string</span> matching the grammar of a text search expression.
This is computed for each evaluation of the contains predicate and
does not have to be a constant. For example a parameter or variable
of a containing score (e.g. procedure) is accepted. </p>
<p>The <span class="computeroutput">score_limit</span> is optional. If
specified, it should be a numeric expression determining the minimum score
required to produce a hit.</p>
<p>A virtual column named 'SCORE' is available in queries
involving a <span class="computeroutput">contains</span> predicate. This can for
example be returned in a result set or used for sorting.
Note that the name is in upper case and is case sensitive in all
case modes.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">column – </span>
The table column whose contents are free text indexed
</div>
<div class="refsect2">
<span class="refsect2title">expression – </span>
A <span class="computeroutput">string</span> matching the grammar of a text search
expression.
</div>
<div class="refsect2">
<span class="refsect2title">opt_or_value – </span>
May be one or more of the following:
<table class="varlist">
<tr>
<td align="right" valign="top" class="varterm" nowrap="nowrap">DESCENDING:</td>
<td>
<p>specifies that the search will produce the hit with the
greatest id first, as defined by <span class="computeroutput">integer</span> or
<span class="computeroutput">composite</span> collation.</p>
</td>
</tr>
<tr>
<td align="right" valign="top" class="varterm" nowrap="nowrap">START_ID ','
scalar_exp:</td>
<td>
<p>the first allowed document id to be selected by the
expression in its traversal order, e.g. least or equal for
ascending and greatest or equal for descending.</p>
</td>
</tr>
<tr>
<td align="right" valign="top" class="varterm" nowrap="nowrap">END_ID ','
scalar_exp:</td>
<td>
<p>the last allowed id in the traversal order. For
descending order the <span class="computeroutput">START_ID</span> must be >=
<span class="computeroutput">END_ID</span> for hits to
be able to exist. For ascending order the
<span class="computeroutput">START_ID</span> must be <=
<span class="computeroutput">END_ID</span> for hits to be able to
exist.</p>
</td>
</tr>
<tr>
<td align="right" valign="top" class="varterm" nowrap="nowrap">SCORE_LIMIT ','
scalar_exp:</td>
<td>
<p>Minimum score that hits must have or exceed to be
considered matches of the predicate.</p>
</td>
</tr>
<tr>
<td align="right" valign="top" class="varterm" nowrap="nowrap">RANGES ','
scalar_exp:</td>
<td>
<p>specifies that the query variable following the
<span class="computeroutput">RANGES</span> keyword will be bound to the word
position ranges of the hits of the expression inside the
document. The variable is in scope inside the enclosing
<strong>SELECT</strong> statement.</p>
</td>
</tr>
<tr>
<td align="right" valign="top" class="varterm" nowrap="nowrap">OFFBAND ','column:</td>
<td>
<p>Specifies that the following column will be
retrieved from the free text index instead of the
actual table. For this to be possible the column must have
been declared as offband with the <strong>CLUSTERED WITH</strong>
option of the <strong>CREATE TEXT INDEX</strong> statement.</p>
</td>
</tr>
</table>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>The contains is a predicate, therefore returning a
<span class="computeroutput">boolean</span>.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_contains" />
<div class="example">
<div class="exampletitle">Querying Free Text Indexed Columns using contains()</div>
<ul>
<li>
<p>Return the number of documents with one or more occurrences of "virtual"
immediately followed by "database".</p>
<div>
<pre class="programlisting">
select count (*) from docs
where contains (text, '"virtual database"')
</pre>
</div>
</li>
<li>
<p>Specify documents with performance and either
'tuning' or optimization' in any respective positions.</p>
<div>
<pre class="programlisting">
'performance and (tuning or optimization)'
</pre>
</div>
</li>
<li>
<p>
Match documents with the word graphics more than 100
words away from 'user' or 'interface'.
</p>
<div>
<pre class="programlisting">
'graphics and not (graphics near user near interface)'
</pre>
</div>
</li>
<li>
<p>
Match documents with SQL followed by a word beginning with 'interfac'.
</p>
<div>
<pre class="programlisting">
'"sql interfac*"'
</pre>
</div>
</li>
<li>
<p>
Match documents with words beginning with 'dragon' and not containing the phrase
'once upon a time'.
</p>
<div>
<pre class="programlisting">
'"dragon*" and not "once upon a time"'
</pre>
</div>
</li>
</ul>
</div>
<div class="note">
<div class="notetitle">Note:</div>
<p>
An expression may not consist of all negative terms, e.g. (not a) and (not
b) is not a valid expression but 'c and not a and not b' is a valid
expression.
</p>
<p>
Note that the NEAR connective may not be used between AND'ed or
OR'ed terms. It can be used to combine words or phrases.
</p>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="">xpath_contains()</a>
</p>
<p>
<a href="htmlconductorbar.html#freetext">The Free Text Index Chapter.</a>
</p>
<p>
<a href="fttfuncs.html">Other Free Text Functions.</a>
</p>
<p>
<a href="txttrig.html">Free Text Triggers.</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
>
206
