package DBIx::Class::Admin;
+use warnings;
+use strict;
+
# check deps
BEGIN {
- my @_deps = qw(
- Moose MooseX::Types MooseX::Types::JSON MooseX::Types::Path::Class
- Try::Tiny parent JSON::Any Class::C3::Componentised
- namespace::autoclean
- );
-
- my @_missing_deps;
- foreach my $dep (@_deps) {
- eval "require $dep";
- if ($@) {
- push @_missing_deps, $dep;
- }
- }
-
- if (@_missing_deps > 0) {
- die "The following dependecies are missing " . join ",", @_missing_deps;
- }
+ require DBIx::Class::Optional::Dependencies;
+ if (my $missing = DBIx::Class::Optional::Dependencies->req_missing_for ('admin') ) {
+ die "The following extra modules are required for DBIx::Class::Admin: $missing\n";
+ }
}
+use JSON::Any qw(DWIW PP JSON CPANEL XS);
use Moose;
-use parent 'DBIx::Class::Schema';
-use Carp::Clan qw/^DBIx::Class/;
-
use MooseX::Types::Moose qw/Int Str Any Bool/;
use DBIx::Class::Admin::Types qw/DBICConnectInfo DBICHashRef/;
use MooseX::Types::JSON qw(JSON);
use MooseX::Types::Path::Class qw(Dir File);
-use Try::Tiny;
-use JSON::Any;
-use namespace::autoclean;
-
+use MooseX::Types::LoadableClass qw(LoadableClass);
+use namespace::clean;
=head1 NAME
=head1 SYNOPSIS
+ $ dbicadmin --help
+
+ $ dbicadmin --schema=MyApp::Schema \
+ --connect='["dbi:SQLite:my.db", "", ""]' \
+ --deploy
+
+ $ dbicadmin --schema=MyApp::Schema --class=Employee \
+ --connect='["dbi:SQLite:my.db", "", ""]' \
+ --op=update --set='{ "name": "New_Employee" }'
+
use DBIx::Class::Admin;
# ddl manipulation
# install a version for an unversioned schema
$admin->install("3.0");
-=head1 Attributes
+=head1 REQUIREMENTS
+
+The Admin interface has additional requirements not currently part of
+L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
+
+=head1 ATTRIBUTES
=head2 schema_class
=cut
has 'schema_class' => (
- is => 'ro',
- isa => Str,
+ is => 'ro',
+ isa => LoadableClass,
);
=cut
has 'schema' => (
- is => 'ro',
- isa => 'DBIx::Class::Schema',
+ is => 'ro',
+ isa => 'DBIx::Class::Schema',
lazy_build => 1,
);
sub _build_schema {
my ($self) = @_;
- $self->ensure_class_loaded($self->schema_class);
- $self->connect_info->[3]->{ignore_version} =1;
- return $self->schema_class->connect(@{$self->connect_info()} ); # , $self->connect_info->[3], { ignore_version => 1} );
+ $self->connect_info->[3]{ignore_version} = 1;
+ return $self->schema_class->clone->connection(@{$self->connect_info});
}
-
=head2 resultset
a resultset from the schema to operate on
=cut
has 'resultset' => (
- is => 'rw',
- isa => Str,
+ is => 'rw',
+ isa => Str,
);
has 'where' => (
is => 'rw',
- isa => DBICHashRef,
- coerce => 1,
+ isa => DBICHashRef,
+ coerce => 1,
);
has 'set' => (
is => 'rw',
- isa => DBICHashRef,
- coerce => 1,
+ isa => DBICHashRef,
+ coerce => 1,
);
=head2 attrs
-a hash ref or json string to be used for passing additonal info to the ->search call
+a hash ref or json string to be used for passing additional info to the ->search call
=cut
has 'attrs' => (
- is => 'rw',
- isa => DBICHashRef,
- coerce => 1,
+ is => 'rw',
+ isa => DBICHashRef,
+ coerce => 1,
);
=cut
has 'connect_info' => (
- is => 'ro',
- isa => DBICConnectInfo,
+ is => 'ro',
+ isa => DBICConnectInfo,
lazy_build => 1,
- coerce => 1,
+ coerce => 1,
);
sub _build_connect_info {
config_file provide a config_file to read connect_info from, if this is provided
config_stanze should also be provided to locate where the connect_info is in the config
-The config file should be in a format readable by Config::General
+The config file should be in a format readable by Config::Any.
=cut
has config_file => (
is => 'ro',
- isa => File,
- coerce => 1,
+ isa => File,
+ coerce => 1,
);
=head2 config_stanza
-config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information
+config_stanza for use with config_file should be a '::' delimited 'path' to the connection information
designed for use with catalyst config files
=cut
has 'config_stanza' => (
- is => 'ro',
- isa => Str,
+ is => 'ro',
+ isa => Str,
);
=head2 config
-Instead of loading from a file the configuration can be provided directly as a hash ref. Please note
+Instead of loading from a file the configuration can be provided directly as a hash ref. Please note
config_stanza will still be required.
=cut
has config => (
- is => 'ro',
- isa => DBICHashRef,
+ is => 'ro',
+ isa => DBICHashRef,
lazy_build => 1,
);
sub _build_config {
my ($self) = @_;
- try { require Config::Any } catch { $self->throw_exception( "Config::Any is required to parse the config file"); };
my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1});
has 'sql_dir' => (
is => 'ro',
- isa => Dir,
- coerce => 1,
+ isa => Dir,
+ coerce => 1,
);
+=head2 sql_type
+
+The type of sql dialect to use for creating sql files from schema
+
+=cut
+
+has 'sql_type' => (
+ is => 'ro',
+ isa => Str,
+);
+
=head2 version
Used for install, the version which will be 'installed' in the schema
=cut
has version => (
- is => 'rw',
- isa => Str,
+ is => 'rw',
+ isa => Str,
);
=head2 preversion
-Previouse version of the schema to create an upgrade diff for, the full sql for that version of the sql must be in the sql_dir
+Previous version of the schema to create an upgrade diff for, the full sql for that version of the sql must be in the sql_dir
=cut
has preversion => (
- is => 'rw',
- isa => Str,
+ is => 'rw',
+ isa => Str,
);
=cut
has force => (
- is => 'rw',
- isa => Bool,
+ is => 'rw',
+ isa => Bool,
);
=cut
has quiet => (
- is => 'rw',
- isa => Bool,
+ is => 'rw',
+ isa => Bool,
);
has '_confirm' => (
- is => 'bare',
- isa => Bool,
+ is => 'bare',
+ isa => Bool,
);
+=head2 trace
+
+Toggle DBIx::Class debug output
+
+=cut
+
+has trace => (
+ is => 'rw',
+ isa => Bool,
+ trigger => \&_trigger_trace,
+);
+
+sub _trigger_trace {
+ my ($self, $new, $old) = @_;
+ $self->schema->storage->debug($new);
+}
+
+
=head1 METHODS
=head2 create
=back
-L<create> will generate sql for the supplied schema_class in sql_dir. The flavour of sql to
-generate can be controlled by suppling a sqlt_type which should be a L<SQL::Translator> name.
+C<create> will generate sql for the supplied schema_class in sql_dir. The
+flavour of sql to generate can be controlled by supplying a sqlt_type which
+should be a L<SQL::Translator> name.
Arguments for L<SQL::Translator> can be supplied in the sqlt_args hashref.
my ($self, $sqlt_type, $sqlt_args, $preversion) = @_;
$preversion ||= $self->preversion();
+ $sqlt_type ||= $self->sql_type();
my $schema = $self->schema();
- # create the dir if does not exist
- $self->sql_dir->mkpath() if ( ! -d $self->sql_dir);
- $schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args );
+ $schema->create_ddl_dir(
+ $sqlt_type,
+ (defined $schema->schema_version ? $schema->schema_version : ""),
+ $self->sql_dir,
+ $preversion,
+ $sqlt_args,
+ );
}
sub upgrade {
my ($self) = @_;
my $schema = $self->schema();
+
if (!$schema->get_db_version()) {
# schema is unversioned
- $self->throw_exception ("could not determin current schema version, please either install or deploy");
+ $schema->throw_exception ("Could not determin current schema version, please either install() or deploy().\n");
} else {
+ $schema->upgrade_directory ($self->sql_dir) if $self->sql_dir; # this will override whatever default the schema has
my $ret = $schema->upgrade();
return $ret;
}
=back
-install is here to help when you want to move to L<DBIx::Class::Schema::Versioned> and have an existing
-database. install will take a version and add the version tracking tables and 'install' the version. No
-further ddl modification takes place. Setting the force attribute to a true value will allow overriding of
+install is here to help when you want to move to L<DBIx::Class::Schema::Versioned> and have an existing
+database. install will take a version and add the version tracking tables and 'install' the version. No
+further ddl modification takes place. Setting the force attribute to a true value will allow overriding of
already versioned databases.
=cut
$version ||= $self->version();
if (!$schema->get_db_version() ) {
# schema is unversioned
- print "Going to install schema version\n";
+ print "Going to install schema version\n" if (!$self->quiet);
my $ret = $schema->install($version);
- print "retun is $ret\n";
+ print "return is $ret\n" if (!$self->quiet);
}
elsif ($schema->get_db_version() and $self->force ) {
- carp "Forcing install may not be a good idea";
+ warn "Forcing install may not be a good idea\n";
if($self->_confirm() ) {
$self->schema->_set_db_version({ version => $version});
}
}
else {
- $self->throw_exception ("schema already has a version not installing, try upgrade instead");
+ $schema->throw_exception ("Schema already has a version. Try upgrade instead.\n");
}
}
=back
-deploy will create the schema at the connected database. C<$args> are passed straight to
+deploy will create the schema at the connected database. C<$args> are passed straight to
L<DBIx::Class::Schema/deploy>.
=cut
sub deploy {
my ($self, $args) = @_;
my $schema = $self->schema();
- if (!$schema->get_db_version() ) {
- # schema is unversioned
- $schema->deploy( $args, $self->sql_dir)
- or $self->throw_exception ("could not deploy schema");
- } else {
- $self->throw_exception("there already is a database with a version here, try upgrade instead");
- }
+ $schema->deploy( $args, $self->sql_dir );
}
=head2 insert
$rs ||= $self->resultset();
$set ||= $self->set();
my $resultset = $self->schema->resultset($rs);
- my $obj = $resultset->create( $set );
+ my $obj = $resultset->new_result($set)->insert;
print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet);
}
$where ||= $self->where();
$set ||= $self->set();
my $resultset = $self->schema->resultset($rs);
- $resultset = $resultset->search( ($where||{}) );
+ $resultset = $resultset->search_rs( $where )
+ if $where;
my $count = $resultset->count();
print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet);
$where ||= $self->where();
$attrs ||= $self->attrs();
my $resultset = $self->schema->resultset($rs);
- $resultset = $resultset->search( ($where||{}), ($attrs||()) );
+ $resultset = $resultset->search_rs( ($where||{}), ($attrs||()) )
+ if $where or $attrs;
my $count = $resultset->count();
print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet);
=back
-select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
+select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
The found data is returned in a array ref where the first row will be the columns list.
=cut
$where ||= $self->where();
$attrs ||= $self->attrs();
my $resultset = $self->schema->resultset($rs);
- $resultset = $resultset->search( ($where||{}), ($attrs||()) );
+ $resultset = $resultset->search_rs( ($where||{}), ($attrs||()) )
+ if $where or $attrs;
my @data;
my @columns = $resultset->result_source->columns();
- push @data, [@columns];#
+ push @data, [@columns];#
while (my $row = $resultset->next()) {
my @fields;
sub _confirm {
my ($self) = @_;
- print "Are you sure you want to do this? (type YES to confirm) \n";
+
# mainly here for testing
return 1 if ($self->meta->get_attribute('_confirm')->get_value($self));
+
+ print "Are you sure you want to do this? (type YES to confirm) \n";
my $response = <STDIN>;
- return 1 if ($response=~/^YES/);
- return;
+
+ return ($response=~/^YES/);
}
sub _find_stanza {
$cfg = $cfg->{$path};
}
else {
- $self->throw_exception("could not find $stanza in config, $path did not seem to exist");
+ die ("Could not find $stanza in config, $path does not seem to exist.\n");
}
}
+ $cfg = $cfg->{connect_info} if exists $cfg->{connect_info};
return $cfg;
}
-=head1 AUTHORS
+=head1 FURTHER QUESTIONS?
-See L<DBIx::Class/CONTRIBUTORS>.
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
-=head1 LICENSE
+=head1 COPYRIGHT AND LICENSE
-You may distribute this code under the same terms as Perl itself
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
=cut
projects / dbsrgits/DBIx-Class.git / blobdiff