php-doc-en/reference/mongo/mongodb/getprofilinglevel.xml
2013-07-30 06:39:35 +00:00

83 lines
2.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodb.getprofilinglevel" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB::getProfilingLevel</refname>
<refpurpose>Gets this database&apos;s profiling level</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>MongoDB::getProfilingLevel</methodname>
<void/>
</methodsynopsis>
<para>
This returns the current database profiling level.
</para>
<para>
The database profiler tracks query execution times. If you turn it on (say,
using <function>MongoDB::setProfilingLevel</function> or the shell), you can
see how many queries took longer than a given number of milliseconds or the
timing for all queries.
</para>
<para>
Note that profiling slows down queries, so it is better to use in development
or testing than in a time-sensitive application.
</para>
<para>
This function is equivalent to running:
<programlisting role="php">
<![CDATA[
<?php
public function getProfilingLevel() {
return $this->command(array('profile' => -1));
}
?>
]]>
</programlisting>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the profiling level.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>MongoDB core docs on <link xlink:href="&url.mongodb.dochub.profiling;">profiling</link></member>
<member><methodname>MongoDB::setProfilingLevel</methodname></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->