1 package DBIx::Class::CDBICompat;
5 use base qw/DBIx::Class::Core DBIx::Class::DB/;
7 unless (DBIx::Class::Optional::Dependencies->req_ok_for('cdbicompat')) {
8 __PACKAGE__->throw_exception(Class::Optional::Dependencies->req_missing_for('cdbicompat') . ' are missing and are required for CDBICompat');
11 __PACKAGE__->load_own_components(qw/
43 DBIx::Class::CDBICompat - Class::DBI Compatibility layer.
48 use base qw/DBIx::Class::CDBICompat/;
50 ...continue as Class::DBI...
54 DBIx::Class features a fully featured compatibility layer with L<Class::DBI>
55 and some common plugins to ease transition for existing CDBI users.
57 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.
62 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.
64 =head3 Class::DBI::AbstractSearch
66 C<search_where()> is fully emulated using DBIC's search. Aside from emulation there's no reason to use C<search_where()>.
68 =head3 Class::DBI::Plugin::NoCache
70 C<nocache> is fully emulated.
72 =head3 Class::DBI::Sweet
74 The features of CDBI::Sweet are better done using DBIC methods which are almost exactly the same. It even uses L<Data::Page>.
76 =head3 Class::DBI::Plugin::DeepAbstractSearch
78 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.
81 =head2 Choosing Features
83 In fact, this class is just a recipe containing all the features emulated.
84 If you like, you can choose which features to emulate by building your
85 own class and loading it like this:
88 __PACKAGE__->load_own_components(qw/CDBICompat/);
90 this will automatically load the features included in My::DB::CDBICompat,
91 provided it looks something like this:
93 package My::DB::CDBICompat;
94 __PACKAGE__->load_components(qw/
95 CDBICompat::ColumnGroups
107 The following methods and classes are not emulated, maybe in the future.
111 =item Class::DBI::Query
113 Deprecated in Class::DBI.
115 =item Class::DBI::Column
117 Not documented in Class::DBI. CDBICompat's columns() returns a plain string, not an object.
121 Undocumented CDBI method.
125 =head2 Limited Support
127 The following elements of Class::DBI have limited support.
131 =item Class::DBI::Relationship
133 The semi-documented Class::DBI::Relationship objects returned by C<meta_info($type, $col)> are mostly emulated except for their C<args> method.
137 Relationships between tables (has_a, has_many...) must be declared after all tables in the relationship have been declared. Thus the usual CDBI idiom of declaring columns and relationships for each class together will not work. They must instead be done like so:
140 use base qw(Class::DBI);
143 Foo->columns( All => qw(this that bar) );
146 use base qw(Class::DBI);
149 Bar->columns( All => qw(up down) );
151 # Now that Foo and Bar are declared it is safe to declare a
152 # relationship between them
153 Foo->has_a( bar => "Bar" );
158 =head1 FURTHER QUESTIONS?
160 Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
162 =head1 COPYRIGHT AND LICENSE
164 This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
165 by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
166 redistribute it and/or modify it under the same terms as the
167 L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.