X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FSchema.pm;h=b2c977555c07652359876e5f2e1c2589fb46f1f1;hb=3b042bcbab344e8d94620d0d13360a605559f8b5;hp=59fca811691ae154f64db18c384155a9993a0108;hpb=5160b40103b81efb28aeb46c61a0d071c636a923;p=dbsrgits%2FDBIx-Class-Historic.git diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 59fca81..b2c9775 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -29,6 +29,7 @@ DBIx::Class::Schema - composable schemas __PACKAGE__->load_components(qw/PK::Auto::Pg Core/); # for example __PACKAGE__->table('foo'); + # Elsewhere in your code: my $schema1 = My::Schema->connect( $dsn, $user, @@ -54,7 +55,9 @@ particular which module inherits off which. =head1 METHODS -=head2 register_class +=head2 register_class + +=head3 Arguments: Registers a class which isa ResultSourceProxy; equivalent to calling @@ -67,7 +70,9 @@ sub register_class { $self->register_source($moniker => $to_register->result_source_instance); } -=head2 register_source +=head2 register_source + +=head3 Arguments: Registers the result source in the schema with the given moniker @@ -142,7 +147,9 @@ sub resultset { return $self->source($moniker)->resultset; } -=head2 load_classes [, (, ), { => []}] +=head2 load_classes + +=head3 Arguments: [, (, ), { => []}] Uses L to find all classes under the database class' namespace, or uses the classes you select. Then it loads the component (using L), @@ -202,7 +209,9 @@ sub load_classes { } } -=head2 compose_connection <@db_info> +=head2 compose_connection + +=head3 Arguments: <@db_info> This is the most important method in this class. it takes a target namespace, as well as dbh connection info, and creates a L class as @@ -247,6 +256,11 @@ sub compose_connection { } my $schema = $self->compose_namespace($target, $base); + { + no strict 'refs'; + *{"${target}::schema"} = sub { $schema }; + } + $schema->connection(@info); foreach my $moniker ($schema->sources) { my $source = $schema->source($moniker); @@ -275,8 +289,6 @@ sub compose_namespace { } { no strict 'refs'; - *{"${target}::schema"} = - sub { $schema }; foreach my $meth (qw/class source resultset/) { *{"${target}::${meth}"} = sub { shift->schema->$meth(@_) }; @@ -285,7 +297,9 @@ sub compose_namespace { return $schema; } -=head2 setup_connection_class <$target> <@info> +=head2 setup_connection_class + +=head3 Arguments: <$target> <@info> Sets up a database connection class to inject between the schema and the subclasses the schema creates. @@ -299,7 +313,9 @@ sub setup_connection_class { $target->connection(@info); } -=head2 connection(@args) +=head2 connection + +=head3 Arguments: (@args) Instantiates a new Storage object of type storage_type and passes the arguments to $storage->connect_info. Sets the connection in-place on @@ -321,13 +337,39 @@ sub connection { return $self; } -=head2 connect(@info) +=head2 connect + +=head3 Arguments: (@info) Conveneience method, equivalent to $schema->clone->connection(@info) =cut -sub connect { shift->clone->connection(@_) }; +sub connect { shift->clone->connection(@_) } + +=head2 txn_begin + +Begins a transaction (does nothing if AutoCommit is off). + +=cut + +sub txn_begin { shift->storage->txn_begin } + +=head2 txn_commit + +Commits the current transaction. + +=cut + +sub txn_commit { shift->storage->txn_commit } + +=head2 txn_rollback + +Rolls back the current transaction. + +=cut + +sub txn_rollback { shift->storage->txn_rollback } =head2 clone @@ -347,7 +389,9 @@ sub clone { return $clone; } -=head2 populate($moniker, \@data); +=head2 populate + +=head3 Arguments: ($moniker, \@data); Populates the source registered with the given moniker with the supplied data. @data should be a list of listrefs, the first containing column names, the @@ -384,6 +428,18 @@ sub throw_exception { croak @_; } +=head2 deploy + +Attempts to deploy the schema to the current storage + +=cut + +sub deploy { + my ($self) = shift; + $self->throw_exception("Can't deploy without storage") unless $self->storage; + $self->storage->deploy($self); +} + 1; =head1 AUTHORS