lib/DBIx/Class/CDBICompat.pm

   1 package DBIx::Class::CDBICompat;
   2
   3 use strict;
   4 use warnings;
   5 use base qw/DBIx::Class/;
   6
   7 __PACKAGE__->load_own_components(qw/
   8   Constraints
   9   Triggers
  10   ReadOnly
  11   GetSet
  12   LiveObjectIndex
  13   AttributeAPI
  14   Stringify
  15   DestroyWarning
  16   Constructor
  17   AccessorMapping
  18   ColumnCase
  19   HasMany
  20   HasA
  21   MightHave
  22   LazyLoading
  23   AutoUpdate
  24   TempColumns
  25   Retrieve
  26   Pager
  27   ColumnGroups
  28   ImaDBI/);
  29
  30             #DBIx::Class::ObjIndexStubs
  31 1;
  32
  33 =head1 NAME
  34
  35 DBIx::Class::CDBICompat - Class::DBI Compatability layer.
  36
  37 =head1 SYNOPSIS
  38
  39   use base qw/DBIx::Class/;
  40   __PACKAGE__->load_components(qw/CDBICompat Core DB/);
  41
  42 =head1 DESCRIPTION
  43
  44 DBIx::Class features a fully featured compability layer with L<Class::DBI>
  45 to ease transition for existing CDBI users. In fact, this class is just a
  46 receipe containing all the features emulated. If you like, you can choose
  47 which features to emulate by building your own class and loading it like
  48 this:
  49
  50   __PACKAGE__->load_own_components(qw/CDBICompat/);
  51
  52 this will automatically load the features included in My::DB::CDBICompat,
  53 provided it looks something like this:
  54
  55   package My::DB::CDBICompat;
  56   __PACKAGE__->load_components(qw/
  57     CDBICompat::ColumnGroups
  58     CDBICompat::Retrieve
  59     CDBICompat::HasA
  60     CDBICompat::HasMany
  61     CDBICompat::MightHave
  62   /);
  63
  64 =head1 Components
  65
  66 =over 4
  67
  68 =item AccessorMapping
  69
  70 =item AttributeAPI
  71
  72 =item AutoUpdate
  73
  74 Allows you to turn on automatic updates for column values.
  75
  76 =item ColumnCase
  77
  78 =item ColumnGroups
  79
  80 =item Constraints
  81
  82 =item Constructor
  83
  84 =item DestroyWarning
  85
  86 =item GetSet
  87
  88 =item HasA
  89
  90 Responsible for HasA relationships.
  91
  92 =item HasMany
  93
  94 Responsible for HasMany relationships.
  95
  96 =item ImaDBI
  97
  98 =item LazyLoading
  99
 100 =item LiveObjectIndex
 101
 102 The live object index tries to ensure there is only one version of a object
 103 in the perl interprenter.
 104
 105 =item MightHave
 106
 107 Responsible for MightHave relationships.
 108
 109 =item ObjIndexStubs
 110
 111 =item ReadOnly
 112
 113 =item Retrieve
 114
 115 =item Stringify
 116
 117 =item TempColumns
 118
 119 =item Triggers
 120
 121 This class implements the trigger functionality.
 122
 123 =item PassThrough
 124
 125 =back
 126
 127
 128 =head1 AUTHORS
 129
 130 Matt S. Trout <mst@shadowcatsystems.co.uk>
 131
 132 =head1 LICENSE
 133
 134 You may distribute this code under the same terms as Perl itself.
 135
 136 =cut
 137