[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / CDBICompat.pm

package DBIx::Class::CDBICompat;

use strict;
use warnings;
use base qw/DBIx::Class/;

__PACKAGE__->load_own_components(qw/
  Constraints
  Triggers
  ReadOnly
  GetSet
  LiveObjectIndex
  AttributeAPI
  Stringify
  DestroyWarning
  Constructor
  AccessorMapping
  ColumnCase
  HasMany
  HasA
  LazyLoading
  AutoUpdate
  TempColumns
  Retrieve
  Pager
  ColumnGroups
  ImaDBI/);

            #DBIx::Class::ObjIndexStubs
1;

=head1 NAME 

DBIx::Class::CDBICompat - Class::DBI Compatability layer.

=head1 SYNOPSIS

  use base qw/DBIx::Class/;
  __PACKAGE__->load_components(qw/CDBICompat Core DB/);

=head1 DESCRIPTION

DBIx::Class features a fully featured compability layer with L<Class::DBI>
to ease transition for existing CDBI users. In fact, this class is just a
receipe containing all the features emulated. If you like, you can choose
which features to emulate by building your own class and loading it like 
this:

  __PACKAGE__->load_own_components(qw/CDBICompat/);

this will automatically load the features included in My::DB::CDBICompat, 
provided it looks something like this:

  package My::DB::CDBICompat;
  __PACKAGE__->load_components(qw/
    CDBICompat::ColumnGroups
    CDBICompat::Retrieve
    CDBICompat::HasA
    CDBICompat::HasMany
    CDBICompat::MightHave
  /);

=head1 Components

=over 4

=item AccessorMapping

=item AttributeAPI

=item AutoUpdate

Allows you to turn on automatic updates for column values.

=item ColumnCase

=item ColumnGroups

=item Constraints

=item Constructor

=item DestroyWarning

=item GetSet

=item HasA

Responsible for HasA relationships. 

=item HasMany

Responsible for HasMany relationships. 

=item ImaDBI

=item LazyLoading

=item LiveObjectIndex

The live object index tries to ensure there is only one version of a object
in the perl interprenter.

=item MightHave

Responsible for MightHave relationships. 

=item ObjIndexStubs

=item ReadOnly

=item Retrieve

=item Stringify

=item TempColumns

=item Triggers

This class implements the trigger functionality.

=item PassThrough

=back


=head1 AUTHORS

Matt S. Trout <mst@shadowcatsystems.co.uk>

=head1 LICENSE

You may distribute this code under the same terms as Perl itself.

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