From: Matt S Trout Date: Tue, 9 Aug 2005 00:10:01 +0000 (+0000) Subject: Updated main docs, altered mail address in POD for 0.01 X-Git-Tag: v0.03001~48 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=daec44b85cffd777869c9652273670b27625e167;p=dbsrgits%2FDBIx-Class.git Updated main docs, altered mail address in POD for 0.01 --- diff --git a/lib/DBIx/Class.pm b/lib/DBIx/Class.pm index 47906ff..4dba9d1 100644 --- a/lib/DBIx/Class.pm +++ b/lib/DBIx/Class.pm @@ -45,23 +45,38 @@ and meant to support compability with it, while restructuring the insides, and making it possible to support some new features like self-joins, distinct, group bys and more. +It's currently considered EXPERIMENTAL - bring this near a production +database at your own risk! The API is *not* fixed yet, although most of +the primitives should be good for the future and any API changes will be +posted to the mailing list before they're committed. + +The community can be found via - + + Mailing list: http://lists.rawmode.org/mailman/listinfo/dbix-class/ + + SVN: http://dev.catalyst.perl.org/repos/bast/trunk/DBIx-Class/ + + Wiki: http://dbix-class.shadowcatsystems.co.uk/ + + IRC: irc.perl.org#dbix-class + =head1 QUICKSTART If you're using Class::DBI, replacing -use base qw/Class::DBI/; + use base qw/Class::DBI/; with -use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/CDBICompat Core DB/); + use base qw/DBIx::Class/; + __PACKAGE__->load_components(qw/CDBICompat Core DB/); will probably get you started. If you're using AUTO_INCREMENT for your primary columns, you'll also want yo load the approriate PK::Auto subclass - e.g. -__PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/); + __PACKAGE__->load_components(qw/CDBICompat PK::Auto::SQLite Core DB/); (with is what ::Test::SQLite does to present the Class::DBI::Test::SQLite interface) @@ -69,14 +84,14 @@ interface) If you fancy playing around with DBIx::Class from scratch, then read the docs for ::Table and ::Relationship, -use base qw/DBIx::Class/; -__PACKAGE__->load_components(qw/Core DB/); + use base qw/DBIx::Class/; + __PACKAGE__->load_components(qw/Core DB/); and have a look at t/lib/DBICTest.pm for a brief example. =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/AccessorGroup.pm b/lib/DBIx/Class/AccessorGroup.pm index f85c714..1fcd2e0 100644 --- a/lib/DBIx/Class/AccessorGroup.pm +++ b/lib/DBIx/Class/AccessorGroup.pm @@ -142,7 +142,7 @@ sub make_group_wo_accessor { =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/CDBICompat.pm b/lib/DBIx/Class/CDBICompat.pm index 6590291..30e3b58 100644 --- a/lib/DBIx/Class/CDBICompat.pm +++ b/lib/DBIx/Class/CDBICompat.pm @@ -41,7 +41,7 @@ up the Class::DBI compability layer. =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/Core.pm b/lib/DBIx/Class/Core.pm index 3f7aea0..5dc4096 100644 --- a/lib/DBIx/Class/Core.pm +++ b/lib/DBIx/Class/Core.pm @@ -29,7 +29,7 @@ up the DBIx::Class core features. =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/DB.pm b/lib/DBIx/Class/DB.pm index 6396725..905b908 100644 --- a/lib/DBIx/Class/DB.pm +++ b/lib/DBIx/Class/DB.pm @@ -82,7 +82,7 @@ sub resolve_class { return shift->class_resolver->class(@_); } =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/PK.pm b/lib/DBIx/Class/PK.pm index d31cfe4..20576bd 100644 --- a/lib/DBIx/Class/PK.pm +++ b/lib/DBIx/Class/PK.pm @@ -101,7 +101,7 @@ sub primary_columns { =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/PK/Auto.pm b/lib/DBIx/Class/PK/Auto.pm index 4b95f7c..43a1ece 100644 --- a/lib/DBIx/Class/PK/Auto.pm +++ b/lib/DBIx/Class/PK/Auto.pm @@ -53,7 +53,7 @@ sub insert { =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/PK/Auto/MySQL.pm b/lib/DBIx/Class/PK/Auto/MySQL.pm index bd253f0..8644120 100644 --- a/lib/DBIx/Class/PK/Auto/MySQL.pm +++ b/lib/DBIx/Class/PK/Auto/MySQL.pm @@ -25,7 +25,7 @@ This class implements autoincrements for MySQL. =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/PK/Auto/SQLite.pm b/lib/DBIx/Class/PK/Auto/SQLite.pm index a86bf89..24bb045 100644 --- a/lib/DBIx/Class/PK/Auto/SQLite.pm +++ b/lib/DBIx/Class/PK/Auto/SQLite.pm @@ -25,7 +25,7 @@ This class implements autoincrements for SQLite. =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/Relationship.pm b/lib/DBIx/Class/Relationship.pm index 6cdb513..f179120 100644 --- a/lib/DBIx/Class/Relationship.pm +++ b/lib/DBIx/Class/Relationship.pm @@ -33,7 +33,7 @@ on searches. =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm index 467e3ba..05f2508 100644 --- a/lib/DBIx/Class/Relationship/Base.pm +++ b/lib/DBIx/Class/Relationship/Base.pm @@ -227,7 +227,7 @@ sub delete_related { =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm index 5f4cb17..86841ef 100644 --- a/lib/DBIx/Class/Row.pm +++ b/lib/DBIx/Class/Row.pm @@ -258,7 +258,7 @@ sub is_changed { =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/Schema.pm b/lib/DBIx/Class/Schema.pm index 5c99525..d33f4d4 100644 --- a/lib/DBIx/Class/Schema.pm +++ b/lib/DBIx/Class/Schema.pm @@ -123,7 +123,7 @@ sub inject_base { =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/Storage/DBI.pm b/lib/DBIx/Class/Storage/DBI.pm index c5e0162..13b7cc0 100644 --- a/lib/DBIx/Class/Storage/DBI.pm +++ b/lib/DBIx/Class/Storage/DBI.pm @@ -133,7 +133,7 @@ sub sth { =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE diff --git a/lib/DBIx/Class/Table.pm b/lib/DBIx/Class/Table.pm index 32f101d..ba79341 100644 --- a/lib/DBIx/Class/Table.pm +++ b/lib/DBIx/Class/Table.pm @@ -181,7 +181,7 @@ sub columns { return keys %{shift->_columns}; } =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE