X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..1e4709b3305ca02671c86932b2bcf74afb33b54d:/docs/latex/wx/db.tex diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex index 807f9b9a38..0b051394a2 100644 --- a/docs/latex/wx/db.tex +++ b/docs/latex/wx/db.tex @@ -623,7 +623,7 @@ entry is also logged to the defined log file. \docparam{aHdbc}{Handle to the ODBC connection. Pass this in if the ODBC function call that erred required a hdbc or hstmt argument.} -\docparam{aHstmt}{Handle to the ODBC statement being executed against. Pass +\docparam{aHstmt}{Handle to the ODBC statement being executed against. Pass this in if the ODBC function call that failed required a hstmt argument.} \wxheading{Remarks} @@ -980,10 +980,10 @@ in the result set after the current position of the cursor. \wxheading{Parameters} \docparam{aHenv}{A handle to the ODBC environment.} -\docparam{aHdbc}{{\it OPTIONAL.} A handle to the ODBC connection. Pass this +\docparam{aHdbc}{{\it OPTIONAL.} A handle to the ODBC connection. Pass this in if the ODBC function call that failed required a hdbc or hstmt argument.} -\docparam{AHstmt}{{\it OPTIONAL.}A handle to the ODBC statement being executed -against. Pass this in if the ODBC function call that failed requires a +\docparam{AHstmt}{{\it OPTIONAL.}A handle to the ODBC statement being executed +against. Pass this in if the ODBC function call that failed requires a hstmt argument.} \wxheading{Example} @@ -1421,7 +1421,8 @@ at least minimal privileges to the table). \docparam{tableName}{Name of the table on which to check privileges. {\it tableName} may refer to a table, view, alias or synonym.} \docparam{priv}{The table privilege being evaluated. May be one of the -following (or a datasource specific privilege):} +following (or a datasource specific privilege): + \begin{verbatim} SELECT : The connected user is permitted to retrieve data for one or more columns of the table. @@ -1441,25 +1442,28 @@ following (or a datasource specific privilege):} example, a unique, referential, or table check constraint). \end{verbatim} +} \docparam{userID}{{\it OPTIONAL.} User for which to determine if the privilege specified to be checked is granted or not. Default is "". -{\it userID} is evaluated as follows:} +{\it userID} is evaluated as follows: + \begin{verbatim} userID == NULL ... NOT ALLOWED! userID == "" ... UserID set equal to 'this->uid' userID != "" ... UserID set equal to 'userID' \end{verbatim} - +} \docparam{schema}{{\it OPTIONAL.} Owner of the table. Specify a userID when the datasource you are connected to allows multiple unique tables with the same name to be owned by different users. Specifying the table owner makes determination of the -users privileges MUCH faster. Default is NULL. {\it userID} is evaluated as follows:} +users privileges MUCH faster. Default is NULL. {\it userID} is evaluated as follows: + \begin{verbatim} schema == NULL ... Any owner (DEFAULT) schema == "" ... Owned by 'this->uid' schema != "" ... Owned by userID specified in 'schema' \end{verbatim} - +} \docparam{path}{{\it OPTIONAL.} Path to the table. Default is "". Currently unused.} @@ -1690,9 +1694,9 @@ functions planned to be added for creating/manipulating datasource definitions. Default constructor. -\func{}{wxDbConnectInf}{\param{HENV }{henv}, \param{const wxString \&}{dsn}, -\param{const wxString \&}{userID=""}, \param{const wxString \&}{password}, -\param{const wxString \&}{defaultDir=""}, \param{const wxString \&}{description=""}, +\func{}{wxDbConnectInf}{\param{HENV }{henv}, \param{const wxString \&}{dsn}, +\param{const wxString \&}{userID=""}, \param{const wxString \&}{password}, +\param{const wxString \&}{defaultDir=""}, \param{const wxString \&}{description=""}, \param{const wxString \&}{fileType=""}} Constructor which allows initial settings of all the classes member variables. @@ -2568,11 +2572,11 @@ by specifying the data in the columns to match on. To delete all users with a first name of "JOHN", do the following: -\begin{verbatim} - 1) Clear all "columns" using wxDbTable::ClearMemberVars(). - 2) Set the FIRST_NAME column equal to "JOHN". - 3) Call wxDbTable::DeleteMatching(). -\end{verbatim} +\begin{enumerate}\itemsep=0pt +\item Clear all "columns" using wxDbTable::ClearMemberVars(). +\item Set the FIRST\_NAME column equal to "JOHN". +\item Call wxDbTable::DeleteMatching(). +\end{enumerate} The WHERE clause is built by the ODBC class library based on all non-NULL columns. This allows deletion of records by matching on any column(s) in @@ -3264,27 +3268,25 @@ specific function calls. The requirements of the SELECT statement are the following: -\begin{verbatim} - 1. Must return the correct number of columns. In the derived - wxDbTable constructor, it is specified how many columns are in - the wxDbTable object. The SELECT statement must return exactly - that many columns. - - 2. The columns must be returned in the same sequence as specified - when defining the bounds columns using wxDbTable::SetColDefs(), - and the columns returned must be of the proper data type. For - example, if column 3 is defined in the wxDbTable bound column - definitions to be a float, the SELECT statement must return a - float for column 3 (e.g. PRICE * 1.10 to increase the price by - 10%). - - 3. The ROWID can be included in your SELECT statement as the {\bf last} - column selected, if the datasource supports it. Use - wxDbTable::CanUpdByROWID() to determine if the ROWID can be - selected from the datasource. If it can, much better - performance can be achieved on updates and deletes by including - the ROWID in the SELECT statement. -\end{verbatim} +\begin{enumerate} +\item Must return the correct number of columns. In the derived +wxDbTable constructor, it is specified how many columns are in +the wxDbTable object. The SELECT statement must return exactly +that many columns. +\item The columns must be returned in the same sequence as specified +when defining the bounds columns using wxDbTable::SetColDefs(), +and the columns returned must be of the proper data type. For +example, if column 3 is defined in the wxDbTable bound column +definitions to be a float, the SELECT statement must return a +float for column 3 (e.g. PRICE * 1.10 to increase the price by +10%). +\item The ROWID can be included in your SELECT statement as the {\bf last} +column selected, if the datasource supports it. Use +wxDbTable::CanUpdByROWID() to determine if the ROWID can be +selected from the datasource. If it can, much better +performance can be achieved on updates and deletes by including +the ROWID in the SELECT statement. +\end{enumerate} Even though data can be selected from multiple tables (joins) in your select statement, only the base table associated with this wxDbTable object