lib/DBIx/Class.pm

   1 package DBIx::Class;
   2
   3 use strict;
   4 use warnings;
   5
   6 use vars qw($VERSION);
   7 use base qw/DBIx::Class::Componentised Class::Data::Accessor/;
   8
   9 sub mk_classdata { shift->mk_classaccessor(@_); }
  10
  11 $VERSION = '0.04999_01';
  12
  13 1;
  14
  15 =head1 NAME
  16
  17 DBIx::Class - Extensible and flexible object <-> relational mapper.
  18
  19 =head1 SYNOPSIS
  20
  21 =head1 DESCRIPTION
  22
  23 This is an SQL to OO mapper, inspired by the L<Class::DBI> framework,
  24 and meant to support compability with it, while restructuring the
  25 internals and making it possible to support some new features like
  26 self-joins, distinct, group bys and more.
  27
  28 This project is still at an early stage, so the maintainers don't make
  29 any absolute promise that full backwards-compatibility will be supported;
  30 however, if we can without compromising the improvements we're trying to
  31 make, we will, and any non-compatible changes will merit a full justification
  32 on the mailing list and a CPAN developer release for people to test against.
  33
  34 The community can be found via -
  35
  36   Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/
  37
  38   SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/
  39
  40   Wiki: http://dbix-class.shadowcatsystems.co.uk/
  41
  42   IRC: irc.perl.org#dbix-class
  43
  44 =head1 QUICKSTART
  45
  46 If you're using L<Class::DBI>, and want an easy and fast way of migrating to
  47 DBIx::Class, take a look at L<DBIx::Class::CDBICompat>.
  48
  49 There are two ways of using DBIx::Class, the "simple" way and the "schema" way.
  50 The "simple" way of using DBIx::Class needs less classes than the "schema"
  51 way but doesn't give you the ability to easily use different database connections.
  52
  53 Some examples where different database connections are useful are:
  54
  55 different users with different rights
  56 different databases with the same schema.
  57
  58 =head2 Simple
  59
  60 First you need to create a base class which all other classes will inherit from.
  61 See L<DBIx::Class::DB> for information on how to do this.
  62
  63 Then you need to create a class for every table you want to use with DBIx::Class.
  64 See L<DBIx::Class::Table> for information on how to do this.
  65
  66 =head2 Schema
  67
  68 With this approach, the table classes inherit directly from DBIx::Class::Core,
  69 although it might be a good idea to create a "parent" class for all table
  70 classes that inherits from DBIx::Class::Core and adds additional methods
  71 needed by all table classes, e.g. reading a config file or loading auto primary
  72 key support.
  73
  74 Look at L<DBIx::Class::Schema> for information on how to do this.
  75
  76 If you need more help, check out the introduction in the
  77 manual below.
  78
  79 =head1 SEE ALSO
  80
  81 =head2 L<DBIx::Class::Core> - DBIC Core Classes
  82
  83 =head2 L<DBIx::Class::Manual> - User's manual
  84
  85 =head2 L<DBIx::Class::CDBICompat> - L<Class::DBI> Compat layer
  86
  87 =head2 L<DBIx::Class::DB> - database-level methods
  88
  89 =head2 L<DBIx::Class::Table> - table-level methods
  90
  91 =head2 L<DBIx::Class::Row> - row-level methods
  92
  93 =head2 L<DBIx::Class::PK> - primary key methods
  94
  95 =head2 L<DBIx::Class::ResultSet> - search result-set methods
  96
  97 =head2 L<DBIx::Class::Relationship> - relationships between tables
  98
  99 =head1 AUTHOR
 100
 101 Matt S. Trout <mst@shadowcatsystems.co.uk>
 102
 103 =head1 CONTRIBUTORS
 104
 105 Andy Grundman <andy@hybridized.org>
 106
 107 Brian Cassidy <bricas@cpan.org>
 108
 109 Dan Kubb <dan.kubb-cpan@onautopilot.com>
 110
 111 Dan Sully <daniel@cpan.org>
 112
 113 David Kamholz <dkamholz@cpan.org>
 114
 115 Jules Bean
 116
 117 Marcus Ramberg <mramberg@cpan.org>
 118
 119 Paul Makepeace
 120
 121 =head1 LICENSE
 122
 123 You may distribute this code under the same terms as Perl itself.
 124
 125 =cut
 126