package Catalyst::Model::DBIC::Schema;
-use 5.008_001;
use Moose;
use mro 'c3';
extends 'Catalyst::Model';
with 'CatalystX::Component::Traits';
-our $VERSION = '0.33';
+our $VERSION = '0.58';
$VERSION = eval $VERSION;
use namespace::autoclean;
use DBIx::Class ();
use Catalyst::Model::DBIC::Schema::Types
- qw/ConnectInfo LoadedClass SchemaClass/;
+ qw/ConnectInfo LoadedClass SchemaClass Schema/;
use MooseX::Types::Moose qw/ArrayRef Str ClassName Undef/;
script/myapp_create.pl model FilmDB DBIC::Schema MyApp::Schema::FilmDB \
create=static dbi:mysql:filmdb dbusername dbpass \
- quote_char='`' name_sep='.'
+ quote_names=1
If you are unfamiliar with L<DBIx::Class>, see L<DBIx::Class::Manual::Intro>
first.
my $db_model = $c->model('FilmDB'); # a Catalyst::Model
my $dbic = $c->model('FilmDB')->schema; # the actual DBIC object
-The Model proxies to the C<Schema> instance so you can do:
-
- my $rs = $db_model->resultset('Actor'); # ... or ...
- my $rs = $dbic ->resultset('Actor'); # same!
-
There is also a shortcut, which returns a L<DBIx::Class::ResultSet> directly,
instead of a L<Catalyst::Model>:
to your DBIC Schema. It should be clearly noted that the model object returned
by C<< $c->model('FilmDB') >> is NOT itself a DBIC schema or resultset object,
but merely a wrapper proving L<methods|/METHODS> to access the underlying
-schema (but also proxies other methods to the underlying schema.)
+schema.
In addition to this model class, a shortcut class is generated for each
source in the schema, allowing easy and direct access to a resultset of the
=head1 CONFIG PARAMETERS
-Any options in your config not listed here are passed to your schema.
-
=head2 schema_class
This is the classname of your L<DBIx::Class::Schema> Schema. It needs
=head2 connect_info
-This is an arrayref of connection parameters, which are specific to your
-C<storage_type> (see your storage type documentation for more details).
-If you only need one parameter (e.g. the DSN), you can just pass a string
-instead of an arrayref.
+This is a hashref or arrayref of connection parameters, which are specific to
+your C<storage_type> (see your storage type documentation for more details). If
+you only need one parameter (e.g. the DSN), you can just pass a string.
This is not required if C<schema_class> already has connection information
-defined inside itself (which isn't highly recommended, but can be done)
+defined inside itself (which isn't highly recommended, but can be done.)
For L<DBIx::Class::Storage::DBI>, which is the only supported
C<storage_type> in L<DBIx::Class> at the time of this writing, the
user postgres
password ""
auto_savepoint 1
- quote_char """
+ quote_names 1
on_connect_do some SQL statement
on_connect_do another SQL statement
</connect_info>
LongReadLen: 1000000
LongTruncOk: 1
on_connect_call: 'datetime_setup'
- quote_char: '"'
+ quote_names: 1
The old arrayref style with hashrefs for L<DBI> then L<DBIx::Class> options is also
supported:
Array of Traits to apply to the instance. Traits are L<Moose::Role>s.
-They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then the C<<
-Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless prefixed with C<+>
-in which case they are taken to be a fully qualified name. E.g.:
+They are relative to the C<< MyApp::TraitFor::Model::DBIC::Schema:: >>, then
+the C<< Catalyst::TraitFor::Model::DBIC::Schema:: >> namespaces, unless
+prefixed with C<+> in which case they are taken to be a fully qualified name.
+E.g.:
traits Caching
traits +MyApp::TraitFor::Model::Foo
=item L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>
+
+=item L<Catalyst::TraitFor::Model::DBIC::Schema::PerRequestSchema>
+
=back
=head2 storage_type
Traits you used resolved to full class names.
-=head1 METHODS
-
-Methods not listed here are delegated to the connected schema used by the model
-instance, so the following are equivalent:
+=head1 CONFIGURING YOUR SCHEMA AND RESULTSETS
- $c->model('DB')->schema->my_accessor('foo');
- # or
- $c->model('DB')->my_accessor('foo');
+See the documentation for
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy> for instructions on how
+to pass config values from your L<Catalyst> config to your
+L<DBIx::Class::Schema> and/or L<DBIx::Class::ResultSet> classes.
-Methods on the model take precedence over schema methods.
+=head1 METHODS
=head2 new
Shortcut for ->schema->resultset
+=head2 txn_do
+
+Shortcut for ->schema->txn_do
+
+=head2 txn_scope_guard
+
+Shortcut for ->schema->txn_scope_guard
+
=head2 storage
Provides an accessor for the connected schema's storage object.
-Used often for debugging and controlling transactions.
+
+See L<DBIx::Class::Storage> and L<DBIx::Class::Storage::DBI>.
=cut
coerce => 1
);
+has schema => (is => 'rw', isa => Schema);
+
+my $app_class;
+
+before COMPONENT => sub {
+ $app_class = ref $_[1] || $_[1];
+};
+
+sub app_class { $app_class }
+
sub BUILD {
my ($self, $args) = @_;
my $class = $self->_original_class_name;
die "Either ->config->{connect_info} must be defined for $class"
. " or $schema_class must have connect info defined on it."
. " Here's what we got:\n"
- . Dumper($self);
+ . Dumper($args);
}
}
. " ".$self->connect_info->{cursor_class}.": $@";
}
- $self->setup;
-
- $self->composed_schema($schema_class->compose_namespace($class));
+ $self->setup($args);
- my $was_mutable = $self->meta->is_mutable;
+ my $is_installed = defined $self->composed_schema;
- $self->meta->make_mutable;
- $self->meta->add_attribute('schema',
- is => 'rw',
- isa => 'DBIx::Class::Schema',
- handles => $self->_delegates
- );
- $self->meta->make_immutable unless $was_mutable;
+ $self->composed_schema($schema_class->compose_namespace($class))
+ unless $is_installed;
- $self->schema($self->composed_schema->clone);
-
- $self->_pass_options_to_schema($args);
+ $self->schema($self->composed_schema->clone)
+ unless $self->schema;
$self->schema->storage_type($self->storage_type)
if $self->storage_type;
$self->schema->connection($self->connect_info);
- $self->_install_rs_models;
+ $self->_install_rs_models unless $is_installed;
}
sub clone { shift->composed_schema->clone(@_); }
sub connect { shift->composed_schema->connect(@_); }
+# some proxy methods, see also SchemaProxy
+
+sub resultset { shift->schema->resultset(@_); }
+
+sub txn_do { shift->schema->txn_do(@_); }
+
+sub txn_scope_guard { shift->schema->txn_scope_guard(@_); }
+
+sub storage { shift->schema->storage(@_); }
+
=head2 setup
Called at C<BUILD> time before configuration, but after L</connect_info> is
set. To do something after configuuration use C<< after BUILD => >>.
+Receives a hashref of args passed to C<BUILD>.
+
=cut
sub setup { 1 }
return $model_name;
}
-sub _delegates {
- my $self = shift;
-
- my $schema_meta = Class::MOP::Class->initialize($self->schema_class);
- my @schema_methods = $schema_meta->get_all_method_names;
-
-# combine with any already added by other schemas
- my @handles = eval {
- @{ $self->meta->find_attribute_by_name('schema')->handles }
- };
-
-# now kill the attribute, otherwise add_attribute in BUILD will not do the right
-# thing (it clears the handles for some reason.) May be a Moose bug.
- eval { $self->meta->remove_attribute('schema') };
-
- my %schema_methods;
- @schema_methods{ @schema_methods, @handles } = ();
- @schema_methods = keys %schema_methods;
-
- my @my_methods = $self->meta->get_all_method_names;
- my %my_methods;
- @my_methods{@my_methods} = ();
-
- my @delegates;
- for my $method (@schema_methods) {
- push @delegates, $method unless exists $my_methods{$method};
- }
-
- return \@delegates;
-}
-
-sub _pass_options_to_schema {
- my ($self, $args) = @_;
-
- my @attributes = map {
- $_->init_arg || ()
- } $self->meta->get_all_attributes;
-
- my %attributes;
- @attributes{@attributes} = ();
-
- for my $opt (keys %$args) {
- if (not exists $attributes{$opt}) {
- next unless $self->schema->can($opt);
- $self->schema->$opt($self->{$opt});
- }
- }
-}
-
__PACKAGE__->meta->make_immutable;
=head1 ENVIRONMENT
}
});
+=head1 METHOD PROXYING
+
+The automatic proxying to the underlying L<DBIx::Class::Schema> has been
+removed as of version C<0.34>, to enable this feature add C<SchemaProxy> to
+L</traits>.
+
+See L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>.
+
=head1 SEE ALSO
General Catalyst Stuff:
L<Catalyst::TraitFor::Model::DBIC::Schema::Caching>,
L<Catalyst::TraitFor::Model::DBIC::Schema::Replicated>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::SchemaProxy>,
+L<Catalyst::TraitFor::Model::DBIC::Schema::PerRequestSchema>,
L<Catalyst::TraitFor::Model::DBIC::Schema::QueryLog>
=head1 AUTHOR
Pavel I. Shaydo C<zwon@trinitum.org>
+t0m: Tomas Doran <bobtfish@bobtfish.net>
+
=head1 COPYRIGHT
-Copyright (c) 2006 - 2009
+Copyright (c) 2006 - 2010
the Catalyst::Model::DBIC::Schema L</AUTHOR> and L</CONTRIBUTORS>
as listed above.
=cut
1;
-# vim:sts=4 sw=4 et:
+# vim:sts=4 sw=4 et tw=80:
projects / catagits/Catalyst-Model-DBIC-Schema.git / blobdiff