<!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: key_estimate - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: key_estimate - 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: key_estimate - 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_key_estimate" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - key_estimate</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_status.html" title="status">Prev</a> | <a class="link" href="fn_system.html" title="system">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 class="selected" href="functions.html#admin">Administration</a>
</div>
<div class="selected">
<div>
<a href="fn_vacuum.html">db.dba.vacuum</a>
</div>
<div>
<a href="fn_USER_CHANGE_PASSWORD.html">user_change_password</a>
</div>
<div>
<a href="fn_USER_CREATE.html">user_create</a>
</div>
<div>
<a href="fn_USER_DROP.html">user_drop</a>
</div>
<div>
<a href="fn_USER_GET_OPTION.html">user_get_option</a>
</div>
<div>
<a href="fn_USER_GRANT_ROLE.html">user_grant_role</a>
</div>
<div>
<a href="fn_USER_REVOKE_ROLE.html">user_revoke_role</a>
</div>
<div>
<a href="fn_USER_ROLE_CREATE.html">user_role_create</a>
</div>
<div>
<a href="fn_USER_ROLE_DROP.html">user_role_drop</a>
</div>
<div>
<a href="fn_USER_SET_OPTION.html">user_set_option</a>
</div>
<div>
<a href="fn_USER_SET_QUALIFIER.html">user_set_qualifier</a>
</div>
<div>
<a href="fn_dbf_set.html">__dbf_set</a>
</div>
<div>
<a href="fn_cfg_item_count.html">cfg_item_count</a>
</div>
<div>
<a href="fn_cfg_item_name.html">cfg_item_name</a>
</div>
<div>
<a href="fn_cfg_item_value.html">cfg_item_value</a>
</div>
<div>
<a href="fn_cfg_section_count.html">cfg_section_count</a>
</div>
<div>
<a href="fn_cfg_section_name.html">cfg_section_name</a>
</div>
<div>
<a href="fn_cfg_write.html">cfg_write</a>
</div>
<div>
<a href="fn_checkpoint_interval.html">checkpoint_interval</a>
</div>
<div>
<a href="fn_disconnect_user.html">disconnect_user</a>
</div>
<div>
<a href="fn_fk_check_input_values.html">fk_check_input_value...</a>
</div>
<div>
<a class="selected" href="fn_key_estimate.html">key_estimate</a>
</div>
<div>
<a href="fn_log_enable.html">log_enable</a>
</div>
<div>
<a href="fn_log_text.html">log_text</a>
</div>
<div>
<a href="fn_prof_enable.html">prof_enable</a>
</div>
<div>
<a href="fn_prof_sample.html">prof_sample</a>
</div>
<div>
<a href="fn_server_root.html">server_root</a>
</div>
<div>
<a href="fn_status.html">status</a>
</div>
<div>
<a href="fn_sys_lockdown.html">sys_lockdown</a>
</div>
<div>
<a href="fn_sys_stat.html">sys_stat</a>
</div>
<div>
<a href="fn_system.html">system</a>
</div>
<div>
<a href="fn_trace_status.html">trace_status</a>
</div>
<div>
<a href="fn_user_set_password.html">user_set_password</a>
</div>
<div>
<a href="fn_virtuoso_ini_path.html">virtuoso_ini_path</a>
</div>
</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 href="functions.html#ft">Free Text</a>
</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>key_estimate</h2>
<div class="refpurpose">Get an estimate of row count for a given set of leading index key parts</div>
<div class="funcsynopsis">
<span class="funcdef">
<span class="function">key_estimate</span>
</span>
(<span class="paramdef">in <span class="parameter">table_name</span> varchar</span>,
<span class="paramdef">in <span class="parameter">index_name</span> varchar</span>,
<span class="paramdef">in <span class="parameter">k1</span> any</span>,
<span class="paramdef">
<span class="parameter">...</span>
</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>Given a table and an index, this function takes a random sample of the index,
with the first key part equal to the third argument, the second equal to the fourth argument and so on.
If only the table and index are given, the returned value is the approximate count of the entire index.
</p>
<p>Normal cast rules are applied to convert the arguments to the types of the corresponding key parts.
If the cast fails, -1 is returned.
</p>
<p>The estimates are typically within 10% of the real count. If there have been random
deletions or inserts leading to uneven page filling or if index entries are of greatly varying $
length, the estimates may be less precise.
</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">table_name – </span>
The name of the table as appears in SYS_KEYS, case sensitive.
</div>
<div class="refsect2">
<span class="refsect2title">index_name – </span>
The name of the index as appears in sys_keys, case sensitive.
</div>
<div class="refsect2">
<span class="refsect2title">k1 – </span>
The value of the first key part. Any number of arguments, up to the number
of key parts in the index in question may follow.
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return</div>
<p>Key_estimate returns the approximate count of entries in the index with the
specified values in the leading key parts. -1 if cannot be determined.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Example</div>
<a name="ex_key_estimate" />
<div class="example">
<div class="exampletitle">Returns the approximate count of entries in index STR1 where the first key part is
the string '123'.</div>
<div>
<pre class="programlisting">
select key_estimate ('DB.DBA.T1', 'STR1', '123');
</pre>
</div>
</div>
</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
>
371
