From: Arthur Axel "fREW" Schmidt Date: Sat, 11 Sep 2010 17:36:22 +0000 (+0000) Subject: docs for ::Tree X-Git-Tag: v1.70~63 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=c22f502d87931a2d6065dad19d74688c5f824576;hp=1a3cc911988505cca2ac50c6b172c3a4b40f972d;p=dbsrgits%2FSQL-Abstract.git docs for ::Tree --- diff --git a/Changes b/Changes index ad898a7..2e4d0da 100644 --- a/Changes +++ b/Changes @@ -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 diff --git a/lib/SQL/Abstract/Tree.pm b/lib/SQL/Abstract/Tree.pm index eb8d9c8..dcf9daf 100644 --- a/lib/SQL/Abstract/Tree.pm +++ b/lib/SQL/Abstract/Tree.pm @@ -398,8 +398,40 @@ sub format { my $self = shift; $self->unparse($self->parse($_[0]), $_[1]) } 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, C, C, +and C. Typically a user will probably just use C or +C, 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