Changeset 9546 for lang/perl/Filter-SQL/trunk/lib/Filter/SQL.pm

Timestamp:

04/16/08 09:53:38 (4 years ago)

Author:

kazuho

Message:

remove debug message, add READEME and POD

Files:

• lang/perl/Filter-SQL/trunk/lib/Filter/SQL.pm (modified) (2 diffs)

lang/perl/Filter-SQL/trunk/lib/Filter/SQL.pm

@@ -57 +57 @@
             $var =~ s/^{(.*)}$/$1/m;
             $out .= "' . Filter::SQL->quote($var) . '";
-            print STDERR "Var - $out\n";
         }
     }
@@ -104 +103 @@
 
 1;
+
+__END__
+=head1 NAME
+
+Filter::SQL - embedded SQL for perl
+
+=head1 SYNOPSIS
+
+  use Filter::SQL;
+
+  Filter::SQL->dbh(DBI->connect('dbi:...')) or die DBI->errstr;
+
+  SQL CREATE TABLE t (v int not null);;
+
+  $v = 12345;
+  INSERT INTO t (v) VALUES ($v);;
+  
+  foreach my $row (SELECT * FROM t;) {
+      print "v: $row[0]\n";
+  }
+
+  if (SELECT ROW COUNT(*) FROM t; == 1) {
+      print "1 row in table\n";
+  }
+
+=head1 SYNTAX
+
+Filter::SQL recognizes portion of source code starting from one of the keywords below as an SQL statement, terminated by a semicolon.
+
+  SQL
+  SELECT
+  SELECT ROW
+  EXEC SELECT
+  INSERT
+  UPDATE
+  DELETE
+  REPLACE
+
+=head2 "SQL" statement
+
+Executes following string as a SQL statement.  Returns an array of rows if executed statement is a SELECT statement, or returns result code if otherwise.
+
+  my @row = SQL SELECT * FROM t;;
+
+  SQL DROP TABLE t;;
+
+=head2 "SELECT" statement
+
+Executes a SQL SELECT statement.  Returns an array of rows.
+
+  my @row = SELECT * FROM t;;
+
+=head2 "SELECT ROW" statement
+
+Executes a SQL SELECT statement and returns the first row.
+
+  my @column_values = SELECT ROW * FROM t;;
+
+  my $sum = SELECT ROW SUM(v) FROM t;;
+
+=head2 "EXEC SELECT" statement
+
+Executes a SELECT statement and returns a DBI statement object.
+
+  my $sth = EXEC SELECT * FROM t;;
+  while (my @row = $sth->fetchrow_array) {
+      ...
+  }
+
+=head2 "INSERT" statement
+=head2 "UPDATE" statement
+=head2 "DELETE" statement
+=head2 "REPLACE" statement
+
+Executes a SQL statement and returns result code.
+
+=head2 VARIABLE SUBSTITUTION
+
+Within a SQL statement, scalar perl variables may be used.  They are automatically quoted and passed to the database engine.
+
+  my @rows = SELECT v FROM t WHERE v<$min_v;;
+
+  my @rows = SELECT v FROM t WHERE s LIKE "abc%$str";;
+
+A string between curly brackets it considered as a perl expression.
+
+  my $t = 'hello';
+  print SELECT ROW {$t . ' world'};;   # hello world
+
+=head1 AUTHOR
+
+Kazuho Oku
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2008 by Cybozu Labs, Inc.
+
+This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.
+
+=cut
+