[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Admin.pm

#
#===============================================================================
#
#         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::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 parent 'Class::C3::Componentised';

use JSON::Any;

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

	use DBIx::Class::Admin;

	# ddl manipulation
	my $admin = DBIx::Class::Admin->new(
		schema_class=> 'MY::Schema',
		sql_dir=> $sql_dir,
		connect_info => { dsn => $dsn, user => $user, password => $pass },
	);

	# create SQLite sql
	$admin->create('SQLite');

	# create SQL diff for an upgrade
	$admin->create('SQLite', {} , "1.0");

	# upgrade a database
	$admin->upgrade();

	# install a version for an unversioned schema
	$admin->install("3.0");

=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',
	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} );
}

=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' => (
	is			=> 'rw',
	isa			=> HashRef,
	coerce		=> 1,
);

=head2 set
a hash ref or json string to be used for inserting or updating data
=cut

has 'set' => (
	is			=> 'rw',
	isa			=> HashRef,
	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


has 'connect_info' => (
	is			=> 'ro',
	isa			=> DBICConnectInfo,
	lazy_build	=> 1,
	coerce		=> 1,
);

sub _build_connect_info {
	my ($self) = @_;
	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,
	lazy_build	=> 1,
);

sub _build_config {
	my ($self) = @_;
	try { require 'Config::Any'; } catch { die "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});

	# just grab the config from the config file
	$cfg = $cfg->{$self->config_file};
	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',
);

has '_confirm' => (
	is		=> 'bare',
	isa		=> 'Bool',
);

=head1 METHODS

=head2 create

=over 4

=item Arguments: $sqlt_type, \%sqlt_args, $preversion

=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.  

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 {
	my ($self, $sqlt_type, $sqlt_args, $preversion) = @_;

	$preversion ||= $self->preversion();

	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 );
}

=head2 upgrade

=over 4

=item Arguments: <none>

=back

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 ($self) = @_;
	my $schema = $self->schema();
	if (!$schema->get_db_version()) {
		# schema is unversioned
		die "could not determin current schema version, please either install or deploy";
	} else {
		my $ret = $schema->upgrade();
		return $ret;
	}
}

=head2 install

=over 4

=item Arguments: $version

=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 
already versioned databases.
=cut
sub install {
	my ($self, $version) = @_;

	my $schema = $self->schema();
	$version ||= $self->version();
	if (!$schema->get_db_version() ) {
		# schema is unversioned
		print "Going to install schema version\n";
		my $ret = $schema->install($version);
		print "retun is $ret\n";
	}
	elsif ($schema->get_db_version() and $self->force ) {
		warn "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";
	}

}

=head2 deploy

=over 4

=item Arguments: $args

=back

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 die "could not deploy schema";
	} else {
		die "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

=item Arguments: $rs, $set

=back

insert takes the name of a resultset from the schema_class and a hashref of data to insert
into that resultset

=cut
sub insert {
	my ($self, $rs, $set) = @_;

	$rs ||= $self->resultset();
	$set ||= $self->set();
	my $resultset = $self->schema->resultset($rs);
	my $obj = $resultset->create( $set );
	print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet);
}


=head2 update

=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. 
=cut
sub update {
	my ($self, $rs, $set, $where) = @_;

	$rs ||= $self->resultset();
	$where ||= $self->where();
	$set ||= $self->set();
	my $resultset = $self->schema->resultset($rs);
	$resultset = $resultset->search( ($where||{}) );

	my $count = $resultset->count();
	print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet);

	if ( $self->force || $self->_confirm() ) {
		$resultset->update_all( $set );
	}
}

# FIXME
#die('Do not use the set option with the delete op') if ($set);
=head2 delete

=over 4

=item Arguments: $rs, $where, $attrs

=back

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) = @_;

	$rs ||= $self->resultset();
	$where ||= $self->where();
	$attrs ||= $self->attrs();
	my $resultset = $self->schema->resultset($rs);
	$resultset = $resultset->search( ($where||{}), ($attrs||()) );

	my $count = $resultset->count();
	print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet);

	if ( $self->force || $self->_confirm() ) {
		$resultset->delete_all();
	}
}

=head2 select

=over 4

=item Arguments: $rs, $where, $attrs

=back

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
sub select {
	my ($self, $rs, $where, $attrs) = @_;

	$rs ||= $self->resultset();
	$where ||= $self->where();
	$attrs ||= $self->attrs();
	my $resultset = $self->schema->resultset($rs);
	$resultset = $resultset->search( ($where||{}), ($attrs||()) );

	my @data;
	my @columns = $resultset->result_source->columns();
	push @data, [@columns];# 

	while (my $row = $resultset->next()) {
		my @fields;
		foreach my $column (@columns) {
			push( @fields, $row->get_column($column) );
		}
		push @data, [@fields];
	}

	return \@data;
}

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));
	my $response = <STDIN>;
	return 1 if ($response=~/^YES/);
	return;
}

sub _find_stanza {
	my ($self, $cfg, $stanza) = @_;
	my @path = split /::/, $stanza;
	while (my $path = shift @path) {
		if (exists $cfg->{$path}) {
			$cfg = $cfg->{$path};
		}
		else {
			die "could not find $stanza in config, $path did not seem to exist";
		}
	}
	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 AUTHOR

Gordon Irving <goraxe@cpan.org>

with code taken from dbicadmin by 
Aran Deltac <bluefeet@cpan.org>


=head1 LICENSE

You may distribute this code under the same terms as Perl itself.
=cut
1;
Commit	Line	Data
9f3849c3	1	#
	2	#===============================================================================
	3	#
	4	# FILE: Admin.pm
	5	#
	6	# DESCRIPTION: Administrative functions for DBIx::Class Schemata
	7	#
	8	# FILES: ---
	9	# BUGS: ---
	10	# NOTES: ---
	11	# AUTHOR: Gordon Irving (), <Gordon.irving@sophos.com>
	12	# VERSION: 1.0
	13	# CREATED: 28/11/09 12:27:15 GMT
	14	# REVISION: ---
	15	#===============================================================================
	16
	17	package DBIx::Class::Admin;
	18
	19	use Moose;
bb464677	20	use MooseX::Types
bb464677	21	-declare => [qw( DBICConnectInfo )];
9f3849c3	22	use MooseX::Types::Moose qw/Int HashRef ArrayRef Str Any/;
bb464677	23	use MooseX::Types::JSON qw(JSON);
9f3849c3	24	use MooseX::Types::Path::Class qw(Dir File);
9f3849c3	25	use Try::Tiny;
417e1784	26
9f3849c3	27	use parent 'Class::C3::Componentised';
9f3849c3	28
bb464677	29	use JSON::Any;
bb464677	30
8aa16237	31	use namespace::autoclean;
bb464677	32
8aa16237	33	my @_deps = qw(Moose MooseX::Types MooseX::Types::JSON MooseX::Types::Path::Class Try::Tiny parent JSON::Any Class::C3::Componentised namespace::autoclean);
417e1784	34
bb464677	35	coerce ArrayRef,
	36	from JSON,
	37	via { _json_to_data ($_) };
	38
	39	coerce HashRef,
	40	from JSON,
	41	via { _json_to_data($_) };
	42
	43	subtype DBICConnectInfo,
	44	as ArrayRef;
	45
	46	coerce DBICConnectInfo,
	47	from JSON,
	48	via { return _json_to_data($_) } ;
	49
	50	coerce DBICConnectInfo,
	51	from Str,
	52	via { return _json_to_data($_) };
	53
	54	coerce DBICConnectInfo,
	55	from HashRef,
	56	via { [ $_->{dsn}, $_->{user}, $_->{password} ] };
595cb2c7	57
	58	=head1 NAME
	59
	60	DBIx::Class::Admin - Administration object for schemas
	61
	62	=head1 SYNOPSIS
	63
	64	use DBIx::Class::Admin;
	65
	66	# ddl manipulation
	67	my $admin = DBIx::Class::Admin->new(
	68	schema_class=> 'MY::Schema',
	69	sql_dir=> $sql_dir,
	70	connect_info => { dsn => $dsn, user => $user, password => $pass },
	71	);
	72
	73	# create SQLite sql
	74	$admin->create('SQLite');
	75
	76	# create SQL diff for an upgrade
	77	$admin->create('SQLite', {} , "1.0");
	78
	79	# upgrade a database
	80	$admin->upgrade();
	81
	82	# install a version for an unversioned schema
	83	$admin->install("3.0");
9f3849c3	84
	85	=head1 Attributes
	86
595cb2c7	87	=head2 lib
	88
	89	add a library search path
9f3849c3	90	=cut
	91	has lib => (
	92	is => 'ro',
	93	isa => Dir,
	94	coerce => 1,
	95	trigger => \&_set_inc,
	96	);
	97
	98	sub _set_inc {
	99	my ($self, $lib) = @_;
	100	push @INC, $lib->stringify;
	101	}
	102
595cb2c7	103	=head2 schema_class
9f3849c3	104
595cb2c7	105	the class of the schema to load
595cb2c7	106	=cut
9f3849c3	107	has 'schema_class' => (
	108	is => 'ro',
	109	isa => 'Str',
	110	coerce => 1,
	111	);
	112
595cb2c7	113	=head2 schema
9f3849c3	114
595cb2c7	115	A pre-connected schema object can be provided for manipulation
595cb2c7	116	=cut
9f3849c3	117	has 'schema' => (
	118	is => 'ro',
	119	isa => 'DBIx::Class::Schema',
	120	lazy_build => 1,
	121	);
	122
9f3849c3	123	sub _build_schema {
	124	my ($self) = @_;
	125	$self->ensure_class_loaded($self->schema_class);
9f3849c3	126
2ded40e7	127	$self->connect_info->[3]->{ignore_version} =1;
2ded40e7	128	return $self->schema_class->connect(@{$self->connect_info()} ); # , $self->connect_info->[3], { ignore_version => 1} );
9f3849c3	129	}
9f3849c3	130
bb464677	131	=head2 resultset
	132
	133	a resultset from the schema to operate on
	134	=cut
	135	has 'resultset' => (
	136	is => 'rw',
	137	isa => Str,
	138	);
	139
	140	=head2 where
	141
	142	a hash ref or json string to be used for identifying data to manipulate
	143	=cut
	144
	145	has 'where' => (
	146	is => 'rw',
	147	isa => HashRef,
	148	coerce => 1,
	149	);
	150
	151	=head2 set
	152	a hash ref or json string to be used for inserting or updating data
	153	=cut
	154
	155	has 'set' => (
	156	is => 'rw',
	157	isa => HashRef,
	158	coerce => 1,
	159	);
	160
	161	=head2 attrs
	162	a hash ref or json string to be used for passing additonal info to the ->search call
	163	=cut
	164	has 'attrs' => (
	165	is => 'rw',
	166	isa => HashRef,
	167	coerce => 1,
	168	);
595cb2c7	169	=head2 connect_info
	170
	171	connect_info the arguments to provide to the connect call of the schema_class
	172	=cut
bb464677	173
bb464677	174
9f3849c3	175	has 'connect_info' => (
9f3849c3	176	is => 'ro',
bb464677	177	isa => DBICConnectInfo,
9f3849c3	178	lazy_build => 1,
bb464677	179	coerce => 1,
9f3849c3	180	);
	181
	182	sub _build_connect_info {
	183	my ($self) = @_;
595cb2c7	184	return $self->_find_stanza($self->config, $self->config_stanza);
9f3849c3	185	}
9f3849c3	186
595cb2c7	187	=head2 config_file
	188
	189	config_file provide a config_file to read connect_info from, if this is provided
	190	config_stanze should also be provided to locate where the connect_info is in the config
	191	The config file should be in a format readable by Config::General
	192	=cut
	193	has config_file => (
	194	is => 'ro',
	195	isa => File,
	196	coerce => 1,
	197	);
	198
	199	=head2 config_stanza
	200
	201	config_stanza for use with config_file should be a '::' deliminated 'path' to the connection information
	202	designed for use with catalyst config files
	203	=cut
	204	has 'config_stanza' => (
	205	is => 'ro',
	206	isa => 'Str',
	207	);
	208
	209	=head2 config
	210
	211	Instead of loading from a file the configuration can be provided directly as a hash ref. Please note
	212	config_stanza will still be required.
	213	=cut
9f3849c3	214	has config => (
	215	is => 'ro',
	216	isa => HashRef,
	217	lazy_build => 1,
	218	);
	219
	220	sub _build_config {
	221	my ($self) = @_;
	222	try { require 'Config::Any'; } catch { die "Config::Any is required to parse the config file"; };
	223
	224	my $cfg = Config::Any->load_files ( {files => [$self->config_file], use_ext =>1, flatten_to_hash=>1});
	225
	226	# just grab the config from the config file
	227	$cfg = $cfg->{$self->config_file};
	228	return $cfg;
	229	}
	230
595cb2c7	231	=head2 sql_dir
9f3849c3	232
595cb2c7	233	The location where sql ddl files should be created or found for an upgrade.
595cb2c7	234	=cut
9f3849c3	235	has 'sql_dir' => (
	236	is => 'ro',
	237	isa => Dir,
	238	coerce => 1,
	239	);
	240
595cb2c7	241	=head2 version
9f3849c3	242
595cb2c7	243	Used for install, the version which will be 'installed' in the schema
595cb2c7	244	=cut
9f3849c3	245	has version => (
912e2d5a	246	is => 'rw',
9f3849c3	247	isa => 'Str',
	248	);
	249
595cb2c7	250	=head2 preversion
	251
	252	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
	253	=cut
9f3849c3	254	has preversion => (
	255	is => 'rw',
	256	isa => 'Str',
9f3849c3	257	);
9f3849c3	258
595cb2c7	259	=head2 force
	260
	261	Try and force certain operations.
	262	=cut
912e2d5a	263	has force => (
	264	is => 'rw',
	265	isa => 'Bool',
	266	);
	267
c57f1cf7	268	=head2 quiet
595cb2c7	269
	270	Be less verbose about actions
	271	=cut
64c012f4	272	has quiet => (
	273	is => 'rw',
	274	isa => 'Bool',
	275	);
	276
912e2d5a	277	has '_confirm' => (
595cb2c7	278	is => 'bare',
912e2d5a	279	isa => 'Bool',
	280	);
	281
595cb2c7	282	=head1 METHODS
	283
	284	=head2 create
	285
	286	=over 4
	287
	288	=item Arguments: $sqlt_type, \%sqlt_args, $preversion
	289
	290	=back
	291
	292	L<create> will generate sql for the supplied schema_class in sql_dir. The flavour of sql to
	293	generate can be controlled by suppling a sqlt_type which should be a L<SQL::Translator> name.
	294
	295	Arguments for L<SQL::Translator> can be supplied in the sqlt_args hashref.
	296
	297	Optional preversion can be supplied to generate a diff to be used by upgrade.
	298	=cut
	299
9f3849c3	300	sub create {
595cb2c7	301	my ($self, $sqlt_type, $sqlt_args, $preversion) = @_;
	302
	303	$preversion \|\|= $self->preversion();
	304
9f3849c3	305	my $schema = $self->schema();
9f3849c3	306	# create the dir if does not exist
	307	$self->sql_dir->mkpath() if ( ! -d $self->sql_dir);
	308
595cb2c7	309	$schema->create_ddl_dir( $sqlt_type, (defined $schema->schema_version ? $schema->schema_version : ""), $self->sql_dir->stringify, $preversion, $sqlt_args );
9f3849c3	310	}
9f3849c3	311
595cb2c7	312	=head2 upgrade
	313
	314	=over 4
	315
	316	=item Arguments: <none>
	317
	318	=back
	319
	320	upgrade will attempt to upgrade the connected database to the same version as the schema_class.
	321	B<MAKE SURE YOU BACKUP YOUR DB FIRST>
	322	=cut
	323
9f3849c3	324	sub upgrade {
	325	my ($self) = @_;
	326	my $schema = $self->schema();
	327	if (!$schema->get_db_version()) {
	328	# schema is unversioned
912e2d5a	329	die "could not determin current schema version, please either install or deploy";
9f3849c3	330	} else {
64c012f4	331	my $ret = $schema->upgrade();
64c012f4	332	return $ret;
9f3849c3	333	}
	334	}
	335
595cb2c7	336	=head2 install
	337
	338	=over 4
	339
	340	=item Arguments: $version
	341
	342	=back
	343
	344	install is here to help when you want to move to L<DBIx::Class::Schema::Versioned> and have an existing
	345	database. install will take a version and add the version tracking tables and 'install' the version. No
	346	further ddl modification takes place. Setting the force attribute to a true value will allow overriding of
	347	already versioned databases.
	348	=cut
9f3849c3	349	sub install {
912e2d5a	350	my ($self, $version) = @_;
9f3849c3	351
9f3849c3	352	my $schema = $self->schema();
912e2d5a	353	$version \|\|= $self->version();
912e2d5a	354	if (!$schema->get_db_version() ) {
9f3849c3	355	# schema is unversioned
912e2d5a	356	print "Going to install schema version\n";
	357	my $ret = $schema->install($version);
	358	print "retun is $ret\n";
	359	}
	360	elsif ($schema->get_db_version() and $self->force ) {
	361	warn "forcing install may not be a good idea";
595cb2c7	362	if($self->_confirm() ) {
912e2d5a	363	# FIXME private api
912e2d5a	364	$self->schema->_set_db_version({ version => $version});
	365	}
	366	}
	367	else {
	368	die "schema already has a version not installing, try upgrade instead";
9f3849c3	369	}
	370
	371	}
	372
595cb2c7	373	=head2 deploy
	374
	375	=over 4
	376
	377	=item Arguments: $args
	378
	379	=back
	380
	381	deploy will create the schema at the connected database. C<$args> are passed straight to
	382	L<DBIx::Class::Schema/deploy>.
	383	=cut
9f3849c3	384	sub deploy {
2ded40e7	385	my ($self, $args) = @_;
9f3849c3	386	my $schema = $self->schema();
	387	if (!$schema->get_db_version() ) {
	388	# schema is unversioned
2ded40e7	389	$schema->deploy( $args, $self->sql_dir)
2ded40e7	390	or die "could not deploy schema";
9f3849c3	391	} else {
912e2d5a	392	die "there already is a database with a version here, try upgrade instead";
9f3849c3	393	}
	394	}
	395
9f3849c3	396
	397	# FIXME ensure option spec compatability
	398	#die('Do not use the where option with the insert op') if ($where);
	399	#die('Do not use the attrs option with the insert op') if ($attrs);
595cb2c7	400
bb464677	401	=head2 insert
595cb2c7	402
	403	=over 4
	404
	405	=item Arguments: $rs, $set
	406
	407	=back
	408
bb464677	409	insert takes the name of a resultset from the schema_class and a hashref of data to insert
595cb2c7	410	into that resultset
	411
	412	=cut
bb464677	413	sub insert {
64c012f4	414	my ($self, $rs, $set) = @_;
bb464677	415
	416	$rs \|\|= $self->resultset();
	417	$set \|\|= $self->set();
64c012f4	418	my $resultset = $self->schema->resultset($rs);
9f3849c3	419	my $obj = $resultset->create( $set );
595cb2c7	420	print ''.ref($resultset).' ID: '.join(',',$obj->id())."\n" if (!$self->quiet);
9f3849c3	421	}
9f3849c3	422
595cb2c7	423
bb464677	424	=head2 update
595cb2c7	425
	426	=over 4
	427
	428	=item Arguments: $rs, $set, $where
	429
	430	=back
	431
bb464677	432	update takes the name of a resultset from the schema_class, a hashref of data to update and
595cb2c7	433	a where hash used to form the search for the rows to update.
595cb2c7	434	=cut
bb464677	435	sub update {
882931aa	436	my ($self, $rs, $set, $where) = @_;
882931aa	437
bb464677	438	$rs \|\|= $self->resultset();
	439	$where \|\|= $self->where();
	440	$set \|\|= $self->set();
882931aa	441	my $resultset = $self->schema->resultset($rs);
	442	$resultset = $resultset->search( ($where\|\|{}) );
	443
	444	my $count = $resultset->count();
	445	print "This action will modify $count ".ref($resultset)." records.\n" if (!$self->quiet);
	446
595cb2c7	447	if ( $self->force \|\| $self->_confirm() ) {
882931aa	448	$resultset->update_all( $set );
882931aa	449	}
9f3849c3	450	}
	451
	452	# FIXME
	453	#die('Do not use the set option with the delete op') if ($set);
bb464677	454	=head2 delete
595cb2c7	455
	456	=over 4
	457
	458	=item Arguments: $rs, $where, $attrs
	459
	460	=back
	461
bb464677	462	delete takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
595cb2c7	463	The found data is deleted and cannot be recovered.
595cb2c7	464	=cut
bb464677	465	sub delete {
882931aa	466	my ($self, $rs, $where, $attrs) = @_;
9f3849c3	467
bb464677	468	$rs \|\|= $self->resultset();
	469	$where \|\|= $self->where();
	470	$attrs \|\|= $self->attrs();
882931aa	471	my $resultset = $self->schema->resultset($rs);
882931aa	472	$resultset = $resultset->search( ($where\|\|{}), ($attrs\|\|()) );
9f3849c3	473
882931aa	474	my $count = $resultset->count();
882931aa	475	print "This action will delete $count ".ref($resultset)." records.\n" if (!$self->quiet);
9f3849c3	476
595cb2c7	477	if ( $self->force \|\| $self->_confirm() ) {
882931aa	478	$resultset->delete_all();
882931aa	479	}
9f3849c3	480	}
9f3849c3	481
bb464677	482	=head2 select
595cb2c7	483
	484	=over 4
	485
	486	=item Arguments: $rs, $where, $attrs
	487
	488	=back
	489
bb464677	490	select takes the name of a resultset from the schema_class, a where hashref and a attrs to pass to ->search.
595cb2c7	491	The found data is returned in a array ref where the first row will be the columns list.
	492
	493	=cut
bb464677	494	sub select {
882931aa	495	my ($self, $rs, $where, $attrs) = @_;
882931aa	496
bb464677	497	$rs \|\|= $self->resultset();
	498	$where \|\|= $self->where();
	499	$attrs \|\|= $self->attrs();
882931aa	500	my $resultset = $self->schema->resultset($rs);
	501	$resultset = $resultset->search( ($where\|\|{}), ($attrs\|\|()) );
	502
	503	my @data;
	504	my @columns = $resultset->result_source->columns();
	505	push @data, [@columns];#
	506
	507	while (my $row = $resultset->next()) {
	508	my @fields;
	509	foreach my $column (@columns) {
	510	push( @fields, $row->get_column($column) );
	511	}
	512	push @data, [@fields];
9f3849c3	513	}
9f3849c3	514
882931aa	515	return \@data;
9f3849c3	516	}
9f3849c3	517
595cb2c7	518	sub _confirm {
882931aa	519	my ($self) = @_;
64c012f4	520	print "Are you sure you want to do this? (type YES to confirm) \n";
912e2d5a	521	# mainly here for testing
595cb2c7	522	return 1 if ($self->meta->get_attribute('_confirm')->get_value($self));
912e2d5a	523	my $response = <STDIN>;
882931aa	524	return 1 if ($response=~/^YES/);
882931aa	525	return;
9f3849c3	526	}
9f3849c3	527
595cb2c7	528	sub _find_stanza {
	529	my ($self, $cfg, $stanza) = @_;
	530	my @path = split /::/, $stanza;
	531	while (my $path = shift @path) {
	532	if (exists $cfg->{$path}) {
	533	$cfg = $cfg->{$path};
	534	}
	535	else {
	536	die "could not find $stanza in config, $path did not seem to exist";
	537	}
	538	}
	539	return $cfg;
	540	}
bb464677	541
	542	sub _json_to_data {
	543	my ($json_str) = @_;
	544	my $json = JSON::Any->new(allow_barekey => 1, allow_singlequote => 1, relaxed=>1);
	545	my $ret = $json->jsonToObj($json_str);
	546	return $ret;
	547	}
	548
417e1784	549
	550	{ # deps check
	551
	552	my @_missing_deps;
	553	foreach my $dep (@_deps) {
	554	eval "require $dep";
	555	if ($@) {
	556	push @_missing_deps, $dep;
	557	}
	558	}
	559
	560	if (@_missing_deps > 0) {
	561	die "The following dependecies are missing " . join ",", @_missing_deps;
	562	}
	563
	564
	565	}
bb464677	566	=head1 AUTHOR
	567
	568	Gordon Irving <goraxe@cpan.org>
	569
	570	with code taken from dbicadmin by
	571	Aran Deltac <bluefeet@cpan.org>
	572
	573
	574	=head1 LICENSE
	575
	576	You may distribute this code under the same terms as Perl itself.
	577	=cut
9f3849c3	578	1;