ChangeMySQLEngine_conf.pm

Go to the documentation of this file.

=head1 LICENSE
 
See the NOTICE file distributed with this work for additional information
regarding copyright ownership.
 
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
 
     http://www.apache.org/licenses/LICENSE-2.0
 
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
 
=cut
 
 
=pod 
 
=head1 NAME
 
Bio::EnsEMBL::Hive::Examples::Factories::PipeConfig::ChangeMySQLEngine_conf
 
=head1 SYNOPSIS
 
    init_pipeline.pl Bio::EnsEMBL::Hive::Examples::Factories::PipeConfig::ChangeMySQLEngine_conf -pipeline_url db://hive@database/to_track_jobs -target_db db://to/turn_into_innodb -target_engine InnoDB
 
=head1 DESCRIPTION  
 
A pipeline to change MySQL engine for all tables in a given database
 
=head1 CONTACT
 
Please email comments or questions to the public Ensembl
developers list at <http://lists.ensembl.org/mailman/listinfo/dev>.
 
Questions may also be sent to the Ensembl help desk at
<http://www.ensembl.org/Help/Contact>.
 
=cut
 
package Bio::EnsEMBL::Hive::Examples::Factories::PipeConfig::ChangeMySQLEngine_conf;
 
use strict;
use warnings;
 
use base ('Bio::EnsEMBL::Hive::PipeConfig::HiveGeneric_conf');
use Bio::EnsEMBL::Hive::PipeConfig::HiveGeneric_conf;           # Allow this particular config to use conditional dataflow and INPUT_PLUS
 
=head2 default_options
 
    Description : Implements default_options() interface method of Bio::EnsEMBL::Hive::PipeConfig::HiveGeneric_conf that is used to initialize default options.
                  In addition to the standard things it defines four options:
                    o('concurrent_jobs')   defines how many tables can be worked on in parallel
 
=cut
 
sub default_options {
    my ($self) = @_;
    return {
        %{$self->SUPER::default_options(@_)},
 
        'concurrent_jobs'  => 2,    # how many tables can be worked on in parallel (too many will slow the process down)
    };
}
 
=head2 pipeline_analyses
 
    Description : Implements pipeline_analyses() interface method of Bio::EnsEMBL::Hive::PipeConfig::HiveGeneric_conf that defines the structure of the pipeline: analyses, jobs, rules, etc.
                  Here it defines two analyses:
 
                    * 'generate_job_list'   generates a list of tables to be copied from master_db
 
                    * 'change_engine' changes table's engine into the target engine 
 
=cut
 
sub pipeline_analyses {
    my ($self) = @_;
    return [
        {   -logic_name => 'generate_job_list',
            -module     => 'Bio::EnsEMBL::Hive::RunnableDB::JobFactory',
            -parameters => {
                'db_conn'         => '#target_db#',
                'inputquery'      => "SELECT table_name, engine FROM information_schema.TABLES WHERE Engine != '#target_engine#' AND table_schema=DATABASE();",
            },
            -input_ids => [
                {
                    'target_db'     => $self->o('target_db'),
                    'target_engine' => $self->o('target_engine'),
                }
            ],
 
            -flow_into  => { 2 => { 'change_engine' => INPUT_PLUS() } },
        },
 
        {   -logic_name    => 'change_engine',
            -module        => 'Bio::EnsEMBL::Hive::RunnableDB::SqlCmd',
            -parameters    => {
                'db_conn'     => '#target_db#',
                'sql'         => "ALTER TABLE #table_name# ENGINE='#target_engine#'",
            },
            -hive_capacity => $self->o('concurrent_jobs'),       # allow several workers to perform identical tasks in parallel
        },
    ];
}
 
1;