-#
-#===============================================================================
-#
-# 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;
use Moose;
-use MooseX::Types
- -declare => [qw( DBICConnectInfo )];
+use MooseX::Types -declare => [qw( DBICConnectInfo )];
use MooseX::Types::Moose qw/Int HashRef ArrayRef Str Any/;
use MooseX::Types::JSON qw(JSON);
use MooseX::Types::Path::Class qw(Dir File);
use Try::Tiny;
+use Carp::Clan qw/^DBIx::Class/;
+
use parent 'Class::C3::Componentised';
+use parent 'DBIx::Class::Schema';
use JSON::Any;
from HashRef,
via { [ $_->{dsn}, $_->{user}, $_->{password} ] };
+
=head1 NAME
DBIx::Class::Admin - Administration object for schemas
=head1 Attributes
-=head2 lib
-
-add a library search path
-=cut
-has lib => (
- is => 'ro',
- isa => Dir,
- coerce => 1,
- trigger => \&_set_inc,
-);
-
-sub _set_inc {
- my ($self, $lib) = @_;
- push @INC, $lib->stringify;
-}
-
=head2 schema_class
the class of the schema to load
+
=cut
+
has 'schema_class' => (
is => 'ro',
isa => 'Str',
coerce => 1,
);
+
=head2 schema
A pre-connected schema object can be provided for manipulation
+
=cut
+
has 'schema' => (
is => 'ro',
isa => 'DBIx::Class::Schema',
return $self->schema_class->connect(@{$self->connect_info()} ); # , $self->connect_info->[3], { ignore_version => 1} );
}
+
=head2 resultset
a resultset from the schema to operate on
+
=cut
+
has 'resultset' => (
is => 'rw',
isa => Str,
);
+
=head2 where
a hash ref or json string to be used for identifying data to manipulate
+
=cut
has 'where' => (
coerce => 1,
);
+
=head2 set
+
a hash ref or json string to be used for inserting or updating data
+
=cut
has 'set' => (
coerce => 1,
);
+
=head2 attrs
+
a hash ref or json string to be used for passing additonal info to the ->search call
+
=cut
+
has 'attrs' => (
is => 'rw',
isa => HashRef,
coerce => 1,
);
+
+
=head2 connect_info
connect_info the arguments to provide to the connect call of the schema_class
-=cut
+=cut
has 'connect_info' => (
is => 'ro',
return $self->_find_stanza($self->config, $self->config_stanza);
}
+
=head2 config_file
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
+
=cut
+
has config_file => (
is => 'ro',
isa => File,
coerce => 1,
);
+
=head2 config_stanza
config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information
designed for use with catalyst config files
+
=cut
+
has 'config_stanza' => (
is => 'ro',
isa => 'Str',
);
+
=head2 config
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 => HashRef,
sub _build_config {
my ($self) = @_;
- try { require 'Config::Any'; } catch { die "Config::Any is required to parse the config file"; };
+ 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});
return $cfg;
}
+
=head2 sql_dir
The location where sql ddl files should be created or found for an upgrade.
+
=cut
+
has 'sql_dir' => (
is => 'ro',
isa => Dir,
coerce => 1,
);
+
=head2 version
Used for install, the version which will be 'installed' in the schema
+
=cut
+
has version => (
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
+
=cut
+
has preversion => (
is => 'rw',
isa => 'Str',
);
+
=head2 force
Try and force certain operations.
+
=cut
+
has force => (
is => 'rw',
isa => 'Bool',
);
+
=head2 quiet
Be less verbose about actions
+
=cut
+
has quiet => (
is => 'rw',
isa => 'Bool',
isa => 'Bool',
);
+
=head1 METHODS
=head2 create
Arguments for L<SQL::Translator> can be supplied in the sqlt_args hashref.
Optional preversion can be supplied to generate a diff to be used by upgrade.
+
=cut
sub create {
$schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args );
}
+
=head2 upgrade
=over 4
upgrade will attempt to upgrade the connected database to the same version as the schema_class.
B<MAKE SURE YOU BACKUP YOUR DB FIRST>
+
=cut
sub upgrade {
my $schema = $self->schema();
if (!$schema->get_db_version()) {
# schema is unversioned
- die "could not determin current schema version, please either install or deploy";
+ $self->throw_exception ("could not determin current schema version, please either install or deploy");
} else {
my $ret = $schema->upgrade();
return $ret;
}
}
+
=head2 install
=over 4
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
+
sub install {
my ($self, $version) = @_;
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";
+ $self->throw_exception ("schema already has a version not installing, try upgrade instead");
}
}
+
=head2 deploy
=over 4
=back
deploy will create the schema at the connected database. C<$args> are passed straight to
-L<DBIx::Class::Schema/deploy>.
+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 die "could not deploy schema";
+ or $self->throw_exception ("could not deploy schema");
} else {
- die "there already is a database with a version here, try upgrade instead";
+ $self->throw_exception("there already is a database with a version here, try upgrade instead");
}
}
-
-# 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
into that resultset
=cut
+
sub insert {
my ($self, $rs, $set) = @_;
=head2 update
-=over 4
+=over 4
=item Arguments: $rs, $set, $where
=back
-update takes the name of a resultset from the schema_class, a hashref of data to update and
-a where hash used to form the search for the rows to update.
+update takes the name of a resultset from the schema_class, a hashref of data to update and
+a where hash used to form the search for the rows to update.
+
=cut
+
sub update {
my ($self, $rs, $set, $where) = @_;
}
}
-# FIXME
-#die('Do not use the set option with the delete op') if ($set);
+
=head2 delete
=over 4
=back
-delete takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
+delete takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
The found data is deleted and cannot be recovered.
+
=cut
+
sub delete {
my ($self, $rs, $where, $attrs) = @_;
}
}
+
=head2 select
=over 4
The found data is returned in a array ref where the first row will be the columns list.
=cut
+
sub select {
my ($self, $rs, $where, $attrs) = @_;
$cfg = $cfg->{$path};
}
else {
- die "could not find $stanza in config, $path did not seem to exist";
+ $self->throw_exception("could not find $stanza in config, $path did not seem to exist");
}
}
return $cfg;
}
-=head1 AUTHOR
-Gordon Irving <goraxe@cpan.org>
-with code taken from dbicadmin by
-Aran Deltac <bluefeet@cpan.org>
+=head1 AUTHORS
+See L<DBIx::Class/CONTRIBUTORS>.
=head1 LICENSE
-You may distribute this code under the same terms as Perl itself.
+You may distribute this code under the same terms as Perl itself
+
=cut
+
1;
projects / dbsrgits/DBIx-Class.git / blobdiff