From 07144f4fda079ed28377fcfa35c56549e5f26a19 Mon Sep 17 00:00:00 2001
From: einhverfr <einhverfr@4979c152-3d1c-0410-bac9-87ea11338e46>
Date: Sat, 30 Sep 2006 04:58:57 +0000
Subject: Added rudamentary API documentation.  Extremely incomplete, but
 others can add to it

git-svn-id: https://ledger-smb.svn.sourceforge.net/svnroot/ledger-smb/trunk@171 4979c152-3d1c-0410-bac9-87ea11338e46
---
 doc/API/Database | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 doc/API/Database

(limited to 'doc')

diff --git a/doc/API/Database b/doc/API/Database
new file mode 100644
index 00000000..70ac780a
--- /dev/null
+++ b/doc/API/Database
@@ -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.
-- 
cgit v1.2.3