File Coverage

blib/lib/Mojolicious/Plugin/MySQLViewerLite.pm

Criterion	Covered	Total	%
statement	14	45	31.1
branch	0	6	0.0
condition	0	5	0.0
subroutine	5	6	83.3
pod	1	1	100.0
total	20	63	31.7

use 5.001001;
package Mojolicious::Plugin::MySQLViewerLite;
use Mojo::Base 'Mojolicious::Plugin::MySQLViewerLite::Base';
use File::Basename 'dirname';
use Cwd 'abs_path';
use Mojolicious::Plugin::MySQLViewerLite::Command;

our $VERSION = '0.17';

has command => sub {
  my $self = shift;
  my $commond = Mojolicious::Plugin::MySQLViewerLite::Command->new(dbi => $self->dbi);
};

sub register {
  my ($self, $app, $conf) = @_;
  my $prefix = $conf->{prefix} // 'mysqlviewerlite';

  # Database
  my $dbi = $conf->{dbi};
  my $connector = $conf->{connector};
  my $dbh = $conf->{dbh};
  if ($dbi) { $self->dbi($dbi) }
  elsif ($connector) { $self->dbi->connector($connector) }
  else { $self->dbi->dbh($dbh) }

  # Add template and static path
  $self->add_template_path($app->renderer, __PACKAGE__);
  $self->add_static_path($app->static, __PACKAGE__);

  # Mojolicious compatibility
  my $any_method_name;
  if ($Mojolicious::VERSION >= '8.67') {
    $any_method_name = 'any'
  }
  else {
    $any_method_name = 'route'
  }

  # Routes
  my $r = $conf->{route} // $app->routes;
  $self->prefix($prefix);
  {
    my $r = $r->$any_method_name("/$prefix")->to(
      'mysqlviewerlite#',
      namespace => 'Mojolicious::Plugin::MySQLViewerLite',
      plugin => $self,
      prefix => $self->prefix,
      main_title => 'MySQL Viewer Lite',
    );

    $r->get('/')->to('#default');
    $r->get('/tables')->to(
      '#tables',
      utilities => [
        {path => 'showcreatetables', title => 'Show create tables'},
        {path => 'showselecttables', title => 'Show select tables'},
        {path => 'showprimarykeys', title => 'Show primary keys'},
        {path => 'shownullallowedcolumns', title => 'Show null allowed columns'},
        {path => 'showdatabaseengines', title => 'Show database engines'},
        {path => 'showcharsets', title => 'Show charsets'}
      ]
    );
    $r->get('/table')->to('#table');
    $r->get('/showcreatetables')->to('#showcreatetables');
    $r->get('/showselecttables')->to('#showselecttables');
    $r->get('/showprimarykeys')->to('#showprimarykeys');
    $r->get('/shownullallowedcolumns')->to('#shownullallowedcolumns');
    $r->get('/showdatabaseengines')->to('#showdatabaseengines');
    $r->get('/showcharsets')->to('#showcharsets');
    $r->get('/select')->to('#select');

    # Routes (MySQL specific)
    $r->get('/showdatabaseengines')->to('#showdatabaseengines');
    $r->get('/showcharsets')->to('#showcharsets');
  }
}

1;

=head1 NAME

Mojolicious::Plugin::MySQLViewerLite - Mojolicious plugin to display MySQL database information on browser

=head1 CAUTION

B is merged into L>.

B.

But you get it on github.

  https://github.com/yuki-kimoto/Mojolicious-Plugin-MySQLViewerLite

=head1 SYNOPSYS

  # Mojolicious::Lite
  # (dbh is a database handle already connected to the database)
  plugin 'MySQLViewerLite', dbh => $dbh;

  # Mojolicious
  $app->plugin('MySQLViewerLite', dbh => $dbh);

  # Access
  http://localhost:3000/mysqlviewerlite

  # Prefix
  plugin 'MySQLViewerLite', dbh => $dbh, prefix => 'mysqlviewerlite2';

  # Route
  my $bridge = $app->route->under(sub {...});
  plugin 'MySQLViewerLite', dbh => $dbh, route => $bridge;

  # Using connection manager object instead of "dbh"
  plugin 'MySQLViewerLite', connector => DBIx::Connector->connect(...);

  # Using DBIx::Custom object instead of "dbh"
  plugin 'MySQLViewerLite', dbi => DBIx::Custom->connect(...);

=head1 DESCRIPTION

L is L plugin
to display MySQL database information on your browser.

L have the following features.

=over 4

=item *

Display all table names

=item *

Display C

=item *

Select * from TABLE

=item *

Display C, C, C and C in all tables.

=back

=head1 OPTIONS

=head2 C

  connector => $connector

Connector object such as L to connect to database.
You can use this instead of C option.

  my $connector = DBIx::Connector->connect(...);

Connector has C method to get database handle

=head2 C

  dbh => $dbh

dbh is a L database handle already connected to the database.

  my $dbh = DBI->connect(...);

=head2 C

  dbi => DBIx::Custom->connect(...);

L object.
you can use this instead of C option.

=head2 C

  prefix => 'mysqlviewerlite2'

Application base path, default to C.

=head2 C

    route => $route

Router, default to C<$app->routes>.

It is useful when C is used.

  my $bridge = $r->under(sub {...});
  plugin 'MySQLViewerLite', dbh => $dbh, route => $bridge;

=cut