From: Arthur Axel 'fREW' Schmidt Date: Wed, 19 May 2010 06:44:02 +0000 (-0500) Subject: Document logging X-Git-Tag: v0.001000_11~7^2 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=dbsrgits%2FDBIx-Class-DeploymentHandler.git;a=commitdiff_plain;h=a66bf8996b0752451651ac09a060d991743a941d Document logging --- diff --git a/lib/DBIx/Class/DeploymentHandler.pm b/lib/DBIx/Class/DeploymentHandler.pm index a792c25..fc2ebad 100644 --- a/lib/DBIx/Class/DeploymentHandler.pm +++ b/lib/DBIx/Class/DeploymentHandler.pm @@ -185,6 +185,27 @@ Then set your database version: Now you should be able to use C like normal! +=head1 LOGGING + +This is a complex tool, and because of that sometimes you'll want to see +what exactly is happening. The best way to do that is to use the built +in logging functionality. Currently three of the standard five log levels +are used; C, C, and C. Info will typically just print +out when methods that actually change things along with the most important +args to the method. Debug will give you a little bit more information, +for example debug will currently tell you which files are being run when +a migration is being called. Trace of course goes even further. It will +actually give you the SQL or Perl code being executed when a migration is run. + +To enable the various logging levels all you need to do is set some environment +variables: C, C, and C. Each level +can be set on it's own, so you can turn on trace without turning on info. + +Lastly, the logging uses L, so if you have already set up an +application-wide logger this will use that logger instead, and the environment +variables will be completely ignored (unless you did something weird like +set your logger to log when the above environment variables are set.) + =head1 DONATIONS If you'd like to thank me for the work I've done on this module, don't give me