Move module docu to work for NaturalDocs.

This commit is contained in:
Daniel Nichter
2011-07-02 12:29:08 -06:00
parent a9e002cc5a
commit 55c69ffbc1
81 changed files with 83 additions and 162 deletions

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Advisor package $Revision: 6830 $ # Advisor package $Revision: 6830 $
# ########################################################################### # ###########################################################################
{
# Package: Advisor # Package: Advisor
# Advisor loads, checks, and runs rules for the various mk-*-advisor tools. # Advisor loads, checks, and runs rules for the various mk-*-advisor tools.
{
package Advisor; package Advisor;
use strict; use strict;

View File

@@ -17,11 +17,10 @@
# ########################################################################### # ###########################################################################
# AdvisorRules package $Revision: 6813 $ # AdvisorRules package $Revision: 6813 $
# ########################################################################### # ###########################################################################
{
# Package: AdvisorRules # Package: AdvisorRules
# AdvisorRules is a parent class for advisor rule modules like # AdvisorRules is a parent class for advisor rule modules like
# <QueryAdivsorRules>. # <QueryAdivsorRules>.
{
package AdvisorRules; package AdvisorRules;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# BinaryLogParser package $Revision: 7522 $ # BinaryLogParser package $Revision: 7522 $
# ########################################################################### # ###########################################################################
{
# Package: BinaryLogParser # Package: BinaryLogParser
# BinaryLogParser parses binary log files converted to text by mysqlbinlog. # BinaryLogParser parses binary log files converted to text by mysqlbinlog.
{
package BinaryLogParser; package BinaryLogParser;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# ChangeHandler package $Revision: 6785 $ # ChangeHandler package $Revision: 6785 $
# ########################################################################### # ###########################################################################
{
# Package: ChangeHandler # Package: ChangeHandler
# ChangeHandler creates SQL statements for changing rows in a table. # ChangeHandler creates SQL statements for changing rows in a table.
{
package ChangeHandler; package ChangeHandler;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# CompareQueryTimes package $Revision: 6785 $ # CompareQueryTimes package $Revision: 6785 $
# ########################################################################### # ###########################################################################
{
# Package: CompareQueryTimes # Package: CompareQueryTimes
# CompareQueryTimes compares query execution times. # CompareQueryTimes compares query execution times.
{
package CompareQueryTimes; package CompareQueryTimes;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# CompareResults package $Revision: 7096 $ # CompareResults package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: CompareResults # Package: CompareResults
# CompareResults compares the query result sets. # CompareResults compares the query result sets.
{
package CompareResults; package CompareResults;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# CompareTableStructs package $Revision: 6785 $ # CompareTableStructs package $Revision: 6785 $
# ########################################################################### # ###########################################################################
{
# Package: CompareTableStructs # Package: CompareTableStructs
# CompareTableStructs compares CREATE TABLE defs. # CompareTableStructs compares CREATE TABLE defs.
{
package CompareTableStructs; package CompareTableStructs;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# CompareWarnings package $Revision: 7096 $ # CompareWarnings package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: CompareWarnings # Package: CompareWarnings
# CompareWarnings compares query warnings. # CompareWarnings compares query warnings.
{
package CompareWarnings; package CompareWarnings;
use strict; use strict;

View File

@@ -17,11 +17,10 @@
# ########################################################################### # ###########################################################################
# CopyRowsInsertSelect package $Revision: 7464 $ # CopyRowsInsertSelect package $Revision: 7464 $
# ########################################################################### # ###########################################################################
{
# Package: CopyRowsInsertSelect # Package: CopyRowsInsertSelect
# CopyRowsInsertSelect implements the copy rows phase of an online schema # CopyRowsInsertSelect implements the copy rows phase of an online schema
# change. # change.
{
package CopyRowsInsertSelect; package CopyRowsInsertSelect;
use strict; use strict;

View File

@@ -18,11 +18,10 @@
# ########################################################################### # ###########################################################################
# DSNParser package $Revision: 7388 $ # DSNParser package $Revision: 7388 $
# ########################################################################### # ###########################################################################
{
# Package: DSNParser # Package: DSNParser
# DSNParser parses DSNs and creates connections to MySQL using DBI and # DSNParser parses DSNs and creates connections to MySQL using DBI and
# DBD::mysql. # DBD::mysql.
{
package DSNParser; package DSNParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Daemon package $Revision: 6255 $ # Daemon package $Revision: 6255 $
# ########################################################################### # ###########################################################################
{
# Package: Daemon # Package: Daemon
# Daemon daemonizes the caller and handles daemon-related tasks like PID files. # Daemon daemonizes the caller and handles daemon-related tasks like PID files.
{
package Daemon; package Daemon;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# DuplicateKeyFinder package $Revision: 7565 $ # DuplicateKeyFinder package $Revision: 7565 $
# ########################################################################### # ###########################################################################
{
# Package: DuplicateKeyFinder # Package: DuplicateKeyFinder
# DuplicateKeyFinder finds duplicate indexes (keys). # DuplicateKeyFinder finds duplicate indexes (keys).
{
package DuplicateKeyFinder; package DuplicateKeyFinder;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# EventAggregator package $Revision: 7272 $ # EventAggregator package $Revision: 7272 $
# ########################################################################### # ###########################################################################
{
# Package: EventAggregator # Package: EventAggregator
# EventAggregator aggregates event values and calculates basic statistics. # EventAggregator aggregates event values and calculates basic statistics.
{
package EventAggregator; package EventAggregator;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# EventTimeline package $Revision: 6590 $ # EventTimeline package $Revision: 6590 $
# ########################################################################### # ###########################################################################
# Package: EventTimeLine
# EventTimeLine aggregates events that are adjacent to each other.
{ {
# Package: EventTimeline
# EventTimeline aggregates events that are adjacent to each other.
package EventTimeline; package EventTimeline;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# ExecutionThrottler package $Revision: 5266 $ # ExecutionThrottler package $Revision: 5266 $
# ########################################################################### # ###########################################################################
{
# Package: ExecutionThrottler # Package: ExecutionThrottler
# ExecutionThrottle slows program execution if a threshold is exceeded. # ExecutionThrottle slows program execution if a threshold is exceeded.
{
package ExecutionThrottler; package ExecutionThrottler;
use strict; use strict;

View File

@@ -17,13 +17,12 @@
# ########################################################################### # ###########################################################################
# ExplainAnalyzer package $Revision: 7096 $ # ExplainAnalyzer package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: ExplainAnalyzer # Package: ExplainAnalyzer
# ExplainAnalyzer contains utility methods for getting and manipulating # ExplainAnalyzer contains utility methods for getting and manipulating
# EXPLAIN data. It also has methods to save and retrieve information, # EXPLAIN data. It also has methods to save and retrieve information,
# so it actually has state itself if used in this way -- it is not a data-less # so it actually has state itself if used in this way -- it is not a data-less
# collection of methods. # collection of methods.
{
package ExplainAnalyzer; package ExplainAnalyzer;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# FileIterator package $Revision: 7096 $ # FileIterator package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: FileIterator # Package: FileIterator
# FileIterator make iterators that return filenames. # FileIterator make iterators that return filenames.
{
package FileIterator; package FileIterator;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# ForeignKeyIterator package $Revision: 7552 $ # ForeignKeyIterator package $Revision: 7552 $
# ########################################################################### # ###########################################################################
{
# Package: ForeignKeyIterator # Package: ForeignKeyIterator
# ForeignKeyIterator iterates from or to a table by its foreign key constraints. # ForeignKeyIterator iterates from or to a table by its foreign key constraints.
# This is a special type of <SchemaIterator> with the same interface, so it # This is a special type of <SchemaIterator> with the same interface, so it
@@ -25,7 +25,6 @@
# very differently. Whereas a <SchemaIterator> is a real iterator that only # very differently. Whereas a <SchemaIterator> is a real iterator that only
# gets the next schema object when called, a ForeignKeyIterator slurps the # gets the next schema object when called, a ForeignKeyIterator slurps the
# given <SchemaIterator> so it can discover foreign key constraints. # given <SchemaIterator> so it can discover foreign key constraints.
{
package ForeignKeyIterator; package ForeignKeyIterator;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# GeneralLogParser package $Revision: 7522 $ # GeneralLogParser package $Revision: 7522 $
# ########################################################################### # ###########################################################################
{
# Package: GeneralLogParser # Package: GeneralLogParser
# GeneralLogParser parses MySQL general logs. # GeneralLogParser parses MySQL general logs.
{
package GeneralLogParser; package GeneralLogParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# HTTPProtocolParser package $Revision: 5811 $ # HTTPProtocolParser package $Revision: 5811 $
# ########################################################################### # ###########################################################################
{
# Package: HTTPProtocolParser # Package: HTTPProtocolParser
# HTTPProtocolParser parses HTTP traffic from tcpdump files. # HTTPProtocolParser parses HTTP traffic from tcpdump files.
{
package HTTPProtocolParser; package HTTPProtocolParser;
use base 'ProtocolParser'; use base 'ProtocolParser';

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# IndexUsage package $Revision: 7096 $ # IndexUsage package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: IndexUsage # Package: IndexUsage
# IndexUsage tracks index and tables usage of queries. It can then show which # IndexUsage tracks index and tables usage of queries. It can then show which
# indexes are not used. You use it by telling it about all the tables and # indexes are not used. You use it by telling it about all the tables and
@@ -26,7 +26,6 @@
# #
# If the object is created with a dbh and db, then results (the indexes, # If the object is created with a dbh and db, then results (the indexes,
# tables, queries and index usages) are saved in tables. # tables, queries and index usages) are saved in tables.
{
package IndexUsage; package IndexUsage;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# InnoDBStatusParser package $Revision: 7096 $ # InnoDBStatusParser package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: InnoDBStatusParser # Package: InnoDBStatusParser
# InnoDBStatusParser parses SHOW INNODB STATUS. # InnoDBStatusParser parses SHOW INNODB STATUS.
{
package InnoDBStatusParser; package InnoDBStatusParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# KeySize package $Revision: 7096 $ # KeySize package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: KeySize # Package: KeySize
# KeySize calculates the size of MySQL indexes (keys). # KeySize calculates the size of MySQL indexes (keys).
{
package KeySize; package KeySize;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# LogSplitter package $Revision: 7177 $ # LogSplitter package $Revision: 7177 $
# ########################################################################### # ###########################################################################
{
# Package: LogSplitter # Package: LogSplitter
# LogSplitter splits MySQL query logs by sessions. # LogSplitter splits MySQL query logs by sessions.
{
package LogSplitter; package LogSplitter;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# MaatkitTest package $Revision: 7096 $ # MaatkitTest package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: MaatkitTest # Package: MaatkitTest
# MaatkitTest is a collection of helper-subs for the Maatkit tests. # MaatkitTest is a collection of helper-subs for the Maatkit tests.
# Any file arguments (like no_diff() $expected_output) are relative to # Any file arguments (like no_diff() $expected_output) are relative to
@@ -26,7 +26,6 @@
# this terminates the *entire* test process; die instead. All # this terminates the *entire* test process; die instead. All
# subs are exported by default, so is the variable $trunk, so there's # subs are exported by default, so is the variable $trunk, so there's
# no need to import() in the test scripts. # no need to import() in the test scripts.
{
package MaatkitTest; package MaatkitTest;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# MasterSlave package $Revision: 7525 $ # MasterSlave package $Revision: 7525 $
# ########################################################################### # ###########################################################################
{
# Package: MasterSlave # Package: MasterSlave
# MasterSlave handles common tasks related to master-slave setups. # MasterSlave handles common tasks related to master-slave setups.
{
package MasterSlave; package MasterSlave;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# MemcachedEvent package $Revision: 7096 $ # MemcachedEvent package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: MemcachedEvent # Package: MemcachedEvent
# MemcachedEvent creates events from <MemcachedProtocolParser> data. # MemcachedEvent creates events from <MemcachedProtocolParser> data.
# Since memcached is not strictly MySQL stuff, we have to # Since memcached is not strictly MySQL stuff, we have to
@@ -25,7 +25,6 @@
# #
# See http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt # See http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt
# for information about the memcached protocol. # for information about the memcached protocol.
{
package MemcachedEvent; package MemcachedEvent;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# MemcachedProtocolParser package $Revision: 7521 $ # MemcachedProtocolParser package $Revision: 7521 $
# ########################################################################### # ###########################################################################
{
# Package: MemcachedProtocolParser # Package: MemcachedProtocolParser
# MemcachedProtocolParser parses memcached events from tcpdump files. # MemcachedProtocolParser parses memcached events from tcpdump files.
{
package MemcachedProtocolParser; package MemcachedProtocolParser;
use strict; use strict;

View File

@@ -16,9 +16,9 @@
# this program; if not, write to the Free Software Foundation, Inc., 59 Temple # this program; if not, write to the Free Software Foundation, Inc., 59 Temple
# Place, Suite 330, Boston, MA 02111-1307 USA. # Place, Suite 330, Boston, MA 02111-1307 USA.
{
# Package: MockSth # Package: MockSth
# MockSth simulates a DBI statement handle without a database connection. # MockSth simulates a DBI statement handle without a database connection.
{
package MockSth; package MockSth;
use strict; use strict;

View File

@@ -1,4 +1,3 @@
# This program is copyright 2011 Percona Inc.
# This program is copyright 2007-2010 Baron Schwartz. # This program is copyright 2007-2010 Baron Schwartz.
# Feedback and improvements are welcome. # Feedback and improvements are welcome.
# #
@@ -16,9 +15,9 @@
# this program; if not, write to the Free Software Foundation, Inc., 59 Temple # this program; if not, write to the Free Software Foundation, Inc., 59 Temple
# Place, Suite 330, Boston, MA 02111-1307 USA. # Place, Suite 330, Boston, MA 02111-1307 USA.
{
# Package: MockSync # Package: MockSync
# MockSync simulates a table syncer module. It's used by RowDiff.t. # MockSync simulates a table syncer module. It's used by RowDiff.t.
{
package MockSync; package MockSync;
use strict; use strict;

View File

@@ -15,6 +15,7 @@
# this program; if not, write to the Free Software Foundation, Inc., 59 Temple # this program; if not, write to the Free Software Foundation, Inc., 59 Temple
# Place, Suite 330, Boston, MA 02111-1307 USA. # Place, Suite 330, Boston, MA 02111-1307 USA.
{
# Package: MockSyncStream # Package: MockSyncStream
# MockSyncStream simulates a <TableSyncStream> module. # MockSyncStream simulates a <TableSyncStream> module.
# It's used by mk-upgrade to quickly compare result sets for any differences. # It's used by mk-upgrade to quickly compare result sets for any differences.
@@ -22,7 +23,6 @@
# This causes RowDiff::compare_sets() to terminate early. So we don't actually # This causes RowDiff::compare_sets() to terminate early. So we don't actually
# sync anything. Unlike TableSyncStream, we're not working with a table but an # sync anything. Unlike TableSyncStream, we're not working with a table but an
# arbitrary query executed on two servers. # arbitrary query executed on two servers.
{
package MockSyncStream; package MockSyncStream;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# MySQLConfig package $Revision: 7403 $ # MySQLConfig package $Revision: 7403 $
# ########################################################################### # ###########################################################################
{
# Package: MySQLConfig # Package: MySQLConfig
# MySQLConfig parses and encapsulates system variables and values from # MySQLConfig parses and encapsulates system variables and values from
# SHOW VARIABLES, option files, mysqld --help --verbose or my_print_defaults. # SHOW VARIABLES, option files, mysqld --help --verbose or my_print_defaults.
@@ -33,7 +33,6 @@
# #
# Only variables present in the input are saved in the MySQLConfig object. # Only variables present in the input are saved in the MySQLConfig object.
# So if <has()> returns false, then the variable did not appear in the input. # So if <has()> returns false, then the variable did not appear in the input.
{
package MySQLConfig; package MySQLConfig;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# MySQLConfigComparer package $Revision: 7403 $ # MySQLConfigComparer package $Revision: 7403 $
# ########################################################################### # ###########################################################################
{
# Package: MySQLConfigComparer # Package: MySQLConfigComparer
# MySQLConfigComparer compares and diffs C<MySQLConfig> objects. # MySQLConfigComparer compares and diffs C<MySQLConfig> objects.
{
package MySQLConfigComparer; package MySQLConfigComparer;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# MySQLDump package $Revision: 6345 $ # MySQLDump package $Revision: 6345 $
# ########################################################################### # ###########################################################################
{
# Package: MySQLDump # Package: MySQLDump
# MySQLDump gets CREATE TABLE defs from MySQL. # MySQLDump gets CREATE TABLE defs from MySQL.
{
package MySQLDump; package MySQLDump;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# MySQLProtocolParser package $Revision: 7522 $ # MySQLProtocolParser package $Revision: 7522 $
# ########################################################################### # ###########################################################################
{
# Package: MySQLProtocolParser # Package: MySQLProtocolParser
# MySQLProtocolParser parses MySQL events from tcpdump files. # MySQLProtocolParser parses MySQL events from tcpdump files.
# The packets come from TcpdumpParser. MySQLProtocolParse::parse_packet() # The packets come from TcpdumpParser. MySQLProtocolParse::parse_packet()
@@ -34,7 +34,6 @@
# At times MySQLProtocolParser::parse_packet() will not return an event # At times MySQLProtocolParser::parse_packet() will not return an event
# because it usually takes a few packets to create one event. In such # because it usually takes a few packets to create one event. In such
# cases, TcpdumpParser::parse_event() will not call the other callbacks. # cases, TcpdumpParser::parse_event() will not call the other callbacks.
{
package MySQLProtocolParser; package MySQLProtocolParser;
use strict; use strict;

View File

@@ -17,11 +17,10 @@
# ########################################################################### # ###########################################################################
# OSCCaptureSync package $Revision: 7463 $ # OSCCaptureSync package $Revision: 7463 $
# ########################################################################### # ###########################################################################
{
# Package: OSCCaptureSync # Package: OSCCaptureSync
# OSCCaptureSync implements the capture and sync phases of an online schema # OSCCaptureSync implements the capture and sync phases of an online schema
# change. # change.
{
package OSCCaptureSync; package OSCCaptureSync;
use strict; use strict;

View File

@@ -18,7 +18,7 @@
# ########################################################################### # ###########################################################################
# OptionParser package $Revision: 7102 $ # OptionParser package $Revision: 7102 $
# ########################################################################### # ###########################################################################
{
# Package: OptionParser # Package: OptionParser
# OptionParser parses command line options from a tool's POD. By default # OptionParser parses command line options from a tool's POD. By default
# it parses a description and usage from the POD's SYNOPSIS section and # it parses a description and usage from the POD's SYNOPSIS section and
@@ -58,7 +58,6 @@
# The option's full name is given as the "=item". The next, optional para # The option's full name is given as the "=item". The next, optional para
# is the option's attributes. And the next, required para is the option's # is the option's attributes. And the next, required para is the option's
# description (the first period-terminated sentence). # description (the first period-terminated sentence).
{
package OptionParser; package OptionParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Outfile package $Revision: 5266 $ # Outfile package $Revision: 5266 $
# ########################################################################### # ###########################################################################
{
# Package: Outfile # Package: Outfile
# Outfile writes rows to a file in SELECT INTO OUTFILE format. # Outfile writes rows to a file in SELECT INTO OUTFILE format.
{
package Outfile; package Outfile;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# PgLogParser package $Revision: 5835 $ # PgLogParser package $Revision: 5835 $
# ########################################################################### # ###########################################################################
{
# Package: PgLogParser # Package: PgLogParser
# PgLogParser parses Postgres logs. # PgLogParser parses Postgres logs.
{
package PgLogParser; package PgLogParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Pipeline package $Revision: 7509 $ # Pipeline package $Revision: 7509 $
# ########################################################################### # ###########################################################################
{
# Package: Pipeline # Package: Pipeline
# Pipeline executes and controls a list of pipeline processes. # Pipeline executes and controls a list of pipeline processes.
{
package Pipeline; package Pipeline;
use strict; use strict;

View File

@@ -17,13 +17,12 @@
# ########################################################################### # ###########################################################################
# PodParser package $Revision: 7053 $ # PodParser package $Revision: 7053 $
# ########################################################################### # ###########################################################################
{
# Package: PodParser # Package: PodParser
# PodParser parses sections of a POD. # PodParser parses sections of a POD.
# This package wants to subclasses Pod::Parser but because some people # This package wants to subclasses Pod::Parser but because some people
# still run ancient systems on which even "core" modules are missing, # still run ancient systems on which even "core" modules are missing,
# we have to roll our own pod parser. # we have to roll our own pod parser.
{
package PodParser; package PodParser;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# Processlist package $Revision: 7289 $ # Processlist package $Revision: 7289 $
# ########################################################################### # ###########################################################################
{
# Package: Processlist # Package: Processlist
# Processlist makes events when used to poll SHOW FULL PROCESSLIST. # Processlist makes events when used to poll SHOW FULL PROCESSLIST.
{
package Processlist; package Processlist;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# ProcesslistAggregator package $Revision: 6590 $ # ProcesslistAggregator package $Revision: 6590 $
# ########################################################################### # ###########################################################################
{
# Package: ProcesslistAggregator # Package: ProcesslistAggregator
# ProcesslistAggregator aggregates PROCESSLIST entires. # ProcesslistAggregator aggregates PROCESSLIST entires.
{
package ProcesslistAggregator; package ProcesslistAggregator;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Progress package $Revision: 7096 $ # Progress package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: Progress # Package: Progress
# Progress encapsulates a progress report. # Progress encapsulates a progress report.
{
package Progress; package Progress;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# ProtocolParser package $Revision: 7522 $ # ProtocolParser package $Revision: 7522 $
# ########################################################################### # ###########################################################################
{
# Package: ProtocolParser # Package: ProtocolParser
# ProtocolParser is a parent class for protocol-specific parsers. # ProtocolParser is a parent class for protocol-specific parsers.
{
package ProtocolParser; package ProtocolParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# QueryAdvisorRules package $Revision: 7473 $ # QueryAdvisorRules package $Revision: 7473 $
# ########################################################################### # ###########################################################################
{
# Package: QueryAdvisorRules # Package: QueryAdvisorRules
# QueryAdvisorRules encapsulates rules for checking queries. # QueryAdvisorRules encapsulates rules for checking queries.
{
package QueryAdvisorRules; package QueryAdvisorRules;
use base 'AdvisorRules'; use base 'AdvisorRules';

View File

@@ -17,13 +17,12 @@
# ########################################################################### # ###########################################################################
# QueryParser package $Revision: 7452 $ # QueryParser package $Revision: 7452 $
# ########################################################################### # ###########################################################################
{
# Package: QueryParser # Package: QueryParser
# QueryParser extracts parts of SQL statements, like table lists and subqueries. # QueryParser extracts parts of SQL statements, like table lists and subqueries.
# This package differs from SQLParser because it only extracts from a query # This package differs from SQLParser because it only extracts from a query
# what is needed and only when that can be accomplished rather simply. By # what is needed and only when that can be accomplished rather simply. By
# contrast, SQLParser parses the entire SQL statement no matter the complexity. # contrast, SQLParser parses the entire SQL statement no matter the complexity.
{
package QueryParser; package QueryParser;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# QueryReportFormatter package $Revision: 7274 $ # QueryReportFormatter package $Revision: 7274 $
# ########################################################################### # ###########################################################################
{
# Package: QueryReportFormatter # Package: QueryReportFormatter
# QueryReportFormatter is used primarily by mk-query-digest to print reports. # QueryReportFormatter is used primarily by mk-query-digest to print reports.
# The main sub is print_reports() which prints the various reports for # The main sub is print_reports() which prints the various reports for
@@ -27,7 +27,6 @@
# fully aggregated and $ea->calculate_statistical_metrics() already called. # fully aggregated and $ea->calculate_statistical_metrics() already called.
# Subreports "profile" and "prepared" require the ReportFormatter module, # Subreports "profile" and "prepared" require the ReportFormatter module,
# which is also in mk-query-digest. # which is also in mk-query-digest.
{
package QueryReportFormatter; package QueryReportFormatter;
use strict; use strict;

View File

@@ -17,13 +17,12 @@
# ########################################################################### # ###########################################################################
# QueryReview package $Revision: 7342 $ # QueryReview package $Revision: 7342 $
# ########################################################################### # ###########################################################################
{
# Package: QueryReview # Package: QueryReview
# QueryReview is an API to a query review table. # QueryReview is an API to a query review table.
# This module is an interface to a "query review table" in which certain # This module is an interface to a "query review table" in which certain
# historical information about classes of queries is stored. See the docs on # historical information about classes of queries is stored. See the docs on
# mk-query-digest for context. # mk-query-digest for context.
{
package QueryReview; package QueryReview;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# QueryRewriter package $Revision: 7473 $ # QueryRewriter package $Revision: 7473 $
# ########################################################################### # ###########################################################################
{
# Package: QueryRewriter # Package: QueryRewriter
# QueryRewriter rewrites and transforms queries. # QueryRewriter rewrites and transforms queries.
{
package QueryRewriter; package QueryRewriter;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# Quoter package $Revision: 6850 $ # Quoter package $Revision: 6850 $
# ########################################################################### # ###########################################################################
{
# Package: Quoter # Package: Quoter
# Quoter handles value quoting, unquoting, escaping, etc. # Quoter handles value quoting, unquoting, escaping, etc.
{
package Quoter; package Quoter;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# ReportFormatter package $Revision: 7473 $ # ReportFormatter package $Revision: 7473 $
# ########################################################################### # ###########################################################################
{
# Package: ReportFormatter # Package: ReportFormatter
# ReportFormatter makes columnized reports given variable-width data lines. # ReportFormatter makes columnized reports given variable-width data lines.
# It does the hard work of automatically sizing columns and truncating data # It does the hard work of automatically sizing columns and truncating data
@@ -54,7 +54,6 @@
# After these adjustments, get_report() calls _truncate_headers() and # After these adjustments, get_report() calls _truncate_headers() and
# _truncate_line_values(). These truncate output to the columns' final, # _truncate_line_values(). These truncate output to the columns' final,
# calculated widths. # calculated widths.
{
package ReportFormatter; package ReportFormatter;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Retry package $Revision: 7473 $ # Retry package $Revision: 7473 $
# ########################################################################### # ###########################################################################
{
# Package: Retry # Package: Retry
# Retry retries code until a condition succeeds. # Retry retries code until a condition succeeds.
{
package Retry; package Retry;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# RowDiff package $Revision: 5697 $ # RowDiff package $Revision: 5697 $
# ########################################################################### # ###########################################################################
{
# Package: RowDiff # Package: RowDiff
# RowDiff compares two sets of rows to find ones that are different. # RowDiff compares two sets of rows to find ones that are different.
{
package RowDiff; package RowDiff;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# Runtime package $Revision: 7221 $ # Runtime package $Revision: 7221 $
# ########################################################################### # ###########################################################################
{
# Package: Runtime # Package: Runtime
# Runtime keeps track of time to control how long a tool's main loop runs. # Runtime keeps track of time to control how long a tool's main loop runs.
# This package was created to handle mk-query-digest --run-time-mode event. # This package was created to handle mk-query-digest --run-time-mode event.
@@ -25,7 +25,6 @@
# now() comes from a clock, a log timestamp, or wherever. The creator of # now() comes from a clock, a log timestamp, or wherever. The creator of
# Runtime object determines how, or from where, time is gotten so that the # Runtime object determines how, or from where, time is gotten so that the
# caller of the object can simply ask, "What time is it?". # caller of the object can simply ask, "What time is it?".
{
package Runtime; package Runtime;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# SQLParser package $Revision: 7565 $ # SQLParser package $Revision: 7565 $
# ########################################################################### # ###########################################################################
{
# Package: SQLParser # Package: SQLParser
# SQLParser parses common MySQL SQL statements into data structures. # SQLParser parses common MySQL SQL statements into data structures.
# This parser is MySQL-specific and intentionally meant to handle only # This parser is MySQL-specific and intentionally meant to handle only
@@ -36,7 +36,6 @@
# This package differs from QueryParser because here we parse the entire SQL # This package differs from QueryParser because here we parse the entire SQL
# statement (thus giving access to all its parts), whereas QueryParser extracts # statement (thus giving access to all its parts), whereas QueryParser extracts
# just needed parts (and ignores all the rest). # just needed parts (and ignores all the rest).
{
package SQLParser; package SQLParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Sandbox package $Revision: 7140 $ # Sandbox package $Revision: 7140 $
# ########################################################################### # ###########################################################################
{
# Package: Sandbox # Package: Sandbox
# Sandbox is an API for the test suite to access and control sandbox servers. # Sandbox is an API for the test suite to access and control sandbox servers.
{
package Sandbox; package Sandbox;
BEGIN { BEGIN {

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# Schema package $Revision: 7565 $ # Schema package $Revision: 7565 $
# ########################################################################### # ###########################################################################
{
# Package: Schema # Package: Schema
# Schema encapsulates a data structure representing databases and tables. # Schema encapsulates a data structure representing databases and tables.
# Although in MySQL "schema" is technically equivalent to "databae", we # Although in MySQL "schema" is technically equivalent to "databae", we
@@ -49,7 +49,6 @@
# #
# Schema objects are usually added by a <SchemaIterator>, but you can add # Schema objects are usually added by a <SchemaIterator>, but you can add
# them manually if needed; see <add_schema_object()>. # them manually if needed; see <add_schema_object()>.
{
package Schema; package Schema;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# SchemaIterator package $Revision: 7547 $ # SchemaIterator package $Revision: 7547 $
# ########################################################################### # ###########################################################################
{
# Package: SchemaIterator # Package: SchemaIterator
# SchemaIterator iterates schema objects. # SchemaIterator iterates schema objects.
{
package SchemaIterator; package SchemaIterator;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# SimpleTCPDumpParser package $Revision: 7515 $ # SimpleTCPDumpParser package $Revision: 7515 $
# ########################################################################### # ###########################################################################
# Package: SimpleTCPDumperParser
# SimpleTCPDumpParser parses simple tcpdump output.
{ {
# Package: SimpleTCPDumpParser
# SimpleTCPDumpParser parses simple tcpdump output.
package SimpleTCPDumpParser; package SimpleTCPDumpParser;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# SlowLogParser package $Revision: 7522 $ # SlowLogParser package $Revision: 7522 $
# ########################################################################### # ###########################################################################
{
# Package: SlowLogParser # Package: SlowLogParser
# SlowLogParser parses MySQL slow logs. # SlowLogParser parses MySQL slow logs.
{
package SlowLogParser; package SlowLogParser;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# SlowLogWriter package $Revision: 6590 $ # SlowLogWriter package $Revision: 6590 $
# ########################################################################### # ###########################################################################
{
# Package: SlowLogWriter # Package: SlowLogWriter
# SlowLogWriter writes events to a file in MySQL slow log format. # SlowLogWriter writes events to a file in MySQL slow log format.
{
package SlowLogWriter; package SlowLogWriter;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# SysLogParser package $Revision: 5831 $ # SysLogParser package $Revision: 5831 $
# ########################################################################### # ###########################################################################
{
# Package: SysLogParser # Package: SysLogParser
# SysLogParser parses events from syslogs. # SysLogParser parses events from syslogs.
{
package SysLogParser; package SysLogParser;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# TCPRequestAggregator package $Revision: 7515 $ # TCPRequestAggregator package $Revision: 7515 $
# ########################################################################### # ###########################################################################
{
# Package: TCPRequestAggregator # Package: TCPRequestAggregator
# TCPRequestAggregator aggregates TCP requests from tcpdump files. # TCPRequestAggregator aggregates TCP requests from tcpdump files.
{
package TCPRequestAggregator; package TCPRequestAggregator;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# TableChecksum package $Revision: 7080 $ # TableChecksum package $Revision: 7080 $
# ########################################################################### # ###########################################################################
{
# Package: TableChecksum # Package: TableChecksum
# TableChecksum checksums tables. # TableChecksum checksums tables.
{
package TableChecksum; package TableChecksum;
use strict; use strict;

View File

@@ -18,7 +18,7 @@
# ########################################################################### # ###########################################################################
# TableChunker package $Revision: 7169 $ # TableChunker package $Revision: 7169 $
# ########################################################################### # ###########################################################################
{
# Package: TableChunker # Package: TableChunker
# TableChunker helps determine how to "chunk" a table. Chunk are # TableChunker helps determine how to "chunk" a table. Chunk are
# pre-determined ranges of rows defined by boundary values (sometimes also # pre-determined ranges of rows defined by boundary values (sometimes also
@@ -42,7 +42,6 @@
# distribution of values on the chunk colun can skew chunking. If, for # distribution of values on the chunk colun can skew chunking. If, for
# example, col has values 0, 100, 101, ... then the zero value skews chunking. # example, col has values 0, 100, 101, ... then the zero value skews chunking.
# The zero_chunk arg handles this. # The zero_chunk arg handles this.
{
package TableChunker; package TableChunker;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# TableNibbler package $Revision: 5266 $ # TableNibbler package $Revision: 5266 $
# ########################################################################### # ###########################################################################
{
# Package: TableNibbler # Package: TableNibbler
# TableNibbler determines how to nibble a table by chunks of rows. # TableNibbler determines how to nibble a table by chunks of rows.
{
package TableNibbler; package TableNibbler;
use strict; use strict;

View File

@@ -18,7 +18,7 @@
# ########################################################################### # ###########################################################################
# TableParser package $Revision: 7550 $ # TableParser package $Revision: 7550 $
# ########################################################################### # ###########################################################################
{
# Package: TableParser # Package: TableParser
# TableParser parses SHOW CREATE TABLE. # TableParser parses SHOW CREATE TABLE.
# #
@@ -33,7 +33,6 @@
# $opts->{mysql_version} is typically used, which is the return value from # $opts->{mysql_version} is typically used, which is the return value from
# VersionParser::parser() (which returns a zero-padded MySQL version, # VersionParser::parser() (which returns a zero-padded MySQL version,
# e.g. 004001000 for 4.1.0). # e.g. 004001000 for 4.1.0).
{
package TableParser; package TableParser;
use strict; use strict;

View File

@@ -18,7 +18,7 @@
# ########################################################################### # ###########################################################################
# TableSyncChunk package $Revision: 6389 $ # TableSyncChunk package $Revision: 6389 $
# ########################################################################### # ###########################################################################
{
# Package: TableSyncChunk # Package: TableSyncChunk
# TableSyncChunk is a table sync algo that uses discrete chunks. # TableSyncChunk is a table sync algo that uses discrete chunks.
# This package implements a simple sync algorithm: # This package implements a simple sync algorithm:
@@ -28,7 +28,6 @@
# * Checksum them (state 2) # * Checksum them (state 2)
# * If a row differs, it must be synced # * If a row differs, it must be synced
# See TableSyncStream for the TableSync interface this conforms to. # See TableSyncStream for the TableSync interface this conforms to.
{
package TableSyncChunk; package TableSyncChunk;
use strict; use strict;

View File

@@ -18,13 +18,12 @@
# ########################################################################### # ###########################################################################
# TableSyncGroupBy package $Revision: 5697 $ # TableSyncGroupBy package $Revision: 5697 $
# ########################################################################### # ###########################################################################
{
# Package: TableSyncGroupBy # Package: TableSyncGroupBy
# TableSyncGroupBy is a table sync algo that uses GROUP BY. # TableSyncGroupBy is a table sync algo that uses GROUP BY.
# This package syncs tables without primary keys by doing an all-columns GROUP # This package syncs tables without primary keys by doing an all-columns GROUP
# BY with a count, and then streaming through the results to see how many of # BY with a count, and then streaming through the results to see how many of
# each group exist. # each group exist.
{
package TableSyncGroupBy; package TableSyncGroupBy;
use strict; use strict;

View File

@@ -18,7 +18,7 @@
# ########################################################################### # ###########################################################################
# TableSyncNibble package $Revision: 6511 $ # TableSyncNibble package $Revision: 6511 $
# ########################################################################### # ###########################################################################
{
# Package: TableSyncNibble # Package: TableSyncNibble
# TableSyncNibble is a table sync algo that uses <TableNibbler>. # TableSyncNibble is a table sync algo that uses <TableNibbler>.
# This package implements a moderately complex sync algorithm: # This package implements a moderately complex sync algorithm:
@@ -29,7 +29,6 @@
# * Checksum them (state 2) # * Checksum them (state 2)
# * If a row differs, it must be synced # * If a row differs, it must be synced
# See TableSyncStream for the TableSync interface this conforms to. # See TableSyncStream for the TableSync interface this conforms to.
{
package TableSyncNibble; package TableSyncNibble;
use strict; use strict;

View File

@@ -18,12 +18,11 @@
# ########################################################################### # ###########################################################################
# TableSyncStream package $Revision: 5697 $ # TableSyncStream package $Revision: 5697 $
# ########################################################################### # ###########################################################################
{
# Package: TableSyncStream # Package: TableSyncStream
# TableSyncStream is a table sync algo that selects all rows. # TableSyncStream is a table sync algo that selects all rows.
# This package implements the simplest possible table-sync algorithm: # This package implements the simplest possible table-sync algorithm:
# read every row from the tables and compare them. # read every row from the tables and compare them.
{
package TableSyncStream; package TableSyncStream;
use strict; use strict;

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# TableSyncer package $Revision: 7528 $ # TableSyncer package $Revision: 7528 $
# ########################################################################### # ###########################################################################
{
# Package: TableSyncer # Package: TableSyncer
# TableSyncer helps sync tables with various table sync algo modules. # TableSyncer helps sync tables with various table sync algo modules.
{
package TableSyncer; package TableSyncer;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# TableUsage package $Revision: 7498 $ # TableUsage package $Revision: 7498 $
# ########################################################################### # ###########################################################################
{
# Package: TableUsage # Package: TableUsage
# TableUsage determines how tables in a query are used. # TableUsage determines how tables in a query are used.
# #
@@ -28,7 +28,6 @@
# This package uses both QueryParser and SQLParser. The former is used for # This package uses both QueryParser and SQLParser. The former is used for
# simple queries, and the latter is used for more complex queries where table # simple queries, and the latter is used for more complex queries where table
# usage may be hidden in who-knows-which clause of the SQL statement. # usage may be hidden in who-knows-which clause of the SQL statement.
{
package TableUsage; package TableUsage;
use strict; use strict;

View File

@@ -18,14 +18,13 @@
# ########################################################################### # ###########################################################################
# TcpdumpParser package $Revision: 7505 $ # TcpdumpParser package $Revision: 7505 $
# ########################################################################### # ###########################################################################
{
# Package: TcpdumpParser # Package: TcpdumpParser
# TcpdumpParser parses TCP packets from tcpdump files. # TcpdumpParser parses TCP packets from tcpdump files.
# It expects the output to be formatted a certain way. # It expects the output to be formatted a certain way.
# See the t/samples/tcpdumpxxx.txt files for examples. # See the t/samples/tcpdumpxxx.txt files for examples.
# Here's a sample command on Ubuntu to produce the right formatted output: # Here's a sample command on Ubuntu to produce the right formatted output:
# tcpdump -i lo port 3306 -s 1500 -x -n -q -tttt # tcpdump -i lo port 3306 -s 1500 -x -n -q -tttt
{
package TcpdumpParser; package TcpdumpParser;
use strict; use strict;

View File

@@ -17,7 +17,7 @@
# ########################################################################### # ###########################################################################
# TextResultSetParser package $Revision: 6898 $ # TextResultSetParser package $Revision: 6898 $
# ########################################################################### # ###########################################################################
{
# Package: TextResultSetParser # Package: TextResultSetParser
# TextResultSetParser converts a text result set to a data struct like # TextResultSetParser converts a text result set to a data struct like
# DBI::selectall_arrayref(). Text result sets are like what SHOW PROCESSLIST # DBI::selectall_arrayref(). Text result sets are like what SHOW PROCESSLIST
@@ -39,7 +39,6 @@
# ] # ]
# (end code) # (end code)
# Both horizontal and vertical (\G) text outputs are supported. # Both horizontal and vertical (\G) text outputs are supported.
{
package TextResultSetParser; package TextResultSetParser;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# TimeSeriesTrender package $Revision: 7096 $ # TimeSeriesTrender package $Revision: 7096 $
# ########################################################################### # ###########################################################################
{
# Package: TimeSeriesTrender # Package: TimeSeriesTrender
# TimeSeriesTrender calculates trends in time. # TimeSeriesTrender calculates trends in time.
{
package TimeSeriesTrender; package TimeSeriesTrender;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# Transformers package $Revision: 7226 $ # Transformers package $Revision: 7226 $
# ########################################################################### # ###########################################################################
{
# Package: Transformers # Package: Transformers
# Transformers exports subroutines that convert and beautify values. # Transformers exports subroutines that convert and beautify values.
{
package Transformers; package Transformers;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# UpgradeReportFormatter package $Revision: 7193 $ # UpgradeReportFormatter package $Revision: 7193 $
# ########################################################################### # ###########################################################################
{
# Package: UpgradeReportFormatter # Package: UpgradeReportFormatter
# UpgradeReportFormatter formats the output of pt-upgrade. # UpgradeReportFormatter formats the output of pt-upgrade.
{
package UpgradeReportFormatter; package UpgradeReportFormatter;
use strict; use strict;

View File

@@ -17,10 +17,9 @@
# ########################################################################### # ###########################################################################
# VariableAdvisorRules package $Revision: 6821 $ # VariableAdvisorRules package $Revision: 6821 $
# ########################################################################### # ###########################################################################
{
# Package: VariableAdvisorRules # Package: VariableAdvisorRules
# VariableAdvisorRules specifies rules for checking MySQL variables. # VariableAdvisorRules specifies rules for checking MySQL variables.
{
package VariableAdvisorRules; package VariableAdvisorRules;
use base 'AdvisorRules'; use base 'AdvisorRules';

View File

@@ -18,10 +18,9 @@
# ########################################################################### # ###########################################################################
# VersionParser package $Revision: 6667 $ # VersionParser package $Revision: 6667 $
# ########################################################################### # ###########################################################################
{
# Package: VersionParser # Package: VersionParser
# VersionParser parses a MySQL version string. # VersionParser parses a MySQL version string.
{
package VersionParser; package VersionParser;
use strict; use strict;