.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Profile 3pm" .TH Profile 3pm "2018-01-18" "perl v5.26.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" .Vb 2 \& DBIx::Profile \- DBI query profiler \& Version 1.0 \& \& Copyright (c) 1999,2000 Jeff Lathan, Kerry Clendinning. \& All rights reserved. \& \& This program is free software; you can redistribute it and/or modify it \& under the same terms as Perl itself. .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use DBIx::Profile; or "perl \-MDBIx::Profile " \& use DBI; \& $dbh\->printProfile(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" .Vb 4 \& DBIx::Profile is a quick and easy, and mostly transparent, profiler \& for scripts using DBI. It collects information on the query \& level, and keeps track of first, failed, normal, and total amounts \& (count, wall clock, CPU time) for each function on the query. \& \& NOTE: DBIx::Profile use Time::HiRes to clock the wall time and \& the old standby times() to clock the CPU time. The CPU time is \& pretty coarse. \& \& DBIx::Profile can also trace the execution of queries. It will print \& a timestamp and the query that was called. This is optional, and \& occurs only when the environment variable DBIXPROFILETRACE is set \& to 1. (ex: (bash) export DBIXPROFILETRACE=1). \& \& Not all DBI methods are profiled at this time. \& Except for replacing the existing "use" and "connect" statements, \& DBIx::Profile allows DBI functions to be called as usual on handles. \& \& Prints information to STDERR, prefaced with the pid. .Ve .SH "RECIPE" .IX Header "RECIPE" .Vb 5 \& 1) Add "use DBIx::Profile" or execute "perl \-MDBIx::Profile " \& 2) Optional: add $dbh\->printProfile (will execute during \& disconnect otherwise) \& 3) Run code \& 4) Data output will happen at printProfile or $dbh\->disconnect; .Ve .SH "METHODS" .IX Header "METHODS" .Vb 2 \& printProfile \& $dbh\->printProfile(); \& \& Will print out the data collected. \& If this is not called before disconnect, disconnect will call \& printProfile. \& \& setLogFile \& $dbh\->setLogFile("ProfileOutput.txt"); \& \& Will save all output to the file. .Ve .SH "AUTHORS" .IX Header "AUTHORS" .Vb 2 \& Jeff Lathan, lathan@pobox.com \& Kerry Clendinning, kerry@deja.com \& \& Aaron Lee, aaron@pointx.org \& Michael G Schwern, schwern@pobox.com .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" .Vb 1 \& L, L .Ve