Delivered-To: mailing list commits@apr.apache.org Received: (qmail 29815 invoked by uid 99); 15 Jun 2009 00:03:07 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 15 Jun 2009 00:03:07 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 15 Jun 2009 00:02:54 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 20D6C23889B4; Mon, 15 Jun 2009 00:02:04 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r784636 [8/47] - in /apr/site/trunk/docs/docs: apr-util/trunk/ apr/trunk/ Date: Mon, 15 Jun 2009 00:01:47 -0000 To: commits@apr.apache.org From: bojan@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20090615000204.20D6C23889B4@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: apr/site/trunk/docs/docs/apr/trunk/apr__dbd__internal_8h-source.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__dbd__internal_8h-source.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/apr__dbd__internal_8h-source.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/apr__dbd__internal_8h-source.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,396 @@ + + +Apache Portable Runtime: apr_dbd_internal.h Source File + + + + +

apr_dbd_internal.h

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
+00002  * contributor license agreements.  See the NOTICE file distributed with
+00003  * this work for additional information regarding copyright ownership.
+00004  * The ASF licenses this file to You under the Apache License, Version 2.0
+00005  * (the "License"); you may not use this file except in compliance with
+00006  * the License.  You may obtain a copy of the License at
+00007  *
+00008  *     http://www.apache.org/licenses/LICENSE-2.0
+00009  *
+00010  * Unless required by applicable law or agreed to in writing, software
+00011  * distributed under the License is distributed on an "AS IS" BASIS,
+00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+00013  * See the License for the specific language governing permissions and
+00014  * limitations under the License.
+00015  */
+00016 
+00017 /* Overview of what this is and does:
+00018  * http://www.apache.org/~niq/dbd.html
+00019  */
+00020 
+00021 #ifndef APR_DBD_INTERNAL_H
+00022 #define APR_DBD_INTERNAL_H
+00023 
+00024 #include <stdarg.h>
+00025 
+00026 #include "apr_dbd.h"
+00027 
+00028 #ifdef __cplusplus
+00029 extern "C" {
+00030 #endif
+00031 
+00032 #define TXN_IGNORE_ERRORS(t) \
+00033   ((t) && ((t)->mode & APR_DBD_TRANSACTION_IGNORE_ERRORS))
+00034 #define TXN_NOTICE_ERRORS(t) \
+00035   ((t) && !((t)->mode & APR_DBD_TRANSACTION_IGNORE_ERRORS))
+00036 
+00037 #define TXN_DO_COMMIT(t)   (!((t)->mode & APR_DBD_TRANSACTION_ROLLBACK))
+00038 #define TXN_DO_ROLLBACK(t) ((t)->mode & APR_DBD_TRANSACTION_ROLLBACK)
+00039 
+00040 #define TXN_MODE_BITS \
+00041   (APR_DBD_TRANSACTION_ROLLBACK|APR_DBD_TRANSACTION_IGNORE_ERRORS)
+00042 
+00043 struct apr_dbd_driver_t {
+00044     /** name */
+00045     const char *name;
+00046 
+00047     /** init: allow driver to perform once-only initialisation.
+00048      *  Called once only.  May be NULL
+00049      */
+00050     void (*init)(apr_pool_t *pool);
+00051 
+00052     /** native_handle: return the native database handle of the underlying db
+00053      *
+00054      * @param handle - apr_dbd handle
+00055      * @return - native handle
+00056      */
+00057     void *(*native_handle)(apr_dbd_t *handle);
+00058 
+00059     /** open: obtain a database connection from the server rec.
+00060      *  Must be explicitly closed when you're finished with it.
+00061      *  WARNING: only use this when you need a connection with
+00062      *  a lifetime other than a request
+00063      *
+00064      *  @param pool - a pool to use for error messages (if any).
+00065      *  @param params - connection parameters.
+00066      *  @param error - descriptive error.
+00067      *  @return database handle, or NULL on error.
+00068      */
+00069     apr_dbd_t *(*open)(apr_pool_t *pool, const char *params,
+00070                        const char **error);
+00071 
+00072     /** check_conn: check status of a database connection
+00073      *
+00074      *  @param pool - a pool to use for error messages (if any).
+00075      *  @param handle - the connection to check
+00076      *  @return APR_SUCCESS or error
+00077      */
+00078     apr_status_t (*check_conn)(apr_pool_t *pool, apr_dbd_t *handle);
+00079 
+00080     /** close: close/release a connection obtained from open()
+00081      *
+00082      *  @param handle - the connection to release
+00083      *  @return APR_SUCCESS or error
+00084      */
+00085     apr_status_t (*close)(apr_dbd_t *handle);
+00086 
+00087     /** set_dbname: select database name.  May be a no-op if not supported.
+00088      *
+00089      *  @param pool - working pool
+00090      *  @param handle - the connection
+00091      *  @param name - the database to select
+00092      *  @return 0 for success or error code
+00093      */
+00094     int (*set_dbname)(apr_pool_t* pool, apr_dbd_t *handle, const char *name);
+00095 
+00096     /** transaction: start a transaction.  May be a no-op.
+00097      *
+00098      *  @param pool   - a pool to use for error messages (if any).
+00099      *  @param handle - the connection
+00100      *  @param trans  - ptr to a transaction.  May be null on entry
+00101      *  @return 0 for success or error code
+00102      */
+00103     int (*start_transaction)(apr_pool_t *pool, apr_dbd_t *handle,
+00104                              apr_dbd_transaction_t **trans);
+00105 
+00106     /** end_transaction: end a transaction
+00107      *  (commit on success, rollback on error).
+00108      *  May be a no-op.
+00109      *
+00110      *  @param trans - the transaction.
+00111      *  @return 0 for success or error code
+00112      */
+00113     int (*end_transaction)(apr_dbd_transaction_t *trans);
+00114 
+00115     /** query: execute an SQL query that doesn't return a result set
+00116      *
+00117      *  @param handle - the connection
+00118      *  @param nrows - number of rows affected.
+00119      *  @param statement - the SQL statement to execute
+00120      *  @return 0 for success or error code
+00121      */
+00122     int (*query)(apr_dbd_t *handle, int *nrows, const char *statement);
+00123 
+00124     /** select: execute an SQL query that returns a result set
+00125      *
+00126      *  @param pool - pool to allocate the result set
+00127      *  @param handle - the connection
+00128      *  @param res - pointer to result set pointer.  May point to NULL on entry
+00129      *  @param statement - the SQL statement to execute
+00130      *  @param random - 1 to support random access to results (seek any row);
+00131      *                  0 to support only looping through results in order
+00132      *                    (async access - faster)
+00133      *  @return 0 for success or error code
+00134      */
+00135     int (*select)(apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_results_t **res,
+00136                   const char *statement, int random);
+00137 
+00138     /** num_cols: get the number of columns in a results set
+00139      *
+00140      *  @param res - result set.
+00141      *  @return number of columns
+00142      */
+00143     int (*num_cols)(apr_dbd_results_t *res);
+00144 
+00145     /** num_tuples: get the number of rows in a results set
+00146      *  of a synchronous select
+00147      *
+00148      *  @param res - result set.
+00149      *  @return number of rows, or -1 if the results are asynchronous
+00150      */
+00151     int (*num_tuples)(apr_dbd_results_t *res);
+00152 
+00153     /** get_row: get a row from a result set
+00154      *
+00155      *  @param pool - pool to allocate the row
+00156      *  @param res - result set pointer
+00157      *  @param row - pointer to row pointer.  May point to NULL on entry
+00158      *  @param rownum - row number, or -1 for "next row".  Ignored if random
+00159      *                  access is not supported.
+00160      *  @return 0 for success, -1 for rownum out of range or data finished
+00161      */
+00162     int (*get_row)(apr_pool_t *pool, apr_dbd_results_t *res,
+00163                    apr_dbd_row_t **row, int rownum);
+00164   
+00165     /** get_entry: get an entry from a row
+00166      *
+00167      *  @param row - row pointer
+00168      *  @param col - entry number
+00169      *  @param val - entry to fill
+00170      *  @return 0 for success, -1 for no data, +1 for general error
+00171      */
+00172     const char* (*get_entry)(const apr_dbd_row_t *row, int col);
+00173   
+00174     /** error: get current error message (if any)
+00175      *
+00176      *  @param handle - the connection
+00177      *  @param errnum - error code from operation that returned an error
+00178      *  @return the database current error message, or message for errnum
+00179      *          (implementation-dependent whether errnum is ignored)
+00180      */
+00181     const char *(*error)(apr_dbd_t *handle, int errnum);
+00182   
+00183     /** escape: escape a string so it is safe for use in query/select
+00184      *
+00185      *  @param pool - pool to alloc the result from
+00186      *  @param string - the string to escape
+00187      *  @param handle - the connection
+00188      *  @return the escaped, safe string
+00189      */
+00190     const char *(*escape)(apr_pool_t *pool, const char *string,
+00191                           apr_dbd_t *handle);
+00192   
+00193     /** prepare: prepare a statement
+00194      *
+00195      *  @param pool - pool to alloc the result from
+00196      *  @param handle - the connection
+00197      *  @param query - the SQL query
+00198      *  @param label - A label for the prepared statement.
+00199      *                 use NULL for temporary prepared statements
+00200      *                 (eg within a Request in httpd)
+00201      *  @param nargs - number of parameters in the query
+00202      *  @param nvals - number of values passed in p[b]query/select
+00203      *  @param types - pointer to an array with types of parameters
+00204      *  @param statement - statement to prepare.  May point to null on entry.
+00205      *  @return 0 for success or error code
+00206      */
+00207     int (*prepare)(apr_pool_t *pool, apr_dbd_t *handle, const char *query,
+00208                    const char *label, int nargs, int nvals,
+00209                    apr_dbd_type_e *types, apr_dbd_prepared_t **statement);
+00210 
+00211     /** pvquery: query using a prepared statement + args
+00212      *
+00213      *  @param pool - working pool
+00214      *  @param handle - the connection
+00215      *  @param nrows - number of rows affected.
+00216      *  @param statement - the prepared statement to execute
+00217      *  @param args - args to prepared statement
+00218      *  @return 0 for success or error code
+00219      */
+00220     int (*pvquery)(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
+00221                    apr_dbd_prepared_t *statement, va_list args);
+00222 
+00223     /** pvselect: select using a prepared statement + args
+00224      *
+00225      *  @param pool - working pool
+00226      *  @param handle - the connection
+00227      *  @param res - pointer to query results.  May point to NULL on entry
+00228      *  @param statement - the prepared statement to execute
+00229      *  @param random - Whether to support random-access to results
+00230      *  @param args - args to prepared statement
+00231      *  @return 0 for success or error code
+00232      */
+00233     int (*pvselect)(apr_pool_t *pool, apr_dbd_t *handle,
+00234                     apr_dbd_results_t **res,
+00235                     apr_dbd_prepared_t *statement, int random, va_list args);
+00236 
+00237     /** pquery: query using a prepared statement + args
+00238      *
+00239      *  @param pool - working pool
+00240      *  @param handle - the connection
+00241      *  @param nrows - number of rows affected.
+00242      *  @param statement - the prepared statement to execute
+00243      *  @param args - args to prepared statement
+00244      *  @return 0 for success or error code
+00245      */
+00246     int (*pquery)(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
+00247                   apr_dbd_prepared_t *statement, const char **args);
+00248 
+00249     /** pselect: select using a prepared statement + args
+00250      *
+00251      *  @param pool - working pool
+00252      *  @param handle - the connection
+00253      *  @param res - pointer to query results.  May point to NULL on entry
+00254      *  @param statement - the prepared statement to execute
+00255      *  @param random - Whether to support random-access to results
+00256      *  @param args - args to prepared statement
+00257      *  @return 0 for success or error code
+00258      */
+00259     int (*pselect)(apr_pool_t *pool, apr_dbd_t *handle,
+00260                    apr_dbd_results_t **res, apr_dbd_prepared_t *statement,
+00261                    int random, const char **args);
+00262 
+00263   
+00264     /** get_name: get a column title from a result set
+00265      *
+00266      *  @param res - result set pointer
+00267      *  @param col - entry number
+00268      *  @return param name, or NULL if col is out of bounds.
+00269      */
+00270     const char* (*get_name)(const apr_dbd_results_t *res, int col);
+00271 
+00272     /** transaction_mode_get: get the mode of transaction
+00273      *
+00274      *  @param trans - the transaction.
+00275      *  @return mode of transaction
+00276      */
+00277     int (*transaction_mode_get)(apr_dbd_transaction_t *trans);
+00278 
+00279     /** transaction_mode_set: get the mode of transaction
+00280      *
+00281      *  @param trans - the transaction.
+00282      *  @param mode  - new mode of the transaction
+00283      *  @return the mode of transaction in force after the call
+00284      */
+00285     int (*transaction_mode_set)(apr_dbd_transaction_t *trans, int mode);
+00286 
+00287     /** format of prepared statement parameters */
+00288     const char *pformat;
+00289 
+00290     /** pvbquery: query using a prepared statement + binary args
+00291      *
+00292      *  @param pool - working pool
+00293      *  @param handle - the connection
+00294      *  @param nrows - number of rows affected.
+00295      *  @param statement - the prepared statement to execute
+00296      *  @param args - binary args to prepared statement
+00297      *  @return 0 for success or error code
+00298      */
+00299     int (*pvbquery)(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
+00300                     apr_dbd_prepared_t *statement, va_list args);
+00301 
+00302     /** pvbselect: select using a prepared statement + binary args
+00303      *
+00304      *  @param pool - working pool
+00305      *  @param handle - the connection
+00306      *  @param res - pointer to query results.  May point to NULL on entry
+00307      *  @param statement - the prepared statement to execute
+00308      *  @param random - Whether to support random-access to results
+00309      *  @param args - binary args to prepared statement
+00310      *  @return 0 for success or error code
+00311      */
+00312     int (*pvbselect)(apr_pool_t *pool, apr_dbd_t *handle,
+00313                      apr_dbd_results_t **res,
+00314                      apr_dbd_prepared_t *statement, int random, va_list args);
+00315 
+00316     /** pbquery: query using a prepared statement + binary args
+00317      *
+00318      *  @param pool - working pool
+00319      *  @param handle - the connection
+00320      *  @param nrows - number of rows affected.
+00321      *  @param statement - the prepared statement to execute
+00322      *  @param args - binary args to prepared statement
+00323      *  @return 0 for success or error code
+00324      */
+00325     int (*pbquery)(apr_pool_t *pool, apr_dbd_t *handle, int *nrows,
+00326                    apr_dbd_prepared_t *statement,const void **args);
+00327 
+00328     /** pbselect: select using a prepared statement + binary args
+00329      *
+00330      *  @param pool - working pool
+00331      *  @param handle - the connection
+00332      *  @param res - pointer to query results.  May point to NULL on entry
+00333      *  @param statement - the prepared statement to execute
+00334      *  @param random - Whether to support random-access to results
+00335      *  @param args - binary args to prepared statement
+00336      *  @return 0 for success or error code
+00337      */
+00338     int (*pbselect)(apr_pool_t *pool, apr_dbd_t *handle,
+00339                     apr_dbd_results_t **res, apr_dbd_prepared_t *statement,
+00340                     int random, const void **args);
+00341   
+00342     /** datum_get: get a binary entry from a row
+00343      *
+00344      *  @param row - row pointer
+00345      *  @param col - entry number
+00346      *  @param type - type of data to get
+00347      *  @param data - pointer to data, allocated by the caller
+00348      *  @return APR_SUCCESS, an error code on error or if col is out of bounds
+00349      */
+00350     apr_status_t (*datum_get)(const apr_dbd_row_t *row, int col,
+00351                               apr_dbd_type_e type, void *data);
+00352 };
+00353 
+00354 /* Export mutex lock/unlock for drivers that need it 
+00355  * deprecated; create a per-dbd mutex within the (*init) function
+00356  * to avoid blocking other providers running on other threads
+00357  */
+00358 APU_DECLARE(apr_status_t) apr_dbd_mutex_lock(void);
+00359 APU_DECLARE(apr_status_t) apr_dbd_mutex_unlock(void);
+00360 
+00361 #ifdef __cplusplus
+00362 }
+00363 #endif
+00364 
+00365 #endif
+

Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by + +

1.5.8

+ + Added: apr/site/trunk/docs/docs/apr/trunk/apr__dbd__odbc__v2_8h-source.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__dbd__odbc__v2_8h-source.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/apr__dbd__odbc__v2_8h-source.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/apr__dbd__odbc__v2_8h-source.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,150 @@ + + +Apache Portable Runtime: apr_dbd_odbc_v2.h Source File + + + + +

File List
Globals

apr_dbd_odbc_v2.h

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
+00002  * contributor license agreements.  See the NOTICE file distributed with
+00003  * this work for additional information regarding copyright ownership.
+00004  * The ASF licenses this file to You under the Apache License, Version 2.0
+00005  * (the "License"); you may not use this file except in compliance with
+00006  * the License.  You may obtain a copy of the License at
+00007  *
+00008  *     http://www.apache.org/licenses/LICENSE-2.0
+00009  *
+00010  * Unless required by applicable law or agreed to in writing, software
+00011  * distributed under the License is distributed on an "AS IS" BASIS,
+00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+00013  * See the License for the specific language governing permissions and
+00014  * limitations under the License.
+00015  */
+00016 
+00017 
+00018 /*  ONLY USED FOR ODBC Version 2   -DODBCV2
+00019 *
+00020 *   Re-define everything to work (more-or-less) in an ODBC V2 environment 
+00021 *       Random access to retrieved rows is not supported - i.e. calls to apr_dbd_select() cannot
+00022 *       have a 'random' argument of 1.  apr_dbd_get_row() must always pass rownum as 0 (get next row)
+00023 *
+00024 */
+00025 
+00026 #define SQLHANDLE SQLHENV   // Presumes that ENV, DBC, and STMT handles are all the same datatype
+00027 #define SQL_NULL_HANDLE 0
+00028 #define SQL_HANDLE_STMT 1
+00029 #define SQL_HANDLE_DBC  2
+00030 #define SQL_HANDLE_ENV  3
+00031 #define SQL_NO_DATA     SQL_NO_DATA_FOUND
+00032 
+00033 #ifndef SQL_SUCCEEDED
+00034 #define SQL_SUCCEEDED(rc) (((rc)&(~1))==0)
+00035 #endif
+00036 
+00037 #undef SQLSetEnvAttr
+00038 #define SQLSetEnvAttr(henv, Attribute, Value, StringLength)  (0)
+00039 
+00040 #undef SQLAllocHandle
+00041 #define SQLAllocHandle(type, parent, hndl) \
+00042 (     (type == SQL_HANDLE_STMT) ? SQLAllocStmt(parent, hndl) \
+00043     : (type == SQL_HANDLE_ENV)  ? SQLAllocEnv(hndl) \
+00044     :                             SQLAllocConnect(parent, hndl)  \
+00045 )
+00046 
+00047 #undef SQLFreeHandle
+00048 #define SQLFreeHandle(type, hndl) \
+00049 (     (type == SQL_HANDLE_STMT) ? SQLFreeStmt(hndl, SQL_DROP) \
+00050     : (type == SQL_HANDLE_ENV)  ? SQLFreeEnv(hndl) \
+00051     :                             SQLFreeConnect(hndl)  \
+00052 )
+00053 
+00054 #undef SQLGetDiagRec
+00055 #define SQLGetDiagRec(type, h, i, state, native, buffer, bufsize, reslen) \
+00056         SQLError(  (type == SQL_HANDLE_ENV) ? h : NULL, \
+00057                    (type == SQL_HANDLE_DBC) ? h : NULL, \
+00058                    (type == SQL_HANDLE_STMT) ? h : NULL, \
+00059                    state, native, buffer, bufsize, reslen)
+00060 
+00061 #undef SQLCloseCursor
+00062 #define SQLCloseCursor(stmt) SQLFreeStmt(stmt, SQL_CLOSE)
+00063 
+00064 #undef SQLGetConnectAttr
+00065 #define SQLGetConnectAttr(hdbc, fOption, ValuePtr, BufferLength, NULL) \
+00066     SQLGetConnectOption(hdbc, fOption, ValuePtr)
+00067 
+00068 #undef SQLSetConnectAttr
+00069 #define SQLSetConnectAttr(hdbc, fOption, ValuePtr, BufferLength) \
+00070         SQLSetConnectOption(hdbc, fOption, (SQLUINTEGER) ValuePtr)
+00071 
+00072 #undef SQLSetStmtAttr
+00073 #define SQLSetStmtAttr(hstmt, fOption, ValuePtr, BufferLength) (0); return APR_ENOTIMPL;
+00074 
+00075 #undef SQLEndTran
+00076 #define SQLEndTran(hType, hdbc,type)  SQLTransact(henv, hdbc, type)
+00077 
+00078 #undef SQLFetchScroll
+00079 #define SQLFetchScroll(stmt, orient, rownum) (0); return APR_ENOTIMPL;
+00080 
+00081 #define SQL_DESC_TYPE           SQL_COLUMN_TYPE
+00082 #define SQL_DESC_CONCISE_TYPE   SQL_COLUMN_TYPE
+00083 #define SQL_DESC_DISPLAY_SIZE   SQL_COLUMN_DISPLAY_SIZE
+00084 #define SQL_DESC_OCTET_LENGTH   SQL_COLUMN_LENGTH
+00085 #define SQL_DESC_UNSIGNED       SQL_COLUMN_UNSIGNED
+00086 
+00087 #undef SQLColAttribute
+00088 #define SQLColAttribute(s, c, f, a, l, m, n) SQLColAttributes(s, c, f, a, l, m, n)
+00089 
+00090 #define SQL_ATTR_ACCESS_MODE            SQL_ACCESS_MODE
+00091 #define SQL_ATTR_AUTOCOMMIT                     SQL_AUTOCOMMIT
+00092 #define SQL_ATTR_CONNECTION_TIMEOUT     113
+00093 #define SQL_ATTR_CURRENT_CATALOG        SQL_CURRENT_QUALIFIER
+00094 #define SQL_ATTR_DISCONNECT_BEHAVIOR    114
+00095 #define SQL_ATTR_ENLIST_IN_DTC          1207
+00096 #define SQL_ATTR_ENLIST_IN_XA           1208
+00097 
+00098 #define SQL_ATTR_CONNECTION_DEAD        1209
+00099 #define SQL_CD_TRUE                                     1L              /* Connection is closed/dead */
+00100 #define SQL_CD_FALSE                            0L              /* Connection is open/available */
+00101 
+00102 #define SQL_ATTR_LOGIN_TIMEOUT          SQL_LOGIN_TIMEOUT
+00103 #define SQL_ATTR_ODBC_CURSORS           SQL_ODBC_CURSORS
+00104 #define SQL_ATTR_PACKET_SIZE            SQL_PACKET_SIZE
+00105 #define SQL_ATTR_QUIET_MODE                     SQL_QUIET_MODE
+00106 #define SQL_ATTR_TRACE                          SQL_OPT_TRACE
+00107 #define SQL_ATTR_TRACEFILE                      SQL_OPT_TRACEFILE
+00108 #define SQL_ATTR_TRANSLATE_LIB          SQL_TRANSLATE_DLL
+00109 #define SQL_ATTR_TRANSLATE_OPTION       SQL_TRANSLATE_OPTION
+00110 #define SQL_ATTR_TXN_ISOLATION          SQL_TXN_ISOLATION
+00111 
+00112 #define SQL_ATTR_CURSOR_SCROLLABLE -1
+00113 
+00114 #define SQL_C_SBIGINT   (SQL_BIGINT+SQL_SIGNED_OFFSET)     /* SIGNED BIGINT */
+00115 #define SQL_C_UBIGINT   (SQL_BIGINT+SQL_UNSIGNED_OFFSET)   /* UNSIGNED BIGINT */
+00116 
+00117 #define SQL_FALSE           0
+00118 #define SQL_TRUE            1
+00119 
+

Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by + +

1.5.8

+ + Added: apr/site/trunk/docs/docs/apr/trunk/apr__dbm_8h-source.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/apr__dbm_8h-source.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/apr__dbm_8h-source.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/apr__dbm_8h-source.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,258 @@ + + +Apache Portable Runtime: apr_dbm.h Source File + + + + +

File List
Globals

apr_dbm.h

Go to the documentation of this file.

00001 /* Licensed to the Apache Software Foundation (ASF) under one or more
+00002  * contributor license agreements.  See the NOTICE file distributed with
+00003  * this work for additional information regarding copyright ownership.
+00004  * The ASF licenses this file to You under the Apache License, Version 2.0
+00005  * (the "License"); you may not use this file except in compliance with
+00006  * the License.  You may obtain a copy of the License at
+00007  *
+00008  *     http://www.apache.org/licenses/LICENSE-2.0
+00009  *
+00010  * Unless required by applicable law or agreed to in writing, software
+00011  * distributed under the License is distributed on an "AS IS" BASIS,
+00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+00013  * See the License for the specific language governing permissions and
+00014  * limitations under the License.
+00015  */
+00016 
+00017 #ifndef APR_DBM_H
+00018 #define APR_DBM_H
+00019 
+00020 #include "apu.h"
+00021 #include "apr.h"
+00022 #include "apr_errno.h"
+00023 #include "apr_pools.h"
+00024 #include "apr_file_info.h"
+00025 
+00026 #ifdef __cplusplus
+00027 extern "C" {
+00028 #endif
+00029 
+00030 /**
+00031  * @file apr_dbm.h
+00032  * @brief APR-UTIL DBM library
+00033  */
+00034 /** 
+00035  * @defgroup APR_Util_DBM DBM routines
+00036  * @ingroup APR_Util
+00037  * @{
+00038  */
+00039 /**
+00040  * Structure for referencing a dbm
+00041  */
+00042 typedef struct apr_dbm_t apr_dbm_t;
+00043 
+00044 /**
+00045  * Structure for referencing the datum record within a dbm
+00046  */
+00047 typedef struct
+00048 {
+00049     /** pointer to the 'data' to retrieve/store in the DBM */
+00050     char *dptr;
+00051     /** size of the 'data' to retrieve/store in the DBM */
+00052     apr_size_t dsize;
+00053 } apr_datum_t;
+00054 
+00055 /* modes to open the DB */
+00056 #define APR_DBM_READONLY        1       /**< open for read-only access */
+00057 #define APR_DBM_READWRITE       2       /**< open for read-write access */
+00058 #define APR_DBM_RWCREATE        3       /**< open for r/w, create if needed */
+00059 #define APR_DBM_RWTRUNC         4       /**< open for r/w, truncating an existing
+00060                                           DB if present */
+00061 /**
+00062  * Open a dbm file by file name and type of DBM
+00063  * @param dbm The newly opened database
+00064  * @param type The type of the DBM (not all may be available at run time)
+00065  * <pre>
+00066  *  db   for Berkeley DB files
+00067  *  gdbm for GDBM files
+00068  *  ndbm for NDBM files
+00069  *  sdbm for SDBM files (always available)
+00070  *  default for the default DBM type
+00071  *  </pre>
+00072  * @param name The dbm file name to open
+00073  * @param mode The flag value
+00074  * <PRE>
+00075  *           APR_DBM_READONLY   open for read-only access
+00076  *           APR_DBM_READWRITE  open for read-write access
+00077  *           APR_DBM_RWCREATE   open for r/w, create if needed
+00078  *           APR_DBM_RWTRUNC    open for r/w, truncate if already there
+00079  * </PRE>
+00080  * @param perm Permissions to apply to if created
+00081  * @param cntxt The pool to use when creating the dbm
+00082  * @remark The dbm name may not be a true file name, as many dbm packages
+00083  * append suffixes for seperate data and index files.
+00084  * @bug In apr-util 0.9 and 1.x, the type arg was case insensitive.  This
+00085  * was highly inefficient, and as of 2.x the dbm name must be provided in
+00086  * the correct case (lower case for all bundled providers)
+00087  */
+00088 
+00089 APU_DECLARE(apr_status_t) apr_dbm_open_ex(apr_dbm_t **dbm, const char* type, 
+00090                                        const char *name, 
+00091                                        apr_int32_t mode, apr_fileperms_t perm,
+00092                                        apr_pool_t *cntxt);
+00093 
+00094 
+00095 /**
+00096  * Open a dbm file by file name
+00097  * @param dbm The newly opened database
+00098  * @param name The dbm file name to open
+00099  * @param mode The flag value
+00100  * <PRE>
+00101  *           APR_DBM_READONLY   open for read-only access
+00102  *           APR_DBM_READWRITE  open for read-write access
+00103  *           APR_DBM_RWCREATE   open for r/w, create if needed
+00104  *           APR_DBM_RWTRUNC    open for r/w, truncate if already there
+00105  * </PRE>
+00106  * @param perm Permissions to apply to if created
+00107  * @param cntxt The pool to use when creating the dbm
+00108  * @remark The dbm name may not be a true file name, as many dbm packages
+00109  * append suffixes for seperate data and index files.
+00110  */
+00111 APU_DECLARE(apr_status_t) apr_dbm_open(apr_dbm_t **dbm, const char *name, 
+00112                                        apr_int32_t mode, apr_fileperms_t perm,
+00113                                        apr_pool_t *cntxt);
+00114 
+00115 /**
+00116  * Close a dbm file previously opened by apr_dbm_open
+00117  * @param dbm The database to close
+00118  */
+00119 APU_DECLARE(void) apr_dbm_close(apr_dbm_t *dbm);
+00120 
+00121 /**
+00122  * Fetch a dbm record value by key
+00123  * @param dbm The database 
+00124  * @param key The key datum to find this record
+00125  * @param pvalue The value datum retrieved for this record
+00126  */
+00127 APU_DECLARE(apr_status_t) apr_dbm_fetch(apr_dbm_t *dbm, apr_datum_t key,
+00128                                         apr_datum_t *pvalue);
+00129 /**
+00130  * Store a dbm record value by key
+00131  * @param dbm The database 
+00132  * @param key The key datum to store this record by
+00133  * @param value The value datum to store in this record
+00134  */
+00135 APU_DECLARE(apr_status_t) apr_dbm_store(apr_dbm_t *dbm, apr_datum_t key, 
+00136                                         apr_datum_t value);
+00137 
+00138 /**
+00139  * Delete a dbm record value by key
+00140  * @param dbm The database 
+00141  * @param key The key datum of the record to delete
+00142  * @remark It is not an error to delete a non-existent record.
+00143  */
+00144 APU_DECLARE(apr_status_t) apr_dbm_delete(apr_dbm_t *dbm, apr_datum_t key);
+00145 
+00146 /**
+00147  * Search for a key within the dbm
+00148  * @param dbm The database 
+00149  * @param key The datum describing a key to test
+00150  */
+00151 APU_DECLARE(int) apr_dbm_exists(apr_dbm_t *dbm, apr_datum_t key);
+00152 
+00153 /**
+00154  * Retrieve the first record key from a dbm
+00155  * @param dbm The database 
+00156  * @param pkey The key datum of the first record
+00157  */
+00158 APU_DECLARE(apr_status_t) apr_dbm_firstkey(apr_dbm_t *dbm, apr_datum_t *pkey);
+00159 
+00160 /**
+00161  * Retrieve the next record key from a dbm
+00162  * @param dbm The database 
+00163  * @param pkey The key datum of the next record
+00164  */
+00165 APU_DECLARE(apr_status_t) apr_dbm_nextkey(apr_dbm_t *dbm, apr_datum_t *pkey);
+00166 
+00167 /**
+00168  * Proactively toss any memory associated with the apr_datum_t.
+00169  * @param dbm The database 
+00170  * @param data The datum to free.
+00171  */
+00172 APU_DECLARE(void) apr_dbm_freedatum(apr_dbm_t *dbm, apr_datum_t data);
+00173 
+00174 /**
+00175  * Report more information when an apr_dbm function fails.
+00176  * @param dbm The database
+00177  * @param errcode A DBM-specific value for the error (for logging). If this
+00178  *                isn't needed, it may be NULL.
+00179  * @param errbuf Location to store the error text
+00180  * @param errbufsize The size of the provided buffer
+00181  * @return The errbuf parameter, for convenience.
+00182  */
+00183 APU_DECLARE(char *) apr_dbm_geterror(apr_dbm_t *dbm, int *errcode,
+00184                                      char *errbuf, apr_size_t errbufsize);
+00185 /**
+00186  * If the specified file/path were passed to apr_dbm_open(), return the
+00187  * actual file/path names which would be (created and) used. At most, two
+00188  * files may be used; used2 may be NULL if only one file is used.
+00189  * @param pool The pool for allocating used1 and used2.
+00190  * @param type The type of DBM you require info on @see apr_dbm_open_ex
+00191  * @param pathname The path name to generate used-names from.
+00192  * @param used1 The first pathname used by the apr_dbm implementation.
+00193  * @param used2 The second pathname used by apr_dbm. If only one file is
+00194  *              used by the specific implementation, this will be set to NULL.
+00195  * @return An error if the specified type is invalid.
+00196  * @remark The dbm file(s) don't need to exist. This function only manipulates
+00197  *      the pathnames.
+00198  */
+00199 APU_DECLARE(apr_status_t) apr_dbm_get_usednames_ex(apr_pool_t *pool,
+00200                                                    const char *type,
+00201                                                    const char *pathname,
+00202                                                    const char **used1,
+00203                                                    const char **used2);
+00204 
+00205 /**
+00206  * If the specified file/path were passed to apr_dbm_open(), return the
+00207  * actual file/path names which would be (created and) used. At most, two
+00208  * files may be used; used2 may be NULL if only one file is used.
+00209  * @param pool The pool for allocating used1 and used2.
+00210  * @param pathname The path name to generate used-names from.
+00211  * @param used1 The first pathname used by the apr_dbm implementation.
+00212  * @param used2 The second pathname used by apr_dbm. If only one file is
+00213  *              used by the specific implementation, this will be set to NULL.
+00214  * @remark The dbm file(s) don't need to exist. This function only manipulates
+00215  *      the pathnames.
+00216  */
+00217 APU_DECLARE(void) apr_dbm_get_usednames(apr_pool_t *pool,
+00218                                         const char *pathname,
+00219                                         const char **used1,
+00220                                         const char **used2);
+00221 
+00222 /** @} */
+00223 #ifdef __cplusplus
+00224 }
+00225 #endif
+00226 
+00227 #endif  /* !APR_DBM_H */
+

Generated on Mon Jun 15 09:45:28 2009 for Apache Portable Runtime by + +

1.5.8

+ +