[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 Data::Dumper;
use JSON::Any;


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

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