diff README @ 2:b71833fb33ef

More details on the utils.mysql package.
author Daniele Nicolodi <daniele@science.unitn.it>
date Sun, 23 May 2010 22:09:23 +0200
parents c4b57991935a
children
line wrap: on
line diff
--- a/README	Sun May 23 22:06:57 2010 +0200
+++ b/README	Sun May 23 22:09:23 2010 +0200
@@ -160,9 +160,23 @@
 
 *** utils.jmysql
 
-    Collection of utility functions for interfacing to a database from
-    a pure matlab environment. Except connect() all the functions take
-    a java object implementing java.sql.Connection as first parameter.
+    Package containing a collection of functions and classes for
+    interfacing to a database from a pure matlab environment. Except
+    connect() all the functions take a java object implementing
+    java.sql.Connection as first parameter.
+
+    NOTE: Currently we use a MySQL database, however all the described
+    functions make no assumptions on the kind of database. It would be
+    fairly trivial to extend those to work on different databases,
+    exploiting the abstraction offered by the JDBC layer. In this case
+    a proper name for the package would be utils.db.
+
+
+*** utils.jmysql.credentials
+    
+    A simple class for organizing, in a convenient way, the
+    credentials required to establish a connection to a database
+    server.
 
 *** utils.jmysql.connect(hostname, database, username, password)