[Bast-commits] r9722 - in SQL-Abstract/1.x/trunk: . lib/SQL/Abstract

Sat Sep 11 17:36:22 GMT 2010

Author: frew
Date: 2010-09-11 18:36:22 +0100 (Sat, 11 Sep 2010)
New Revision: 9722

Modified:
   SQL-Abstract/1.x/trunk/Changes
   SQL-Abstract/1.x/trunk/lib/SQL/Abstract/Tree.pm
Log:
docs for ::Tree

Modified: SQL-Abstract/1.x/trunk/Changes
===================================================================

--- SQL-Abstract/1.x/trunk/Changes	2010-09-11 17:09:39 UTC (rev 9721)
+++ SQL-Abstract/1.x/trunk/Changes	2010-09-11 17:36:22 UTC (rev 9722)
@@ -1,7 +1,8 @@
 Revision history for SQL::Abstract
 
-revision 1.67_03  2010-09-
+revision 1.67_03  2010-09-11
 ----------------------------
+    - Add docs for SQL::Abstract::Tree->new
     - correcty merge profile and parameters
     - added fill_in_placeholders option for excellent copy/pasta
 

Modified: SQL-Abstract/1.x/trunk/lib/SQL/Abstract/Tree.pm
===================================================================
--- SQL-Abstract/1.x/trunk/lib/SQL/Abstract/Tree.pm	2010-09-11 17:09:39 UTC (rev 9721)
+++ SQL-Abstract/1.x/trunk/lib/SQL/Abstract/Tree.pm	2010-09-11 17:36:22 UTC (rev 9722)
@@ -398,8 +398,40 @@
 
  my $sqla_tree = SQL::Abstract::Tree->new({ profile => 'console' });
 
+ $args = {
+   profile => 'console',      # predefined profile to use (default: 'none')
+   fill_in_placeholders => 1, # true for placeholder population
+   indent_string => ' ',      # the string used when indenting
+   indent_amount => 2,        # how many of above string to use for a single
+                              # indent level
+   newline       => "\n",     # string for newline
+   colormap      => {
+     select => [RED, RESET], # a pair of strings defining what to surround
+                             # the keyword with for colorization
+     # ...
+   },
+   indentmap     => {
+     select        => 0,     # A zero means that the keyword will start on
+                             # a new line
+     from          => 1,     # Any other positive integer means that after
+     on            => 2,     # said newline it will get that many indents
+     # ...
+   },
+ }
+
+Returns a new SQL::Abstract::Tree object.  All arguments are optional.
+
+=head3 profiles
+
+There are four predefined profiles, C<none>, C<console>, C<console_monochrome>,
+and C<html>.  Typically a user will probably just use C<console> or
+C<console_monochrome>, but if something about a profile bothers you, merely
+use the profile and override the parts that you don't like.
+
 =head2 format
 
- $sqlat->format('SELECT * FROM bar')
+ $sqlat->format('SELECT * FROM bar WHERE x = ?', [1])
 
+Takes C<$sql> and C<\@bindargs>.
+
 Returns a formatting string based on the string passed in


