1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_prof_enable">
<refmeta>
<refentrytitle>prof_enable</refentrytitle>
<refmiscinfo>admin</refmiscinfo>
</refmeta>
<refnamediv>
<refname>prof_enable</refname>
<refpurpose>Control virtuoso profiling</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_prof_enable">
<funcprototype id="fproto_prof_enable">
<funcdef><function>prof_enable</function></funcdef>
<paramdef>in <parameter>flag</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_prof_enable"><title>Description</title>
<para><function>prof_enable</function> is used to enable or disable
profiling of execution times, SQL statements and web requests.
Passing flag value 1, enables profiling, causing times of statement
executions, which begin and end while profiling is on, to be
accumulated.</para>
<para>When called with a flag of 0, the accumulation is stopped and
results gathered so far are written into file named virtprof.out in
the server's working directory. For a description of the file, see
section about <link linkend="EfficientSQL">SQL Execution Profiling</link>
in <link linkend="ptune">Performance tuning</link> part of
Virtuoso documentation.</para>
</refsect1>
<refsect1 id="params_prof_enable"><title>Parameters</title>
<refsect2><title>flag</title>
<para>An <type>INTEGER</type>. Valid values are 1 or 0.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_prof_enable"><title>Return Types</title>
<para>None.</para>
</refsect1>
<refsect1 id="errors_prof_enable"><title>Errors</title>
<para>No errors are signalled by <function>prof_enable</function></para>
<!-- <table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode></errorcode></entry>
<entry><errorcode></errorcode></entry>
<entry><errorname></errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table> -->
</refsect1>
<refsect1 id="examples_prof_enable"><title>Examples</title>
<example id="ex_prof_enable"><title>Simple example</title>
<para>Enable profiling.</para>
<screen>SQL> prof_enable(1);
</screen>
</example>
</refsect1>
<refsect1 id="seealso_prof_enable"><title>See Also</title>
<para><link linkend="EfficientSQL">SQL Execution profiling.</link></para>
<para><link linkend="fn_prof_sample">prof_sample()</link></para>
</refsect1>
</refentry>
|
