summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authoreinhverfr <einhverfr@4979c152-3d1c-0410-bac9-87ea11338e46>2006-09-30 04:58:57 +0000
committereinhverfr <einhverfr@4979c152-3d1c-0410-bac9-87ea11338e46>2006-09-30 04:58:57 +0000
commit07144f4fda079ed28377fcfa35c56549e5f26a19 (patch)
tree15ce95c23590af9cef50884a5bfb620a2c7eb2b6 /doc
parentb21b41ef8282ddfc3abf5b81fcb6e668eb496149 (diff)
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
Diffstat (limited to 'doc')
-rw-r--r--doc/API/Database9
1 files changed, 9 insertions, 0 deletions
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.