-#
-#===============================================================================
-#
-# FILE: Admin.pm
-#
-# DESCRIPTION: Administrative functions for DBIx::Class Schemata
-#
-# FILES: ---
-# BUGS: ---
-# NOTES: ---
-# AUTHOR: Gordon Irving (), <Gordon.irving@sophos.com>
-# VERSION: 1.0
-# CREATED: 28/11/09 12:27:15 GMT
-# REVISION: ---
-#===============================================================================
-
package DBIx::Class::Admin;
+# check deps
+BEGIN {
+ use Carp::Clan qw/^DBIx::Class/;
+ use DBIx::Class;
+ croak('The following modules are required for DBIx::Class::Admin ' . DBIx::Class::Optional::Dependencies->req_missing_for ('admin') )
+ unless DBIx::Class::Optional::Dependencies->req_ok_for ('admin');
+}
+
use Moose;
-use MooseX::Types -declare => [qw( DBICConnectInfo )];
-use MooseX::Types::Moose qw/Int HashRef ArrayRef Str Any/;
+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 parent 'Class::C3::Componentised';
-
-use JSON::Any;
-
+use JSON::Any qw(DWIW XS JSON);
use namespace::autoclean;
-my @_deps = qw(Moose MooseX::Types MooseX::Types::JSON MooseX::Types::Path::Class Try::Tiny parent JSON::Any Class::C3::Componentised namespace::autoclean);
-
-coerce ArrayRef,
- from JSON,
- via { _json_to_data ($_) };
-
-coerce HashRef,
- from JSON,
- via { _json_to_data($_) };
-
-subtype DBICConnectInfo,
- as ArrayRef;
-
-coerce DBICConnectInfo,
- from JSON,
- via { return _json_to_data($_) } ;
-
-coerce DBICConnectInfo,
- from Str,
- via { return _json_to_data($_) };
-
-coerce DBICConnectInfo,
- from HashRef,
- via { [ $_->{dsn}, $_->{user}, $_->{password} ] };
-
-
=head1 NAME
DBIx::Class::Admin - Administration object for schemas
=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
-
-=head2 lib
-
-add a library search path
+=head1 REQUIREMENTS
-=cut
-
-has lib => (
- is => 'ro',
- isa => Dir,
- coerce => 1,
- trigger => \&_set_inc,
-);
-
-sub _set_inc {
- my ($self, $lib) = @_;
- push @INC, $lib->stringify;
-}
+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',
- coerce => 1,
+ is => 'ro',
+ isa => Str,
);
=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);
+ require Class::MOP;
+ Class::MOP::load_class($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} );
=cut
has 'resultset' => (
- is => 'rw',
- isa => Str,
+ is => 'rw',
+ isa => Str,
);
has 'where' => (
is => 'rw',
- isa => HashRef,
- coerce => 1,
+ isa => DBICHashRef,
+ coerce => 1,
);
has 'set' => (
is => 'rw',
- isa => HashRef,
- coerce => 1,
+ isa => DBICHashRef,
+ coerce => 1,
);
=cut
has 'attrs' => (
- is => 'rw',
- isa => HashRef,
- 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 {
has config_file => (
is => 'ro',
- isa => File,
- coerce => 1,
+ isa => File,
+ coerce => 1,
);
=cut
has 'config_stanza' => (
- is => 'ro',
- isa => 'Str',
+ is => 'ro',
+ isa => Str,
);
=cut
has config => (
- is => 'ro',
- isa => HashRef,
+ is => 'ro',
+ isa => DBICHashRef,
lazy_build => 1,
);
sub _build_config {
my ($self) = @_;
- try { require Config::Any } catch { die "Config::Any is required to parse the config file"; };
+
+ eval { require Config::Any }
+ or die ("Config::Any is required to parse the config file.\n");
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,
);
=cut
has version => (
- is => 'rw',
- isa => 'Str',
+ is => 'rw',
+ isa => Str,
);
=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,
);
my $schema = $self->schema();
if (!$schema->get_db_version()) {
# schema is unversioned
- die "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 {
my $ret = $schema->upgrade();
return $ret;
print "retun is $ret\n";
}
elsif ($schema->get_db_version() and $self->force ) {
- warn "Forcing install may not be a good idea";
+ carp "Forcing install may not be a good idea";
if($self->_confirm() ) {
- # FIXME private api
$self->schema->_set_db_version({ version => $version});
}
}
else {
- die "schema already has a version not installing, try upgrade instead";
+ $schema->throw_exception ("Schema already has a version. Try upgrade instead.\n");
}
}
if (!$schema->get_db_version() ) {
# schema is unversioned
$schema->deploy( $args, $self->sql_dir)
- or die "could not deploy schema";
+ or $schema->throw_exception ("Could not deploy schema.\n"); # FIXME deploy() does not return 1/0 on success/fail
} else {
- die "there already is a database with a version here, try upgrade instead";
+ $schema->throw_exception("A versioned schema has already been deployed, try upgrade instead.\n");
}
}
-
-# FIXME ensure option spec compatability
-#die('Do not use the where option with the insert op') if ($where);
-#die('Do not use the attrs option with the insert op') if ($attrs);
-
-
=head2 insert
=over 4
}
}
-# FIXME
-#die('Do not use the set option with the delete op') if ($set);
-
=head2 delete
$cfg = $cfg->{$path};
}
else {
- die "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");
}
}
return $cfg;
}
-sub _json_to_data {
- my ($json_str) = @_;
- my $json = JSON::Any->new(allow_barekey => 1, allow_singlequote => 1, relaxed=>1);
- my $ret = $json->jsonToObj($json_str);
- return $ret;
-}
-
-
-{ # deps check
-
-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;
-}
-
-
-}
-
-
-=head1 AUTHORS
+=head1 AUTHOR
See L<DBIx::Class/CONTRIBUTORS>.
projects / dbsrgits/DBIx-Class.git / blobdiff