Update examples to be more explicit about load_components order

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / PK / Auto.pm

diff --git a/lib/DBIx/Class/PK/Auto.pm b/lib/DBIx/Class/PK/Auto.pm
index 6928ba7..6b5356a 100644 (file)
--- a/lib/DBIx/Class/PK/Auto.pm
+++ b/lib/DBIx/Class/PK/Auto.pm
@@ -11,19 +11,40 @@ DBIx::Class::PK::Auto - Automatic Primary Key class
 
 =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>, in your
+table classes:
 
-=head1 METHODS
+    __PACKAGE__->load_components(qw/PK::Auto::SQLite Core/);
+
+Note that C<PK::Auto::SQLite> is specified as the leftmost argument.
+
+Alternatively, you can load the components separately:
+
+    __PACKAGE__->load_components(qw/Core/);
+    __PACKAGE__->load_components(qw/PK::Auto::SQLite/);
 
-=over 4
+This can be used, for example, if you have different databases and
+need to determine the appropriate C<PK::Auto> class at runtime.
 
-=item insert
+=head1 LOGIC
+
+C<PK::Auto> does this by letting the database assign the primary key
+field and fetching the assigned value afterwards.
+
+=head1 METHODS
+
+=head2 insert
 
 Overrides insert so that it will get the value of autoincremented
 primary keys.
@@ -55,7 +76,7 @@ sub insert {
   return $ret;
 }
 
-=item sequence
+=head2 sequence
 
 Manually define the correct sequence for your table, to avoid the overhead
 associated with looking up the sequence automatically.
@@ -66,8 +87,6 @@ __PACKAGE__->mk_classdata('sequence');
 
 1;
 
-=back
-
 =head1 AUTHORS
 
 Matt S. Trout <mst@shadowcatsystems.co.uk>