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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
# This program is copyright 2008-2011 Percona Inc.
# Feedback and improvements are welcome.
#
# THIS PROGRAM IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
# WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
# MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
#
# This program 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, version 2; OR the Perl Artistic License. On UNIX and similar
# systems, you can issue `man perlgpl' or `man perlartistic' to read these
# licenses.
#
# 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., 59 Temple
# Place, Suite 330, Boston, MA 02111-1307 USA.
# ###########################################################################
# KeySize package
# ###########################################################################
{
# Package: KeySize
# KeySize calculates the size of MySQL indexes (keys).
package KeySize;
use strict;
use warnings FATAL => 'all';
use English qw(-no_match_vars);
use constant PTDEBUG => $ENV{PTDEBUG} || 0;
sub new {
my ( $class, %args ) = @_;
my $self = { %args };
return bless $self, $class;
}
# Returns the key's size and the key that MySQL actually chose.
# Required args:
# name => name of key
# cols => arrayref of key's cols
# tbl_name => quoted, db-qualified table name like `db`.`tbl`
# tbl_struct => hashref returned by TableParser::parse for tbl
# dbh => dbh
# If the key exists in the tbl (it should), then we can FORCE INDEX.
# This is what we want to do because it's more reliable. But, if the
# key does not exist in the tbl (which happens with foreign keys),
# then we let MySQL choose the index. If there's an error, nothing
# is returned and you can get the last error, query and EXPLAIN with
# error(), query() and explain().
sub get_key_size {
my ( $self, %args ) = @_;
foreach my $arg ( qw(name cols tbl_name tbl_struct dbh) ) {
die "I need a $arg argument" unless $args{$arg};
}
my $name = $args{name};
my @cols = @{$args{cols}};
my $dbh = $args{dbh};
$self->{explain} = '';
$self->{query} = '';
$self->{error} = '';
if ( @cols == 0 ) {
$self->{error} = "No columns for key $name";
return;
}
my $key_exists = $self->_key_exists(%args);
PTDEBUG && _d('Key', $name, 'exists in', $args{tbl_name}, ':',
$key_exists ? 'yes': 'no');
# Construct a SQL statement with WHERE conditions on all key
# cols that will get EXPLAIN to tell us 1) the full length of
# the key and 2) the total number of rows in the table.
# For 1), all key cols must be used because key_len in EXPLAIN only
# only covers the portion of the key needed to satisfy the query.
# For 2), we have to break normal index usage which normally
# allows MySQL to access only the limited number of rows needed
# to satisify the query because we want to know total table rows.
my $sql = 'EXPLAIN SELECT ' . join(', ', @cols)
. ' FROM ' . $args{tbl_name}
. ($key_exists ? " FORCE INDEX (`$name`)" : '')
. ' WHERE ';
my @where_cols;
foreach my $col ( @cols ) {
push @where_cols, "$col=1";
}
# For single column indexes we have to trick MySQL into scanning
# the whole index by giving it two irreducible condtions. Otherwise,
# EXPLAIN rows will report only the rows that satisfy the query
# using the key, but this is not what we want. We want total table rows.
# In other words, we need an EXPLAIN type index, not ref or range.
if ( scalar @cols == 1 ) {
push @where_cols, "$cols[0]<>1";
}
$sql .= join(' OR ', @where_cols);
$self->{query} = $sql;
PTDEBUG && _d('sql:', $sql);
my $explain;
my $sth = $dbh->prepare($sql);
eval { $sth->execute(); };
if ( $EVAL_ERROR ) {
chomp $EVAL_ERROR;
$self->{error} = "Cannot get size of $name key: $EVAL_ERROR";
return;
}
$explain = $sth->fetchrow_hashref();
$self->{explain} = $explain;
my $key_len = $explain->{key_len};
my $rows = $explain->{rows};
my $chosen_key = $explain->{key}; # May differ from $name
PTDEBUG && _d('MySQL chose key:', $chosen_key, 'len:', $key_len,
'rows:', $rows);
my $key_size = 0;
if ( $key_len && $rows ) {
if ( $chosen_key =~ m/,/ && $key_len =~ m/,/ ) {
$self->{error} = "MySQL chose multiple keys: $chosen_key";
return;
}
$key_size = $key_len * $rows;
}
else {
$self->{error} = "key_len or rows NULL in EXPLAIN:\n"
. _explain_to_text($explain);
return;
}
return $key_size, $chosen_key;
}
# Returns the last explained query.
sub query {
my ( $self ) = @_;
return $self->{query};
}
# Returns the last explain plan.
sub explain {
my ( $self ) = @_;
return _explain_to_text($self->{explain});
}
# Returns the last error.
sub error {
my ( $self ) = @_;
return $self->{error};
}
sub _key_exists {
my ( $self, %args ) = @_;
return exists $args{tbl_struct}->{keys}->{ lc $args{name} } ? 1 : 0;
}
sub _explain_to_text {
my ( $explain ) = @_;
return join("\n",
map { "$_: ".($explain->{$_} ? $explain->{$_} : 'NULL') }
sort keys %$explain
);
}
sub _d {
my ($package, undef, $line) = caller 0;
@_ = map { (my $temp = $_) =~ s/\n/\n# /g; $temp; }
map { defined $_ ? $_ : 'undef' }
@_;
print STDERR "# $package:$line $PID ", join(' ', @_), "\n";
}
1;
}
# ###########################################################################
# End KeySize package
# ###########################################################################
|