From: Oliver Gorwits <oliver@cpan.org>
Date: Wed, 28 Apr 2010 08:45:15 +0000 (+0000)
Subject: more documentation, clarifying issues with re-deply, and adding a warning about Pg... 
X-Git-Tag: v0.900201~21
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=ac1354cf6f3e6eaf2a68d60b994fff4df5c8e546;p=dbsrgits%2FDBIx-Class-Journal.git

more documentation, clarifying issues with re-deply, and adding a warning about Pg quoting
---

diff --git a/lib/DBIx/Class/Journal.pm b/lib/DBIx/Class/Journal.pm
index 368fa45..e8b0592 100644
--- a/lib/DBIx/Class/Journal.pm
+++ b/lib/DBIx/Class/Journal.pm
@@ -84,8 +84,8 @@ Load the module into your L<DBIx::Class> Schema Class:
 
  __PACKAGE__->load_components(qw/Schema::Journal/);
 
-And then call C<< $schema->bootstrap_journal >> to create all the tables
-necessary for the journal, in your database.
+And then call C<< $schema->bootstrap_journal >> (I<once only>) to create all
+the tables necessary for the journal, in your database.
 
 Optionally set where the journal is stored:
 
@@ -246,6 +246,9 @@ This calls C<journal_schema_deploy> followed by C<prepopulate_journal> to
 create your journal tables and if necessary populate them with a snapshot of
 your current original schema data.
 
+Do not run this method more than once on your database, as redeploying the
+journal schema is not supported.
+
 =item journal_schema_deploy
 
 Will use L<DBIx::Class::Schema/deploy> to set up the tables for journalling in
@@ -255,12 +258,8 @@ Note that if you are retrofitting journalling to an existing database, then as
 well as creating the journal you will need to populate it with a history so
 that when rows are deleted they can be mapped back to a (fake) creation.
 
-=item journal_deploy_on_connect $bool
-
-If set to a true value will cause C<journal_schema_deploy> to be called on
-C<connect>.
-
-Not recommended, but present for backwards compatibility.
+Do not run this method more than once on your database, as redeploying the
+journal schema is not supported.
 
 =item prepopulate_journal
 
@@ -298,6 +297,24 @@ Currently nested C<txn_do> calls cause a single ChangeSet object to be created.
 
 =back
 
+=head2 Deprecated Methods
+
+=over 4
+
+=item journal_deploy_on_connect $bool
+
+If set to a true value will cause C<journal_schema_deploy> to be called on
+C<connect>. Not recommended (because re-deploy of a schema is not supported),
+but present for backwards compatibility.
+
+=back
+
+=head1 TROUBLESHOOTING
+
+For PostgreSQL databases you must enable quoting on SQL command generation by
+passing C<< { quote_char => q{`}, name_sep => q{.} } >> when connecting to the
+database.
+
 =head1 SEE ALSO
 
 =over 4