Changeset 3158 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Feb 7, 2005, 10:57:20 PM (21 years ago)

Author:

jhoblitt

Message:

changed psDBDumpCols() to return a psMetadata (bug 285)
changed psDB to hold a MYSQL *
changed psDBSelectColumnNum() to accept a psElemType parameter
changed psDBSelectColumn() to return an psArray of strings
renamed psDBUpdateRow() to psDBUpdateRows()
renamed psDBDeleteRow() to psDBDeleteRows()
renamed psDBInsertRow() to psDBInsertOneRow()

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (6 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.174 2005-02-08 04:56:24 eugene Exp $
+%%% $Id: psLibSDRS.tex,v 1.175 2005-02-08 08:57:20 jhoblitt Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -4320 +4320 @@
 \begin{verbatim}
     typedef struct {
-        MYSQL mysql;
+        MYSQL *mysql;
     } psDB;
 \end{verbatim}
@@ -4398 +4398 @@
 \begin{verbatim}
     psArray *psDBSelectColumn(psDB *dbh, const char *tableName, const char *col, const psU64 limit);
-    psVector *psDBSelectColumnNum(psDB *dbh, const char *tableName, const char *col, const psU64 limit);
-\end{verbatim}
-
-These functions generates and executes the SQL needed to select an
-entire column from a table or up to \code{limit} rows from it.  If
-\code{limit} is 0, the entire range is returned.  The database
-response is processed and a \code{psArray} of elements of the native
-type is returned.  The Num version of the function returns the data in
-a \code{psVector}.  It returns an error (NULL) if the requested field
-is not a numerical type.
+    psVector *psDBSelectColumnNum(psDB *dbh, const char *tableName, const char *col, psElemType pType, const psU64 limit);
+\end{verbatim}
+
+These functions generates and executes the SQL needed to select an entire
+column from a table or up to \code{limit} rows from it.  If \code{limit} is 0,
+the entire range is returned.  The database response is processed and a
+\code{psArray} of strings is returned.  The Num version of the function returns
+the data in a \code{psVector}, data cast to \code{pType}.  It returns an error
+(NULL) if the requested field is not a numerical type.
 
 \begin{verbatim}
@@ -4423 +4422 @@
 
 \begin{verbatim}
-    bool psDBInsertRow(psDB *dbh, const char *tableName, psMetadata *row);
+    bool psDBInsertOneRow(psDB *dbh, const char *tableName, psMetadata *row);
 \end{verbatim}
 
@@ -4437 +4436 @@
 
 \begin{verbatim}
-    psArray *psDBDumpCols(psDB *dbh, const char *tableName);
-\end{verbatim}
-
-Fetch all columns as an psArray of psVector
-
-\begin{verbatim}
-    psU64 psDBUpdateRow(psDB *dbh, const char *tableName, psMetadata *where, psMetadata *values);
+    psMetadata *psDBDumpCols(psDB *dbh, const char *tableName);
+\end{verbatim}
+
+Fetch all columns, as either a psVector or a psArray depnding on whether or not
+the column is numeric, and return them in a psMetadata structure where
+psMetadataItem.name contains the column's name.
+
+\begin{verbatim}
+    psU64 psDBUpdateRows(psDB *dbh, const char *tableName, psMetadata *where, psMetadata *values);
 \end{verbatim}
 
@@ -4454 +4455 @@
 
 \begin{verbatim}
-    psU64 psDBDeleteRow(psDB *dbh, const char *tableName, psMetadata *where);
+    psU64 psDBDeleteRows(psDB *dbh, const char *tableName, psMetadata *where);
 \end{verbatim}