[Dbix-class] [Patch] PK::Auto documentation

[Daniel Westermann-Clark]

Since the question seems to come up pretty often, here's a patch
against trunk describing basic usage of the PK::Auto classes.

Each PK::Auto::$database class has a synopsis, as does PK::Auto.  The
patch also explicitly notes that the PK::Auto::$database class should
be loaded before Core.

-- 
Daniel Westermann-Clark
-------------- next part --------------
Patching locally against mirror source http://dev.catalyst.perl.org/repos/bast.
U   trunk/DBIx-Class/lib/DBIx/Class/PK/Auto.pm
U   trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MySQL.pm
U   trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Oracle.pm
U   trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Pg.pm
U   trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MSSQL.pm
U   trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/SQLite.pm
==== Patch <-> level 1
Source: [No source]
Target: bd8105ee-0ff8-0310-8827-fb3f25b6796d:/:397
        (http://dev.catalyst.perl.org/repos/bast)
Log:
Provide synopses for PK::Auto classes
=== trunk/DBIx-Class/lib/DBIx/Class/PK/Auto.pm
==================================================================
--- trunk/DBIx-Class/lib/DBIx/Class/PK/Auto.pm	(revision 397)
+++ trunk/DBIx-Class/lib/DBIx/Class/PK/Auto.pm	(patch - level 1)
@@ -11,18 +11,24 @@
 
 =head1 SYNOPSIS
 
+    # In your table classes (replace PK::Auto::SQLite with your
+    # database)
+    __PACKAGE__->load_components(qw/PK::Auto::SQLite Core/);
+    __PACKAGE__->set_primary_key('id');
+
 =head1 DESCRIPTION
 
 This class overrides the insert method to get automatically
 incremented primary keys.
 
-You don't want to be using this directly - instead load the appropriate
-one for your database, e.g. PK::Auto::SQLite
+You don't want to be using this directly - instead load the
+appropriate one for your database, e.g. C<PK::Auto::SQLite>, before
+C<Core>.
 
 =head1 LOGIC
 
-PK::Auto does this by letting the database assign the primary key field
-and fetching the assigned value afterwards.
+PK::Auto does this by letting the database assign the primary key
+field and fetching the assigned value afterwards.
 
 =head1 METHODS
 
=== trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MySQL.pm
==================================================================
--- trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MySQL.pm	(revision 397)
+++ trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MySQL.pm	(patch - level 1)
@@ -19,6 +19,10 @@
 
 =head1 SYNOPSIS
 
+    # In your table classes
+    __PACKAGE__->load_components(qw/PK::Auto::MySQL Core/);
+    __PACKAGE__->set_primary_key('id');
+
 =head1 DESCRIPTION
 
 This class implements autoincrements for MySQL.
=== trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Oracle.pm
==================================================================
--- trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Oracle.pm	(revision 397)
+++ trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Oracle.pm	(patch - level 1)
@@ -53,6 +53,10 @@
 
 =head1 SYNOPSIS
 
+    # In your table classes
+    __PACKAGE__->load_components(qw/PK::Auto::Oracle Core/);
+    __PACKAGE__->set_primary_key('id');
+
 =head1 DESCRIPTION
 
 This class implements autoincrements for Oracle.
=== trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Pg.pm
==================================================================
--- trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Pg.pm	(revision 397)
+++ trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/Pg.pm	(patch - level 1)
@@ -43,6 +43,10 @@
 
 =head1 SYNOPSIS
 
+    # In your table classes
+    __PACKAGE__->load_components(qw/PK::Auto::Pg Core/);
+    __PACKAGE__->set_primary_key('id');
+
 =head1 DESCRIPTION
 
 This class implements autoincrements for Postgresql.
=== trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MSSQL.pm
==================================================================
--- trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MSSQL.pm	(revision 397)
+++ trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/MSSQL.pm	(patch - level 1)
@@ -20,6 +20,10 @@
 

 =head1 SYNOPSIS

 

+    # In your table classes

+    __PACKAGE__->load_components(qw/PK::Auto::MSSQL Core/);

+    __PACKAGE__->set_primary_key('id');

+

 =head1 DESCRIPTION

 

 This class implements autoincrements for MSSQL.

@@ -32,4 +36,4 @@
 

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

 

-=cut
\ No newline at end of file
+=cut

=== trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/SQLite.pm
==================================================================
--- trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/SQLite.pm	(revision 397)
+++ trunk/DBIx-Class/lib/DBIx/Class/PK/Auto/SQLite.pm	(patch - level 1)
@@ -19,6 +19,10 @@
 
 =head1 SYNOPSIS
 
+    # In your table classes
+    __PACKAGE__->load_components(qw/PK::Auto::SQLite Core/);
+    __PACKAGE__->set_primary_key('id');
+
 =head1 DESCRIPTION
 
 This class implements autoincrements for SQLite.

==== BEGIN SVK PATCH BLOCK ====
Version: svk 1.05 (linux)

eJytl+9v00YYxz3tXRjvtr22tiCKRpr7ad8VFoV1wBBshJVNGhqKzr7nUgs3zhy3kMkTTQZCq7Zp
f/LO5zZQcNOCGuXN2fd8nuf5+nnux6384bU+Lns9VLYxKrd+vruxMVBFvH3JjtpBCTopsrzNyxT2
IG3TMs1GbVaO1Q7Yt4XKR1D0etgai9r4pjM4grCKEakiG0/b0sGGRQ7QJiVmfczLPq3+wzaW5RTs
O8cb5rCXTJNsbB1RTLid0cYltoBsAuNhnmWFDYTKsE8qU1TGaTaFYUW3T/q8mk3amNXTdZJDbEOa
2SSKfHf8xLFqe+eaH9q/nmgnLEG0AYSDmtT99ps7zzqbqZpOnctToGQJZQ1Qgt6BdtMkciGcAqZL
MG8C80awG7pYTqGzJT1ooFN8Mr17JA0/zQdf+gibfLDTfHQHd118p7gJqnpzbsRRNZkkhTYjZ3DQ
vbFbZOuTHRdk7cihZFPE8qzAN2gnhh3W6ri3ajJJZ8MCnhUa0kK5VCgpOSHAYgk6DsIoJKE2QAJl
YhQQHIRItmkY2gb9wfP+Hf8nPl384s2/8/bnzJuvzW/tzy95B9mfz337+9K/M/Zn2W7uFypKwY+r
YGHqr+UwSVUM/sA2eRX4xsbWg3tJAf7TpNh2Fq3aXitrqaZwxY2Hw8GNzbs3bt8cDju9NFN6GGc7
k2wM42K69tvT7ju4zSyH7pVr7xpXC8QkT3ZUPhs+gdna5URftvOsIHlmnytra7G+yfI6/qM4rvqw
Plr3N6+/7ap31Y/ATofW5vXKa2+91fp6G5TG/r37t+9stlpHFr7OrATFdjL1o5mfQlEk45Edw9KJ
b1VKRmP37DBI3wbZMgmk2u+zNxcqV3KH3w00xtKwmFIhDWYBlxgjBEIqGiIBoh+4grXrJTpeseKs
Bdb9fmbTretWvq5bS8THiWcu2e79XMUpNCHJceSKlect5GDUhKMfnPPWCTmzD825LpnjyBMbVq5o
WPcpXcfSWBqkA87sHkdFJFQcCpAIVEQErrYIWXfsi89efn7hube45u0/9+a/LuSKPn3PnnO18b4t
11DNR0lpEZDQIIgFA26ItCuSkcqQMNCMEWRW64IrRKAhpjJWOgJrjXmMIoEN4gYDC0Mw1pbUuvx9
/58Hn8w97+ChXck8b/7HwY/np0xd4+cjjcsrjDEXQRQColwJzqTQATLKdnkUGMbJammIQ0gpIwUi
okgarbmiChNBOY8pWKJdVFhQS/PXVwdXLpTeqy1vv/Tmj149OD9hBqPzEcVlFEjCcaiJZBQU5xoh
jsHWEI9xRBnlq0WhFUIJCABHGBkmbSOFhoehwZhpK44QoT2z8ENRXmy9fHRx/rG3+N3Wy0fe/PFi
b7FCl4vv20tbb/RSg3GzOBdbzfK43IiKI0KJBpARV5HtIiW0tF8/0spuXXi1PKxCRBBwimgUc6E5
sgcDrVlEKQs0AswYe91OL7542a7aaXG7bqfHi5vnVzUftrk3S+PyUgYAIoJljJDdKJVULDAgY2JI
wLAi9Sk/LAd5tpdo8KezcTapDjLV+WC5rx8mYyd3ej1idwhS32IeuovIxsZP42QP8qlKLwWlvY1M
VLFt1357P7GD3d1EW8NuvRm0qb3oaIERB+ggY0QHUYw6QpCwYyJqCI+CUAb6f4CPR1Q=
==== END SVK PATCH BLOCK ====