Skip to content

Commit

Permalink
Clean up of "DBIx::Class" references to "DBIC"
Browse files Browse the repository at this point in the history
  • Loading branch information
SineSwiper committed Mar 14, 2013
1 parent 7b35a32 commit 784b08b
Show file tree
Hide file tree
Showing 44 changed files with 240 additions and 229 deletions.
8 changes: 4 additions & 4 deletions lib/DBIx/Class.pm
Original file line number Diff line number Diff line change
Expand Up @@ -265,15 +265,15 @@ Then you can use these classes in your application's code:
=head1 DESCRIPTION
This is an SQL to OO mapper with an object API inspired by L<Class::DBI>
DBIx::Class (aka DBIC) is an SQL to OO mapper with an object API inspired by L<Class::DBI>
(with a compatibility layer as a springboard for porting) and a resultset API
that allows abstract encapsulation of database operations. It aims to make
representing queries in your code as perl-ish as possible while still
providing access to as many of the capabilities of the database as possible,
including retrieving related records from multiple tables in a single query,
JOIN, LEFT JOIN, COUNT, DISTINCT, GROUP BY, ORDER BY and HAVING support.
DBIx::Class can handle multi-column primary and foreign keys, complex
DBIC can handle multi-column primary and foreign keys, complex
queries and database-level paging, and does its best to only query the
database in order to return something you've directly asked for. If a
resultset is used as an iterator it only fetches rows off the statement
Expand All @@ -289,7 +289,7 @@ Failing test cases are *always* welcome and point releases are put out rapidly
as bugs are found and fixed.
We do our best to maintain full backwards compatibility for published
APIs, since DBIx::Class is used in production in many organisations,
APIs, since DBIC is used in production in many organisations,
and even backwards incompatible changes to non-published APIs will be fixed
if they're reported and doing so doesn't cost the codebase anything.
Expand Down Expand Up @@ -556,7 +556,7 @@ zamolxes: Bogdan Lucaciu <bogdan@wiz.ro>
=head1 COPYRIGHT
Copyright (c) 2005 - 2011 the DBIx::Class L</AUTHOR> and L</CONTRIBUTORS>
Copyright (c) 2005 - 2012 the DBIC L</AUTHOR> and L</CONTRIBUTORS>
as listed above.
=head1 LICENSE
Expand Down
10 changes: 5 additions & 5 deletions lib/DBIx/Class/Admin.pm
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ DBIx::Class::Admin - Administration object for schemas
=head1 REQUIREMENTS
The Admin interface has additional requirements not currently part of
L<DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
L<DBIC|DBIx::Class>. See L<DBIx::Class::Optional::Dependencies> for more details.
=head1 ATTRIBUTES
Expand Down Expand Up @@ -297,7 +297,7 @@ has '_confirm' => (

=head2 trace
Toggle DBIx::Class debug output
Toggle L<DBIC|DBIx::Class> debug output
=cut

Expand Down Expand Up @@ -583,13 +583,13 @@ sub _find_stanza {
return $cfg;
}

=head1 AUTHOR
=head1 AUTHOR AND CONTRIBUTORS
See L<DBIx::Class/CONTRIBUTORS>.
See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
=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

Expand Down
15 changes: 9 additions & 6 deletions lib/DBIx/Class/CDBICompat.pm
Original file line number Diff line number Diff line change
Expand Up @@ -61,31 +61,34 @@ DBIx::Class::CDBICompat - Class::DBI Compatibility layer.
=head1 DESCRIPTION
DBIx::Class features a fully featured compatibility layer with L<Class::DBI>
L<DBIC|DBIx::Class> features a fully featured compatibility layer with L<Class::DBI>
and some common plugins to ease transition for existing CDBI users.
This is not a wrapper or subclass of DBIx::Class but rather a series of plugins. The result being that even though you're using the Class::DBI emulation layer you are still getting DBIx::Class objects. You can use all DBIx::Class features and methods via CDBICompat. This allows you to take advantage of DBIx::Class features without having to rewrite your CDBI code.
This is not a wrapper or subclass of L<DBIC|DBIx::Class> but rather a series of plugins. The result being that even though you're using the
L<CDBI|Class::DBI> emulation layer you are still getting L<DBIC|DBIx::Class> objects. You can use all L<DBIC|DBIx::Class> features and methods
via CDBICompat. This allows you to take advantage of L<DBIC|DBIx::Class> features without having to rewrite your L<CDBI|Class::DBI> code.
=head2 Plugins
CDBICompat is good enough that many CDBI plugins will work with CDBICompat, but many of the plugin features are better done with DBIx::Class methods.
CDBICompat is good enough that many CDBI plugins will work with CDBICompat, but many of the plugin features are better done with L<DBIC|DBIx::Class> methods.
=head3 Class::DBI::AbstractSearch
C<search_where()> is fully emulated using DBIC's search. Aside from emulation there's no reason to use C<search_where()>.
C<search_where()> is fully emulated using L<DBIC|DBIx::Class>'s search. Aside from emulation there's no reason to use C<search_where()>.
=head3 Class::DBI::Plugin::NoCache
C<nocache> is fully emulated.
=head3 Class::DBI::Sweet
The features of CDBI::Sweet are better done using DBIC methods which are almost exactly the same. It even uses L<Data::Page>.
The features of CDBI::Sweet are better done using L<DBIC|DBIx::Class> methods which are almost exactly the same. It even uses L<Data::Page>.
=head3 Class::DBI::Plugin::DeepAbstractSearch
This plugin will work, but it is more efficiently done using DBIC's native search facilities. The major difference is that DBIC will not infer the join for you, you have to tell it the join tables.
This plugin will work, but it is more efficiently done using L<DBIC|DBIx::Class>'s native search facilities. The major difference is that
L<DBIC|DBIx::Class> will not infer the join for you, you have to tell it the join tables.
=head2 Choosing Features
Expand Down
2 changes: 1 addition & 1 deletion lib/DBIx/Class/CDBICompat/Iterator.pm
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ See DBIx::Class::CDBICompat for usage directions.
Emulates the extra behaviors of the Class::DBI search iterator.
=head2 Differences from DBIx::Class result set
=head2 Differences from DBIC result set
The CDBI iterator returns true if there were any results, false otherwise. The DBIC result set always returns true.
Expand Down
2 changes: 1 addition & 1 deletion lib/DBIx/Class/Carp.pm
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ sub unimport {

=head1 NAME
DBIx::Class::Carp - Provides advanced Carp::Clan-like warning functions for DBIx::Class internals
DBIx::Class::Carp - Provides advanced Carp::Clan-like warning functions for DBIC internals
=head1 DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions lib/DBIx/Class/Core.pm
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ __PACKAGE__->load_components(qw/

=head1 NAME
DBIx::Class::Core - Core set of DBIx::Class modules
DBIx::Class::Core - Core set of DBIC modules
=head1 SYNOPSIS
Expand All @@ -28,7 +28,7 @@ DBIx::Class::Core - Core set of DBIx::Class modules
=head1 DESCRIPTION
This class just inherits from the various modules that make up the
L<DBIx::Class> core features. You almost certainly want these.
L<DBIC|DBIx::Class> core features. You almost certainly want these.
The core modules currently are:
Expand Down
2 changes: 1 addition & 1 deletion lib/DBIx/Class/Exception.pm
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ overload fallback to give natural boolean/numeric values.
=back
This is meant for internal use by L<DBIx::Class>'s C<throw_exception>
This is meant for internal use by L<DBIC|DBIx::Class>'s C<throw_exception>
code, and shouldn't be used directly elsewhere.
Expects a scalar exception message. The optional argument
Expand Down
4 changes: 2 additions & 2 deletions lib/DBIx/Class/InflateColumn.pm
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ something else, see L<DBIx::Class::FilterColumn>.
=head2 inflate_column
Instruct L<DBIx::Class> to inflate the given column.
Instruct L<DBIC|DBIx::Class> to inflate the given column.
In addition to the column name, you must provide C<inflate> and
C<deflate> methods. The C<inflate> method is called when you access
Expand Down Expand Up @@ -196,7 +196,7 @@ sub store_inflated_column {
=over 4
=item L<DBIx::Class::Core> - This component is loaded as part of the
C<core> L<DBIx::Class> components; generally there is no need to
C<core> L<DBIC|DBIx::Class> components; generally there is no need to
load it directly
=back
Expand Down
2 changes: 1 addition & 1 deletion lib/DBIx/Class/InflateColumn/File.pm
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ DBIx::Class::InflateColumn::File - DEPRECATED (superseded by DBIx::Class::Infla
=head1 SYNOPSIS
In your L<DBIx::Class> table class:
In your L<DBIC|DBIx::Class> table class:
use base 'DBIx::Class::Core';
Expand Down
6 changes: 3 additions & 3 deletions lib/DBIx/Class/Manual.pod
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ DBIx::Class::Manual - Index of the Manual

=head1 DESCRIPTION

This is the L<DBIx::Class> users manual. DBIx::Class is a SQL->OOP mapper.
This means that it can represent your SQL tables as perl classes, and give
you convenient accessors and methods for retrieving and updating information
This is the L<DBIC|DBIx::Class> users manual. L<DBIC|DBIx::Class> is a SQL->OOP
mapper. This means that it can represent your SQL tables as perl classes, and
give you convenient accessors and methods for retrieving and updating information
from your SQL database.

=head1 SECTIONS
Expand Down
12 changes: 6 additions & 6 deletions lib/DBIx/Class/Manual/Component.pod
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@

=head1 NAME

DBIx::Class::Manual::Component - Developing DBIx::Class Components
DBIx::Class::Manual::Component - Developing DBIC Components

=head1 WHAT IS A COMPONENT

A component is a module that can be added in to your DBIx::Class
A component is a module that can be added in to your L<DBIC|DBIx::Class>
classes to provide extra functionality. A good example is the PK::Auto
component which automatically retrieves primary keys that the database
itself creates, after the insert has happened.

=head1 USING

Components are loaded using the load_components() method within your
DBIx::Class classes.
L<DBIC|DBIx::Class> classes.

package My::Thing;
use base qw( DBIx::Class::Core );
__PACKAGE__->load_components(qw/InflateColumn::DateTime TimeStamp/);

Generally you do not want to specify the full package name
of a component, instead take off the DBIx::Class:: part of
of a component, instead take off the C<DBIx::Class::> part of
it and just include the rest. If you do want to load a
component outside of the normal namespace you can do so
by prepending the component name with a +.
Expand Down Expand Up @@ -132,6 +132,6 @@ L<DBIx::Class::Row> - Basic row methods.

L<DBIx::Class::Manual::Cookbook>

=head1 AUTHOR
=head1 AUTHOR AND CONTRIBUTORS

Aran Clary Deltac <bluefeet@cpan.org>
See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
Loading

0 comments on commit 784b08b

Please sign in to comment.