<!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: prof_sample - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: prof_sample - 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: prof_sample - 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_prof_sample" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - prof_sample</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_prof_enable.html" title="prof_enable">Prev</a> | <a class="link" href="fn_status.html" title="status">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 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 class="selected" 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>prof_sample</h2>
<div class="refpurpose">Adds a profiling sample to a profile being accumulated.</div>
<div class="funcsynopsis">
<span class="funcdef">
<span class="function">prof_sample</span>
</span>
(<span class="paramdef">in <span class="parameter">desc</span> varchar</span>,
<span class="paramdef">in <span class="parameter">time_spent</span> integer</span>,
<span class="paramdef">in <span class="parameter">flag</span> integer</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>
<span class="computeroutput">prof_sample</span> is used to adds a profiling
sample to a profile being accumulated.</p>
<p>The first argument is the name of the sampled section, the times called and
cumulative times will be totaled under this heading. The second argument is the
time in milliseconds. The third argument is a flag indicating whether the
section was successfully executed. 0 indicates success, 1 indicates execute of
the statement, 2 indicates fetch on a statement's resultset, 4 indicates error.
For more description of profiling capabilities see the section about
<a href="databaseadmsrv.html#EfficientSQL">SQL Execution Profiling</a>
in <a href="databaseadmsrv.html#ptune">Performance tuning</a> part of
Virtuoso documentation.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">desc – </span>
A <span class="computeroutput">VARCHAR</span>. Name of the sampled section.
</div>
<div class="refsect2">
<span class="refsect2title">time_spent – </span>
An <span class="computeroutput">INTEGER</span>. Time in milliseconds.
</div>
<div class="refsect2">
<span class="refsect2title">flag – </span>
An <span class="computeroutput">INTEGER</span>. flag indicating whether the
section was successfully executed. 0 - success, 1 - execute of
statement, 2 - fetch on a statement's resultset, 4 - error.
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>None.</p>
</div>
<a name="ex_prof_sample" />
<div class="example">
<div class="exampletitle">Example</div>
<div>
<pre class="programlisting">
create procedure do_prof_sample()
{
declare stime integer;
for(declare i integer;i < 5;i := i + 1){
stime := msec_time();
for(select * from Demo.demo.Customers) do sprintf('1');
for(select * from Demo.demo.Employees) do sprintf('1');
for(select * from Demo.demo.Order_Details) do sprintf('1');
prof_sample('3 selects execute',msec_time() - stime,1);
};
};
prof_enable(1);
select do_prof_sample();
prof_enable(0);
</pre>
</div>
<p>This will produce virtprof.out file of the sort:</p>
<div>
<pre class="programlisting">
Query Profile (msec)
Real 168, client wait 313, avg conc 1.863095 n_execs 6 avg exec 52
100 % under 1 s
0 % under 2 s
0 % under 5 s
0 % under 10 s
0 % under 30 s
2 stmts compiled 1 msec, 0 % prepared reused.
% total n-times n-errors
50 % 157 1 0 select do_prof_sample
49 % 156 5 0 3 selects execute
</pre>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="databaseadmsrv.html#EfficientSQL">SQL Execution profiling.</a>
</p>
<p>
<a href="fn_prof_enable.html">prof_enable()</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
>
430
