File: compact_col_vals.pm

package info (click to toggle)
percona-toolkit 3.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 68,916 kB
  • sloc: perl: 241,287; sql: 22,868; sh: 19,746; javascript: 6,799; makefile: 353; awk: 38; python: 30; sed: 1
file content (175 lines) | stat: -rw-r--r-- 5,454 bytes parent folder | download | duplicates (2)
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
# This program is copyright 2010 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.

package compact_col_vals;

# This mk-archiver plugin demonstrates how to compact a column's values.
# If a column has values {1, 3, 4, 9, 10} it is compacted to {1, 2, 3, 4, 5}
# (if $step=1).  No other column values are changed.  Column values are
# only compacted "downwards".  So if $step=2, the value above are compacted
# to {1, 3, 4, 7, 9}.
#
# This modules does *not* allow any rows to be deleted.  is_archivable()
# returns false for every row.  Even if you specify --purge, the rows will
# not be purged.  UPDATEs are made while the table is being nibbled.
# Options --dest and --file are not tested.
#
# If the compact column is AUTO_INCREMENT, you need to specify
# --no-safe-auto-incrment else the last row (i.e. the one with the highest
# auto inc value) will not be compacted.
#
# See compact_col_vals.sql for a before and after example.

use strict;
use warnings FATAL => 'all';
use English qw(-no_match_vars);

use constant PTDEBUG  => $ENV{PTDEBUG} || 0;

use Data::Dumper;
$Data::Dumper::Indent    = 1;
$Data::Dumper::Sortkeys  = 1;
$Data::Dumper::Quotekeys = 0;

# ###########################################################################
# Customize these values for your tables.
# ###########################################################################
my $compact_column = 'id';  # column name to compact
my $step           = 1;     # amount by which column values should increase


# ###########################################################################
# Don't modify anything below here.
# ###########################################################################
sub new {
   my ( $class, %args ) = @_;
   my $o   = $args{OptionParser};
   my $q   = $args{Quoter};
   my $dbh = $args{dbh};

   my $sth;
   my $db_tbl = $q->quote($args{db}, $args{tbl});
   my $sql    = "UPDATE $db_tbl SET `$compact_column`=? "
              . "WHERE `$compact_column`=?";
   PTDEBUG && _d('sth:', $sql);
   if ( !$o->get('dry-run') ) {
      $sth = $dbh->prepare($sql);
   }
   else {
      print "# compact_col_vals plugin\n$sql\n";
   }

   my $self = {
      %args,
      db_tbl   => $db_tbl,
      sth      => $sth,
      col_pos  => undef,
      next_val => 0,
   };

   return bless $self, $class;
}

sub before_begin {
   my ( $self, %args ) = @_;
   my $allcols = $args{allcols};
   PTDEBUG && _d('allcols:', Dumper($allcols));
   my $colpos = -1;
   foreach my $col ( @$allcols ) {
      $colpos++;
      last if $col eq $compact_column;
   }
   if ( $colpos < 0 ) {
      die "Column $compact_column not selected by mk-archiver: "
         . join(', ', @$allcols);
   }
   PTDEBUG && _d('col pos:', $colpos);
   $self->{col_pos} = $colpos;
   return;
}

sub is_archivable {
   my ( $self, %args ) = @_;
   my $next_val = $self->{next_val};
   my $row      = $args{row};
   my $val      = $row->[$self->{col_pos}];
   my $sth      = $self->{sth};
   PTDEBUG && _d('val:', $val);

   if ( $next_val ){
      if ( $val > $next_val ) {
         PTDEBUG && _d('Updating', $val, 'to', $next_val);
         $sth->execute($next_val, $val); 
      }
      else {
         PTDEBUG && _d('Val is OK');
      }
   }
   else {
      # This should happen once.
      PTDEBUG && _d('First val:', $val);
      $self->{next_val} = $val;
   }

   $self->{next_val}++;
   PTDEBUG && _d('Next val should be', $self->{next_val});

   # No rows are archivable because we're exploiting mk-archiver
   # just for its ability to nibble the table.  To be safe, return 0
   # for every row so that any potential delete/purge operations
   # will not happen.
   return 0;
}

sub before_delete {
   my ( $self, %args ) = @_;
   # Because is_archivable() always returns 0, this sub should
   # not be called by mk-archiver.
   die "before_delete() was called but should not have been called!";
}

sub before_bulk_delete {
   my ( $self, %args ) = @_;
   # Because is_archivable() always returns 0, this sub should
   # not be called by mk-archiver.
   die "before_bulk_delete() was called but should not have been called!";
}

# Reset AUTO_INCREMENT to next, lowest value.
sub after_finish {
   my ( $self ) = @_;
   my $o   = $self->{OptionParser};
   my $sql = "ALTER TABLE $self->{db_tbl} AUTO_INCREMENT=$self->{next_val}";
   if ( !$o->get('dry-run') ) {
      PTDEBUG && _d($sql);
      $self->{dbh}->do($sql);
   }
   else {
      print "# compact_col_vals plugin\n$sql\n";
   }
   return;
}

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;