DBIx/Class/Storage/Statistics.pm

filter: Statementstmt 84.3% 54 / 64 Branchbran 67.8% 19 / 28 Conditioncond 66.6% 4 / 6 MC/DCmcdc 50.0% 2 / 4 Subroutinesub 82.3% 14 / 17 Podpod 100% 10 / 10 totaltotal 79.8% 103 / 129 CC 17 SCAR 12.4
CC
17
Cov
79%
_build_debugfh
6.1
svp_begin
6.0
svp_release
6.0
CRAP 3.5
« DBIx/Class/CDBICompat/Pager.pm ↑ Summary DBIx/Class/Relationship/Accessor.pm »
1 package DBIx::Class::Storage::Statistics;
2  
3 38 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 38 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 38 ▶use DBIx::Class::_Util qw(sigwarn_silencer qsub);
Subroutine BEGIN: called CC=1 SCAR=0.0
7 38 ▶use IO::Handle ();
Subroutine BEGIN: called CC=1 SCAR=0.0
8 38 ▶use Moo;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 38 extends 'DBIx::Class';
10 38 ▶use namespace::clean;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 =head1 NAME
13  
14 DBIx::Class::Storage::Statistics - SQL Statistics
15  
16 =head1 SYNOPSIS
17  
18 =head1 DESCRIPTION
19  
20 This class is called by DBIx::Class::Storage::DBI as a means of collecting
21 statistics on its actions. Using this class alone merely prints the SQL
22 executed, the fact that it completes and begin/end notification for
23 transactions.
24  
25 To really use this class you should subclass it and create your own method
26 for collecting the statistics as discussed in L<DBIx::Class::Manual::Cookbook>.
27  
28 =head1 METHODS
29  
30 =head2 new
31  
32 Returns a new L<DBIx::Class::Storage::Statistics> object.
33  
34 =head2 debugfh
35  
36 Sets or retrieves the filehandle used for trace/debug output. This should
37 be an L<IO::Handle> compatible object (only the
38 L<< print|IO::Handle/METHODS >> method is used). By
39 default it is initially set to STDERR - although see discussion of the
40 L<DBIC_TRACE|DBIx::Class::Storage/DBIC_TRACE> environment variable.
41  
42 Invoked as a getter it will lazily open a filehandle and set it to
43 L<< autoflush|perlvar/HANDLE->autoflush( EXPR ) >> (if one is not
44 already set).
45  
46 =cut
47  
48 # FIXME - there ought to be a way to fold this into _debugfh itself
49 # having the undef re-trigger the builder (or better yet a default
50 # which can be folded in as a qsub)
51 27 ▶sub debugfh {
Subroutine debugfh: called CC=3 SCAR=11.0
Pod documented
52 27 my $self = shift;
53  
54 27 ▶ return $self->_debugfh(@_) if @_;
Branch: 1 branch
BranchTrueFalseTotal
if @_ 8 19 27
55 19 ▶ $self->_debugfh || $self->_build_debugfh;
Branch: 1 branch
BranchTrueFalseTotal
$self->_debugfh or $self->_build_debugfh 16 3 19
56 }
57  
58 38 has _debugfh => (
59 is => 'rw',
60 lazy => 1,
61 trigger => qsub '$_[0]->_defaulted_to_stderr(undef)',
62 builder => '_build_debugfh',
63 );
64  
65 4 ▶sub _build_debugfh {
Subroutine _build_debugfh: called CC=6 SCAR=18.1
66 4 my $fh;
67  
68 4 ▶ my $debug_env = $ENV{DBIX_CLASS_STORAGE_DBI_DEBUG} || $ENV{DBIC_TRACE};
Condition66%2/3
$ENV{'DBIX_CLASS_STORAGE_DBI_DEBUG'} || $ENV{'DBIC_TRACE'}
l!l&&r!l&&!r
022
MC/DC50%1/2
$ENV{'DBIX_CLASS_STORAGE_DBI_DEBUG'} || $ENV{'DBIC_TRACE'}
$ENV{'DBIX_CLASS_STORAGE_DBI_DEBUG'} $ENV{'DBIC_TRACE'}
Truth table66%2/3
A || B
A= $ENV{'DBIX_CLASS_STORAGE_DBI_DEBUG'}B= $ENV{'DBIC_TRACE'}
ABresult
1X1
011
000
69  
70 4 ▶ if (defined($debug_env) and ($debug_env =~ /=(.+)$/)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $debug_env and $debug_env =~ /=(.+)$/) { } 2 2 4
Condition66%2/3
defined $debug_env and $debug_env =~ /=(.+)$/
!ll&&!rl&&r
202
MC/DC50%1/2
defined $debug_env and $debug_env =~ /=(.+)$/
defined $debug_env $debug_env =~ /=(.+)$/
Truth table66%2/3
A and B
A= defined $debug_envB= $debug_env =~ /=(.+)$/
ABresult
0X0
100
111
71 2 ▶ open ($fh, '>>', $1)
Branch: 1 branch
BranchTrueFalseTotal
open $fh, ">>", $1 or die "Cannot open trace file $1: $!\n" 2 0 2
72 or die("Cannot open trace file $1: $!\n");
73 }
74 else {
75 2 ▶ open ($fh, '>&STDERR')
Branch: 1 branch
BranchTrueFalseTotal
open $fh, ">&STDERR" or die "Duplication of STDERR for debug output failed (perhaps your STDERR is closed?): $!\n" 1 1 2
76 or die("Duplication of STDERR for debug output failed (perhaps your STDERR is closed?): $!\n");
77 1 $_[0]->_defaulted_to_stderr(1);
78 }
79  
80 3 $fh->autoflush(1);
81  
82 3 $fh;
83 }
84  
85 38 has [qw(_defaulted_to_stderr silence callback)] => (
86 is => 'rw',
87 );
88  
89 =head2 print
90  
91 Prints the specified string to our debugging filehandle. Provided to save our
92 methods the worry of how to display the message.
93  
94 =cut
95 16 ▶sub print {
Subroutine print: called CC=3 SCAR=11.0
Pod documented
96 16 my ($self, $msg) = @_;
97  
98 16 ▶ return if $self->silence;
Branch: 1 branch
BranchTrueFalseTotal
if $self->silence 0 16 16
99  
100 16 my $fh = $self->debugfh;
101  
102 # not using 'no warnings' here because all of this can change at runtime
103 15 ▶ local $SIG{__WARN__} = sigwarn_silencer(qr/^Wide character in print/)
Branch: 1 branch
BranchTrueFalseTotal
if $self->_defaulted_to_stderr 1 14 15
104 if $self->_defaulted_to_stderr;
105  
106 15 $fh->print($msg);
107 }
108  
109 =head2 silence
110  
111 Turn off all output if set to true.
112  
113 =head2 txn_begin
114  
115 Called when a transaction begins.
116  
117 =cut
118 6 ▶sub txn_begin {
Subroutine txn_begin: called CC=2 SCAR=6.9
Pod documented
119 6 my $self = shift;
120  
121 6 ▶ return if $self->callback;
Branch: 1 branch
BranchTrueFalseTotal
if $self->callback 5 1 6
122  
123 1 $self->print("BEGIN WORK\n");
124 }
125  
126 =head2 txn_rollback
127  
128 Called when a transaction is rolled back.
129  
130 =cut
131 1 ▶sub txn_rollback {
Subroutine txn_rollback: called CC=2 SCAR=8.1
Pod documented
132 1 my $self = shift;
133  
134 1 ▶ return if $self->callback;
Branch: 1 branch
BranchTrueFalseTotal
if $self->callback 1 0 1
135  
136 0 $self->print("ROLLBACK\n");
137 }
138  
139 =head2 txn_commit
140  
141 Called when a transaction is committed.
142  
143 =cut
144 5 ▶sub txn_commit {
Subroutine txn_commit: called CC=2 SCAR=6.9
Pod documented
145 5 my $self = shift;
146  
147 5 ▶ return if $self->callback;
Branch: 1 branch
BranchTrueFalseTotal
if $self->callback 4 1 5
148  
149 1 $self->print("COMMIT\n");
150 }
151  
152 =head2 svp_begin
153  
154 Called when a savepoint is created.
155  
156 =cut
157 0 ▶sub svp_begin {
Subroutine svp_begin: not called CC=2 SCAR=17.9
Pod documented
158 0 my ($self, $name) = @_;
159  
160 0 ▶ return if $self->callback;
Branch: 1 branch
BranchTrueFalseTotal
if $self->callback 0 0 0
161  
162 0 $self->print("SAVEPOINT $name\n");
163 }
164  
165 =head2 svp_release
166  
167 Called when a savepoint is released.
168  
169 =cut
170 0 ▶sub svp_release {
Subroutine svp_release: not called CC=2 SCAR=17.9
Pod documented
171 0 my ($self, $name) = @_;
172  
173 0 ▶ return if $self->callback;
Branch: 1 branch
BranchTrueFalseTotal
if $self->callback 0 0 0
174  
175 0 $self->print("RELEASE SAVEPOINT $name\n");
176 }
177  
178 =head2 svp_rollback
179  
180 Called when rolling back to a savepoint.
181  
182 =cut
183 0 ▶sub svp_rollback {
Subroutine svp_rollback: not called CC=2 SCAR=17.9
Pod documented
184 0 my ($self, $name) = @_;
185  
186 0 ▶ return if $self->callback;
Branch: 1 branch
BranchTrueFalseTotal
if $self->callback 0 0 0
187  
188 0 $self->print("ROLLBACK TO SAVEPOINT $name\n");
189 }
190  
191 =head2 query_start
192  
193 Called before a query is executed. The first argument is the SQL string being
194 executed and subsequent arguments are the parameters used for the query.
195  
196 =cut
197 37 ▶sub query_start {
Subroutine query_start: called CC=2 SCAR=6.9
Pod documented
198 37 my ($self, $string, @bind) = @_;
199  
200 37 my $message = "$string: ".join(', ', @bind)."\n";
201  
202 37 ▶ if(defined($self->callback)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $self->callback) 31 6 37
203 31 $string =~ m/^(\w+)/;
204 31 $self->callback->($1, $message);
205 31 return;
206 }
207  
208 6 $self->print($message);
209 }
210  
211 =head2 query_end
212  
213 Called when a query finishes executing. Has the same arguments as query_start.
214  
215 =cut
216  
217 141 ▶sub query_end {
Subroutine query_end: called CC=1 SCAR=0.0
Pod documented
218 141 my ($self, $string) = @_;
219 }
220  
221 =head1 FURTHER QUESTIONS?
222  
223 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
224  
225 =head1 COPYRIGHT AND LICENSE
226  
227 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
228 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
229 redistribute it and/or modify it under the same terms as the
230 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
231  
232 =cut
233  
234 38 1;
« DBIx/Class/CDBICompat/Pager.pm ↑ Summary DBIx/Class/Relationship/Accessor.pm »