SF.net SVN: ledger-smb: [171] trunk/doc

[..hidden..]

Revision: 171
          http://svn.sourceforge.net/ledger-smb/?rev=171&view=rev
Author:   einhverfr
Date:     2006-09-29 21:58:57 -0700 (Fri, 29 Sep 2006)

Log Message:
-----------
Added rudamentary API documentation.  Extremely incomplete, but others can add to it

Added Paths:
-----------
    trunk/doc/API/
    trunk/doc/API/Database

Added: trunk/doc/API/Database
===================================================================
--- trunk/doc/API/Database	                        (rev 0)
+++ trunk/doc/API/Database	2006-09-30 04:58:57 UTC (rev 171)
@@ -0,0 +1,9 @@
+Most of the important database access is through the $form object.
+
+$form->{dbh} is a non-autocommit database handle.
+
+$form->dbinit initiates the $form->{dbh} and caches the custom fields table.
+
+$form->callproc($procname, @arguments) returns @hashref_records
+This is a wrapper for the stored procedures.  Prepares a parameterized query,
+fills in the arguments, and returns the results as a list of hashrefs.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.