<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Apache Portable Runtime: apr_dbd.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <div class="header"> <div class="headertitle"> <h1>apr_dbd.h</h1> </div> </div> <div class="contents"> <a href="apr__dbd_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span> <a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span> <a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span> <a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span> <a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span> <a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span> <a name="l00007"></a>00007 <span class="comment"> *</span> <a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> <a name="l00009"></a>00009 <span class="comment"> *</span> <a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> <a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> <a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> <a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span> <a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span> <a name="l00015"></a>00015 <span class="comment"> */</span> <a name="l00016"></a>00016 <a name="l00017"></a>00017 <span class="comment">/* Overview of what this is and does:</span> <a name="l00018"></a>00018 <span class="comment"> * http://www.apache.org/~niq/dbd.html</span> <a name="l00019"></a>00019 <span class="comment"> */</span> <a name="l00020"></a>00020 <a name="l00021"></a>00021 <span class="preprocessor">#ifndef APR_DBD_H</span> <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define APR_DBD_H</span> <a name="l00023"></a>00023 <span class="preprocessor"></span> <a name="l00024"></a>00024 <span class="preprocessor">#include "apu.h"</span> <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span> <a name="l00026"></a>00026 <a name="l00027"></a>00027 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00028"></a>00028 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { <a name="l00029"></a>00029 <span class="preprocessor">#endif</span> <a name="l00030"></a>00030 <span class="preprocessor"></span><span class="comment"></span> <a name="l00031"></a>00031 <span class="comment">/**</span> <a name="l00032"></a>00032 <span class="comment"> * @file apr_dbd.h</span> <a name="l00033"></a>00033 <span class="comment"> * @brief APR-UTIL DBD library</span> <a name="l00034"></a>00034 <span class="comment"> */</span><span class="comment"></span> <a name="l00035"></a>00035 <span class="comment">/**</span> <a name="l00036"></a>00036 <span class="comment"> * @defgroup APR_Util_DBD DBD routines</span> <a name="l00037"></a>00037 <span class="comment"> * @ingroup APR_Util</span> <a name="l00038"></a>00038 <span class="comment"> * @{</span> <a name="l00039"></a>00039 <span class="comment"> */</span> <a name="l00040"></a>00040 <span class="comment"></span> <a name="l00041"></a>00041 <span class="comment">/**</span> <a name="l00042"></a>00042 <span class="comment"> * Mapping of C to SQL types, used for prepared statements.</span> <a name="l00043"></a>00043 <span class="comment"> * @remarks</span> <a name="l00044"></a>00044 <span class="comment"> * For apr_dbd_p[v]query/select functions, in and out parameters are always</span> <a name="l00045"></a>00045 <span class="comment"> * const char * (i.e. regular nul terminated strings). LOB types are passed</span> <a name="l00046"></a>00046 <span class="comment"> * with four (4) arguments: payload, length, table and column, all as const</span> <a name="l00047"></a>00047 <span class="comment"> * char *, where table and column are reserved for future use by Oracle.</span> <a name="l00048"></a>00048 <span class="comment"> * @remarks</span> <a name="l00049"></a>00049 <span class="comment"> * For apr_dbd_p[v]bquery/select functions, in and out parameters are</span> <a name="l00050"></a>00050 <span class="comment"> * described next to each enumeration constant and are generally native binary</span> <a name="l00051"></a>00051 <span class="comment"> * types or some APR data type. LOB types are passed with four (4) arguments:</span> <a name="l00052"></a>00052 <span class="comment"> * payload (char*), length (apr_size_t*), table (char*) and column (char*).</span> <a name="l00053"></a>00053 <span class="comment"> * Table and column are reserved for future use by Oracle.</span> <a name="l00054"></a>00054 <span class="comment"> */</span> <a name="l00055"></a><a class="code" href="group___a_p_r___util___d_b_d.html#ga19608fa5d518a5121bee23daacc5c230">00055</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> { <a name="l00056"></a>00056 APR_DBD_TYPE_NONE, <a name="l00057"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230acc06ee0f3fe0c65b9f8265053550e4ee">00057</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230acc06ee0f3fe0c65b9f8265053550e4ee">APR_DBD_TYPE_TINY</a>, <span class="comment">/**< \%hhd : in, out: char* */</span> <a name="l00058"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230aaa4f167bb26fa3e85b0d61f34713ebb6">00058</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230aaa4f167bb26fa3e85b0d61f34713ebb6">APR_DBD_TYPE_UTINY</a>, <span class="comment">/**< \%hhu : in, out: unsigned char* */</span> <a name="l00059"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a0c38d32785a3cbddbe4ba692fdde16ee">00059</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a0c38d32785a3cbddbe4ba692fdde16ee">APR_DBD_TYPE_SHORT</a>, <span class="comment">/**< \%hd : in, out: short* */</span> <a name="l00060"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230af3518efb67af10100b92578b5c867c9c">00060</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230af3518efb67af10100b92578b5c867c9c">APR_DBD_TYPE_USHORT</a>, <span class="comment">/**< \%hu : in, out: unsigned short* */</span> <a name="l00061"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a4df919bac6f5b56257bfe63ed3e5968c">00061</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a4df919bac6f5b56257bfe63ed3e5968c">APR_DBD_TYPE_INT</a>, <span class="comment">/**< \%d : in, out: int* */</span> <a name="l00062"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a58b37a24a35ddf144a9132a9837ed3d3">00062</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a58b37a24a35ddf144a9132a9837ed3d3">APR_DBD_TYPE_UINT</a>, <span class="comment">/**< \%u : in, out: unsigned int* */</span> <a name="l00063"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230add86aa288504ec2d4194f35a3a8ac55a">00063</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230add86aa288504ec2d4194f35a3a8ac55a">APR_DBD_TYPE_LONG</a>, <span class="comment">/**< \%ld : in, out: long* */</span> <a name="l00064"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a4186d52d5ce586cd7559a0ae8737cbb7">00064</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a4186d52d5ce586cd7559a0ae8737cbb7">APR_DBD_TYPE_ULONG</a>, <span class="comment">/**< \%lu : in, out: unsigned long* */</span> <a name="l00065"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a8821461a3390bd0a001e714d2180ae6c">00065</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a8821461a3390bd0a001e714d2180ae6c">APR_DBD_TYPE_LONGLONG</a>, <span class="comment">/**< \%lld : in, out: apr_int64_t* */</span> <a name="l00066"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ad1907d3eb1235acfa8a971fce43711c5">00066</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ad1907d3eb1235acfa8a971fce43711c5">APR_DBD_TYPE_ULONGLONG</a>, <span class="comment">/**< \%llu : in, out: apr_uint64_t* */</span> <a name="l00067"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a14281587071981d4e6b25de5bb747e98">00067</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a14281587071981d4e6b25de5bb747e98">APR_DBD_TYPE_FLOAT</a>, <span class="comment">/**< \%f : in, out: float* */</span> <a name="l00068"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a77c20702c7c6566369d3ccc894eb9cd8">00068</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a77c20702c7c6566369d3ccc894eb9cd8">APR_DBD_TYPE_DOUBLE</a>, <span class="comment">/**< \%lf : in, out: double* */</span> <a name="l00069"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a4c9490a29ed882c46fa738e7cddede44">00069</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a4c9490a29ed882c46fa738e7cddede44">APR_DBD_TYPE_STRING</a>, <span class="comment">/**< \%s : in: char*, out: char** */</span> <a name="l00070"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ae06c20e9edcd46964dc26bb43134e0e6">00070</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ae06c20e9edcd46964dc26bb43134e0e6">APR_DBD_TYPE_TEXT</a>, <span class="comment">/**< \%pDt : in: char*, out: char** */</span> <a name="l00071"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a2ad65674a89072f4582e97d0a4fad61d">00071</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a2ad65674a89072f4582e97d0a4fad61d">APR_DBD_TYPE_TIME</a>, <span class="comment">/**< \%pDi : in: char*, out: char** */</span> <a name="l00072"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ab96a2b4b2b1fb94a7faeb01065d77835">00072</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ab96a2b4b2b1fb94a7faeb01065d77835">APR_DBD_TYPE_DATE</a>, <span class="comment">/**< \%pDd : in: char*, out: char** */</span> <a name="l00073"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a77bb0dd82ed396f7056ba2aaddd44265">00073</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a77bb0dd82ed396f7056ba2aaddd44265">APR_DBD_TYPE_DATETIME</a>, <span class="comment">/**< \%pDa : in: char*, out: char** */</span> <a name="l00074"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a5cffb0a0cc618ab3d0c187ca176d61ad">00074</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a5cffb0a0cc618ab3d0c187ca176d61ad">APR_DBD_TYPE_TIMESTAMP</a>, <span class="comment">/**< \%pDs : in: char*, out: char** */</span> <a name="l00075"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ae4db1948f1f1ef7651c5f01c12d1e56a">00075</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230ae4db1948f1f1ef7651c5f01c12d1e56a">APR_DBD_TYPE_ZTIMESTAMP</a>, <span class="comment">/**< \%pDz : in: char*, out: char** */</span> <a name="l00076"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a60d6a6ab49b20a306443b7a9ad8c6f11">00076</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a60d6a6ab49b20a306443b7a9ad8c6f11">APR_DBD_TYPE_BLOB</a>, <span class="comment">/**< \%pDb : in: char* apr_size_t* char* char*, out: apr_bucket_brigade* */</span> <a name="l00077"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230adf428a7365d71eacdf24a89c202c1f72">00077</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230adf428a7365d71eacdf24a89c202c1f72">APR_DBD_TYPE_CLOB</a>, <span class="comment">/**< \%pDc : in: char* apr_size_t* char* char*, out: apr_bucket_brigade* */</span> <a name="l00078"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a706a286af4fe4a9b97ee68adc11cd6cc">00078</a> <a class="code" href="group___a_p_r___util___d_b_d.html#gga19608fa5d518a5121bee23daacc5c230a706a286af4fe4a9b97ee68adc11cd6cc">APR_DBD_TYPE_NULL</a> <span class="comment">/**< \%pDn : in: void*, out: void** */</span> <a name="l00079"></a>00079 } <a class="code" href="group___a_p_r___util___d_b_d.html#ga19608fa5d518a5121bee23daacc5c230">apr_dbd_type_e</a>; <a name="l00080"></a>00080 <a name="l00081"></a>00081 <span class="comment">/* These are opaque structs. Instantiation is up to each backend */</span> <a name="l00082"></a>00082 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_dbd_driver_t apr_dbd_driver_t; <a name="l00083"></a>00083 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_dbd_t apr_dbd_t; <a name="l00084"></a>00084 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_dbd_transaction_t apr_dbd_transaction_t; <a name="l00085"></a>00085 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_dbd_results_t apr_dbd_results_t; <a name="l00086"></a>00086 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_dbd_row_t apr_dbd_row_t; <a name="l00087"></a>00087 <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_dbd_prepared_t apr_dbd_prepared_t; <a name="l00088"></a>00088 <span class="comment"></span> <a name="l00089"></a>00089 <span class="comment">/** apr_dbd_init: perform once-only initialisation. Call once only.</span> <a name="l00090"></a>00090 <span class="comment"> *</span> <a name="l00091"></a>00091 <span class="comment"> * @param pool - pool to register any shutdown cleanups, etc</span> <a name="l00092"></a>00092 <span class="comment"> */</span> <a name="l00093"></a>00093 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga7969f50d38bda792cbef72136300a574">apr_dbd_init</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool); <a name="l00094"></a>00094 <span class="comment"></span> <a name="l00095"></a>00095 <span class="comment">/** apr_dbd_get_driver: get the driver struct for a name</span> <a name="l00096"></a>00096 <span class="comment"> *</span> <a name="l00097"></a>00097 <span class="comment"> * @param pool - (process) pool to register cleanup</span> <a name="l00098"></a>00098 <span class="comment"> * @param name - driver name</span> <a name="l00099"></a>00099 <span class="comment"> * @param driver - pointer to driver struct.</span> <a name="l00100"></a>00100 <span class="comment"> * @return APR_SUCCESS for success</span> <a name="l00101"></a>00101 <span class="comment"> * @return APR_ENOTIMPL for no driver (when DSO not enabled)</span> <a name="l00102"></a>00102 <span class="comment"> * @return APR_EDSOOPEN if DSO driver file can't be opened</span> <a name="l00103"></a>00103 <span class="comment"> * @return APR_ESYMNOTFOUND if the driver file doesn't contain a driver</span> <a name="l00104"></a>00104 <span class="comment"> */</span> <a name="l00105"></a>00105 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga8ba85faccf7e8eea525812f8f2dfed25">apr_dbd_get_driver</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const <span class="keywordtype">char</span> *name, <a name="l00106"></a>00106 const apr_dbd_driver_t **driver); <a name="l00107"></a>00107 <span class="comment"></span> <a name="l00108"></a>00108 <span class="comment">/** apr_dbd_open_ex: open a connection to a backend</span> <a name="l00109"></a>00109 <span class="comment"> *</span> <a name="l00110"></a>00110 <span class="comment"> * @param pool - working pool</span> <a name="l00111"></a>00111 <span class="comment"> * @param params - arguments to driver (implementation-dependent)</span> <a name="l00112"></a>00112 <span class="comment"> * @param handle - pointer to handle to return</span> <a name="l00113"></a>00113 <span class="comment"> * @param driver - driver struct.</span> <a name="l00114"></a>00114 <span class="comment"> * @param error - descriptive error.</span> <a name="l00115"></a>00115 <span class="comment"> * @return APR_SUCCESS for success</span> <a name="l00116"></a>00116 <span class="comment"> * @return APR_EGENERAL if driver exists but connection failed</span> <a name="l00117"></a>00117 <span class="comment"> * @remarks PostgreSQL: the params is passed directly to the PQconnectdb()</span> <a name="l00118"></a>00118 <span class="comment"> * function (check PostgreSQL documentation for more details on the syntax).</span> <a name="l00119"></a>00119 <span class="comment"> * @remarks SQLite2: the params is split on a colon, with the first part used</span> <a name="l00120"></a>00120 <span class="comment"> * as the filename and second part converted to an integer and used as file</span> <a name="l00121"></a>00121 <span class="comment"> * mode.</span> <a name="l00122"></a>00122 <span class="comment"> * @remarks SQLite3: the params is passed directly to the sqlite3_open()</span> <a name="l00123"></a>00123 <span class="comment"> * function as a filename to be opened (check SQLite3 documentation for more</span> <a name="l00124"></a>00124 <span class="comment"> * details).</span> <a name="l00125"></a>00125 <span class="comment"> * @remarks Oracle: the params can have "user", "pass", "dbname" and "server"</span> <a name="l00126"></a>00126 <span class="comment"> * keys, each followed by an equal sign and a value. Such key/value pairs can</span> <a name="l00127"></a>00127 <span class="comment"> * be delimited by space, CR, LF, tab, semicolon, vertical bar or comma.</span> <a name="l00128"></a>00128 <span class="comment"> * @remarks MySQL: the params can have "host", "port", "user", "pass",</span> <a name="l00129"></a>00129 <span class="comment"> * "dbname", "sock", "flags" "fldsz", "group" and "reconnect" keys, each</span> <a name="l00130"></a>00130 <span class="comment"> * followed by an equal sign and a value. Such key/value pairs can be</span> <a name="l00131"></a>00131 <span class="comment"> * delimited by space, CR, LF, tab, semicolon, vertical bar or comma. For</span> <a name="l00132"></a>00132 <span class="comment"> * now, "flags" can only recognise CLIENT_FOUND_ROWS (check MySQL manual for</span> <a name="l00133"></a>00133 <span class="comment"> * details). The value associated with "fldsz" determines maximum amount of</span> <a name="l00134"></a>00134 <span class="comment"> * memory (in bytes) for each of the fields in the result set of prepared</span> <a name="l00135"></a>00135 <span class="comment"> * statements. By default, this value is 1 MB. The value associated with</span> <a name="l00136"></a>00136 <span class="comment"> * "group" determines which group from configuration file to use (see</span> <a name="l00137"></a>00137 <span class="comment"> * MYSQL_READ_DEFAULT_GROUP option of mysql_options() in MySQL manual).</span> <a name="l00138"></a>00138 <span class="comment"> * Reconnect is set to 1 by default (i.e. true).</span> <a name="l00139"></a>00139 <span class="comment"> * @remarks FreeTDS: the params can have "username", "password", "appname",</span> <a name="l00140"></a>00140 <span class="comment"> * "dbname", "host", "charset", "lang" and "server" keys, each followed by an</span> <a name="l00141"></a>00141 <span class="comment"> * equal sign and a value.</span> <a name="l00142"></a>00142 <span class="comment"> */</span> <a name="l00143"></a>00143 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_d.html#gabddb1fdcb2f8a5f5b83127485c78e8ae">apr_dbd_open_ex</a>(const apr_dbd_driver_t *driver, <a name="l00144"></a>00144 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const <span class="keywordtype">char</span> *params, <a name="l00145"></a>00145 apr_dbd_t **handle, <a name="l00146"></a>00146 const <span class="keywordtype">char</span> **error); <a name="l00147"></a>00147 <span class="comment"></span> <a name="l00148"></a>00148 <span class="comment">/** apr_dbd_open: open a connection to a backend</span> <a name="l00149"></a>00149 <span class="comment"> *</span> <a name="l00150"></a>00150 <span class="comment"> * @param pool - working pool</span> <a name="l00151"></a>00151 <span class="comment"> * @param params - arguments to driver (implementation-dependent)</span> <a name="l00152"></a>00152 <span class="comment"> * @param handle - pointer to handle to return</span> <a name="l00153"></a>00153 <span class="comment"> * @param driver - driver struct.</span> <a name="l00154"></a>00154 <span class="comment"> * @return APR_SUCCESS for success</span> <a name="l00155"></a>00155 <span class="comment"> * @return APR_EGENERAL if driver exists but connection failed</span> <a name="l00156"></a>00156 <span class="comment"> * @see apr_dbd_open_ex</span> <a name="l00157"></a>00157 <span class="comment"> */</span> <a name="l00158"></a>00158 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_d.html#gaeff12b01f78ac78721acc4a0a318e673">apr_dbd_open</a>(const apr_dbd_driver_t *driver, <a name="l00159"></a>00159 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const <span class="keywordtype">char</span> *params, <a name="l00160"></a>00160 apr_dbd_t **handle); <a name="l00161"></a>00161 <span class="comment"></span> <a name="l00162"></a>00162 <span class="comment">/** apr_dbd_close: close a connection to a backend</span> <a name="l00163"></a>00163 <span class="comment"> *</span> <a name="l00164"></a>00164 <span class="comment"> * @param handle - handle to close</span> <a name="l00165"></a>00165 <span class="comment"> * @param driver - driver struct.</span> <a name="l00166"></a>00166 <span class="comment"> * @return APR_SUCCESS for success or error status</span> <a name="l00167"></a>00167 <span class="comment"> */</span> <a name="l00168"></a>00168 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga4abe00d844cd547cc69880fe14af4aca">apr_dbd_close</a>(const apr_dbd_driver_t *driver, <a name="l00169"></a>00169 apr_dbd_t *handle); <a name="l00170"></a>00170 <a name="l00171"></a>00171 <span class="comment">/* apr-function-shaped versions of things */</span> <a name="l00172"></a>00172 <span class="comment"></span> <a name="l00173"></a>00173 <span class="comment">/** apr_dbd_name: get the name of the driver</span> <a name="l00174"></a>00174 <span class="comment"> *</span> <a name="l00175"></a>00175 <span class="comment"> * @param driver - the driver</span> <a name="l00176"></a>00176 <span class="comment"> * @return - name</span> <a name="l00177"></a>00177 <span class="comment"> */</span> <a name="l00178"></a>00178 APU_DECLARE(const <span class="keywordtype">char</span>*) <a class="code" href="group___a_p_r___util___d_b_d.html#ga7a14e0073a36bd97dd82baa5f20e874c">apr_dbd_name</a>(const apr_dbd_driver_t *driver); <a name="l00179"></a>00179 <span class="comment"></span> <a name="l00180"></a>00180 <span class="comment">/** apr_dbd_native_handle: get native database handle of the underlying db</span> <a name="l00181"></a>00181 <span class="comment"> *</span> <a name="l00182"></a>00182 <span class="comment"> * @param driver - the driver</span> <a name="l00183"></a>00183 <span class="comment"> * @param handle - apr_dbd handle</span> <a name="l00184"></a>00184 <span class="comment"> * @return - native handle</span> <a name="l00185"></a>00185 <span class="comment"> */</span> <a name="l00186"></a>00186 APU_DECLARE(<span class="keywordtype">void</span>*) <a class="code" href="group___a_p_r___util___d_b_d.html#gab2a238e15942e66a2b92836c392d5334">apr_dbd_native_handle</a>(const apr_dbd_driver_t *driver, <a name="l00187"></a>00187 apr_dbd_t *handle); <a name="l00188"></a>00188 <span class="comment"></span> <a name="l00189"></a>00189 <span class="comment">/** check_conn: check status of a database connection</span> <a name="l00190"></a>00190 <span class="comment"> *</span> <a name="l00191"></a>00191 <span class="comment"> * @param driver - the driver</span> <a name="l00192"></a>00192 <span class="comment"> * @param pool - working pool</span> <a name="l00193"></a>00193 <span class="comment"> * @param handle - the connection to check</span> <a name="l00194"></a>00194 <span class="comment"> * @return APR_SUCCESS or error</span> <a name="l00195"></a>00195 <span class="comment"> */</span> <a name="l00196"></a>00196 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#gae3fca3b3c05f835f9849668a338d82d1">apr_dbd_check_conn</a>(const apr_dbd_driver_t *driver, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00197"></a>00197 apr_dbd_t *handle); <a name="l00198"></a>00198 <span class="comment"></span> <a name="l00199"></a>00199 <span class="comment">/** apr_dbd_set_dbname: select database name. May be a no-op if not supported.</span> <a name="l00200"></a>00200 <span class="comment"> *</span> <a name="l00201"></a>00201 <span class="comment"> * @param driver - the driver</span> <a name="l00202"></a>00202 <span class="comment"> * @param pool - working pool</span> <a name="l00203"></a>00203 <span class="comment"> * @param handle - the connection</span> <a name="l00204"></a>00204 <span class="comment"> * @param name - the database to select</span> <a name="l00205"></a>00205 <span class="comment"> * @return 0 for success or error code</span> <a name="l00206"></a>00206 <span class="comment"> */</span> <a name="l00207"></a>00207 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#gafecb22f98684f29e579fd73eb58b1e86">apr_dbd_set_dbname</a>(const apr_dbd_driver_t *driver, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00208"></a>00208 apr_dbd_t *handle, const <span class="keywordtype">char</span> *name); <a name="l00209"></a>00209 <span class="comment"></span> <a name="l00210"></a>00210 <span class="comment">/** apr_dbd_transaction_start: start a transaction. May be a no-op.</span> <a name="l00211"></a>00211 <span class="comment"> *</span> <a name="l00212"></a>00212 <span class="comment"> * @param driver - the driver</span> <a name="l00213"></a>00213 <span class="comment"> * @param pool - a pool to use for error messages (if any).</span> <a name="l00214"></a>00214 <span class="comment"> * @param handle - the db connection</span> <a name="l00215"></a>00215 <span class="comment"> * @param trans - ptr to a transaction. May be null on entry</span> <a name="l00216"></a>00216 <span class="comment"> * @return 0 for success or error code</span> <a name="l00217"></a>00217 <span class="comment"> * @remarks Note that transaction modes, set by calling</span> <a name="l00218"></a>00218 <span class="comment"> * apr_dbd_transaction_mode_set(), will affect all query/select calls within</span> <a name="l00219"></a>00219 <span class="comment"> * a transaction. By default, any error in query/select during a transaction</span> <a name="l00220"></a>00220 <span class="comment"> * will cause the transaction to inherit the error code and any further</span> <a name="l00221"></a>00221 <span class="comment"> * query/select calls will fail immediately. Put transaction in "ignore</span> <a name="l00222"></a>00222 <span class="comment"> * errors" mode to avoid that. Use "rollback" mode to do explicit rollback.</span> <a name="l00223"></a>00223 <span class="comment"> */</span> <a name="l00224"></a>00224 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga1c401df12087d3bf1f15a9b80a8f572d">apr_dbd_transaction_start</a>(const apr_dbd_driver_t *driver, <a name="l00225"></a>00225 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00226"></a>00226 apr_dbd_t *handle, <a name="l00227"></a>00227 apr_dbd_transaction_t **trans); <a name="l00228"></a>00228 <span class="comment"></span> <a name="l00229"></a>00229 <span class="comment">/** apr_dbd_transaction_end: end a transaction</span> <a name="l00230"></a>00230 <span class="comment"> * (commit on success, rollback on error).</span> <a name="l00231"></a>00231 <span class="comment"> * May be a no-op.</span> <a name="l00232"></a>00232 <span class="comment"> *</span> <a name="l00233"></a>00233 <span class="comment"> * @param driver - the driver</span> <a name="l00234"></a>00234 <span class="comment"> * @param handle - the db connection</span> <a name="l00235"></a>00235 <span class="comment"> * @param trans - the transaction.</span> <a name="l00236"></a>00236 <span class="comment"> * @return 0 for success or error code</span> <a name="l00237"></a>00237 <span class="comment"> */</span> <a name="l00238"></a>00238 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga6f3a5d6b351cd05646c9399a64eafeb5">apr_dbd_transaction_end</a>(const apr_dbd_driver_t *driver, <a name="l00239"></a>00239 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00240"></a>00240 apr_dbd_transaction_t *trans); <a name="l00241"></a>00241 <a name="l00242"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gaff6a26fb3b384bcb3a9172676c53590b">00242</a> <span class="preprocessor">#define APR_DBD_TRANSACTION_COMMIT 0x00 </span><span class="comment">/**< commit the transaction */</span> <a name="l00243"></a><a class="code" href="group___a_p_r___util___d_b_d.html#ga60a8749e5172b692fd2e356b48ec922b">00243</a> <span class="preprocessor">#define APR_DBD_TRANSACTION_ROLLBACK 0x01 </span><span class="comment">/**< rollback the transaction */</span> <a name="l00244"></a><a class="code" href="group___a_p_r___util___d_b_d.html#gad9dc523b0a3b8dea5b8c9b7b0c281ea2">00244</a> <span class="preprocessor">#define APR_DBD_TRANSACTION_IGNORE_ERRORS 0x02 </span><span class="comment">/**< ignore transaction errors */</span> <a name="l00245"></a>00245 <span class="comment"></span> <a name="l00246"></a>00246 <span class="comment">/** apr_dbd_transaction_mode_get: get the mode of transaction</span> <a name="l00247"></a>00247 <span class="comment"> *</span> <a name="l00248"></a>00248 <span class="comment"> * @param driver - the driver</span> <a name="l00249"></a>00249 <span class="comment"> * @param trans - the transaction</span> <a name="l00250"></a>00250 <span class="comment"> * @return mode of transaction</span> <a name="l00251"></a>00251 <span class="comment"> */</span> <a name="l00252"></a>00252 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga2a54cfffc3a348a424002eba937b5853">apr_dbd_transaction_mode_get</a>(const apr_dbd_driver_t *driver, <a name="l00253"></a>00253 apr_dbd_transaction_t *trans); <a name="l00254"></a>00254 <span class="comment"></span> <a name="l00255"></a>00255 <span class="comment">/** apr_dbd_transaction_mode_set: set the mode of transaction</span> <a name="l00256"></a>00256 <span class="comment"> *</span> <a name="l00257"></a>00257 <span class="comment"> * @param driver - the driver</span> <a name="l00258"></a>00258 <span class="comment"> * @param trans - the transaction</span> <a name="l00259"></a>00259 <span class="comment"> * @param mode - new mode of the transaction</span> <a name="l00260"></a>00260 <span class="comment"> * @return the mode of transaction in force after the call</span> <a name="l00261"></a>00261 <span class="comment"> */</span> <a name="l00262"></a>00262 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#gab78c0464926311ef64882adfee2f0f42">apr_dbd_transaction_mode_set</a>(const apr_dbd_driver_t *driver, <a name="l00263"></a>00263 apr_dbd_transaction_t *trans, <a name="l00264"></a>00264 <span class="keywordtype">int</span> mode); <a name="l00265"></a>00265 <span class="comment"></span> <a name="l00266"></a>00266 <span class="comment">/** apr_dbd_query: execute an SQL query that doesn't return a result set</span> <a name="l00267"></a>00267 <span class="comment"> *</span> <a name="l00268"></a>00268 <span class="comment"> * @param driver - the driver</span> <a name="l00269"></a>00269 <span class="comment"> * @param handle - the connection</span> <a name="l00270"></a>00270 <span class="comment"> * @param nrows - number of rows affected.</span> <a name="l00271"></a>00271 <span class="comment"> * @param statement - the SQL statement to execute</span> <a name="l00272"></a>00272 <span class="comment"> * @return 0 for success or error code</span> <a name="l00273"></a>00273 <span class="comment"> */</span> <a name="l00274"></a>00274 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga40dbb6bb3f3f171f3443d21f3594a66a">apr_dbd_query</a>(const apr_dbd_driver_t *driver, apr_dbd_t *handle, <a name="l00275"></a>00275 <span class="keywordtype">int</span> *nrows, const <span class="keywordtype">char</span> *statement); <a name="l00276"></a>00276 <span class="comment"></span> <a name="l00277"></a>00277 <span class="comment">/** apr_dbd_select: execute an SQL query that returns a result set</span> <a name="l00278"></a>00278 <span class="comment"> *</span> <a name="l00279"></a>00279 <span class="comment"> * @param driver - the driver</span> <a name="l00280"></a>00280 <span class="comment"> * @param pool - pool to allocate the result set</span> <a name="l00281"></a>00281 <span class="comment"> * @param handle - the connection</span> <a name="l00282"></a>00282 <span class="comment"> * @param res - pointer to result set pointer. May point to NULL on entry</span> <a name="l00283"></a>00283 <span class="comment"> * @param statement - the SQL statement to execute</span> <a name="l00284"></a>00284 <span class="comment"> * @param random - 1 to support random access to results (seek any row);</span> <a name="l00285"></a>00285 <span class="comment"> * 0 to support only looping through results in order</span> <a name="l00286"></a>00286 <span class="comment"> * (async access - faster)</span> <a name="l00287"></a>00287 <span class="comment"> * @return 0 for success or error code</span> <a name="l00288"></a>00288 <span class="comment"> */</span> <a name="l00289"></a>00289 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga144d354a36140fade933c1ef72661004">apr_dbd_select</a>(const apr_dbd_driver_t *driver, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00290"></a>00290 apr_dbd_t *handle, apr_dbd_results_t **res, <a name="l00291"></a>00291 const <span class="keywordtype">char</span> *statement, <span class="keywordtype">int</span> random); <a name="l00292"></a>00292 <span class="comment"></span> <a name="l00293"></a>00293 <span class="comment">/** apr_dbd_num_cols: get the number of columns in a results set</span> <a name="l00294"></a>00294 <span class="comment"> *</span> <a name="l00295"></a>00295 <span class="comment"> * @param driver - the driver</span> <a name="l00296"></a>00296 <span class="comment"> * @param res - result set.</span> <a name="l00297"></a>00297 <span class="comment"> * @return number of columns</span> <a name="l00298"></a>00298 <span class="comment"> */</span> <a name="l00299"></a>00299 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga77d1bccedee2c61dc96de6852f3a7cc4">apr_dbd_num_cols</a>(const apr_dbd_driver_t *driver, <a name="l00300"></a>00300 apr_dbd_results_t *res); <a name="l00301"></a>00301 <span class="comment"></span> <a name="l00302"></a>00302 <span class="comment">/** apr_dbd_num_tuples: get the number of rows in a results set</span> <a name="l00303"></a>00303 <span class="comment"> * of a synchronous select</span> <a name="l00304"></a>00304 <span class="comment"> *</span> <a name="l00305"></a>00305 <span class="comment"> * @param driver - the driver</span> <a name="l00306"></a>00306 <span class="comment"> * @param res - result set.</span> <a name="l00307"></a>00307 <span class="comment"> * @return number of rows, or -1 if the results are asynchronous</span> <a name="l00308"></a>00308 <span class="comment"> */</span> <a name="l00309"></a>00309 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga2c9f511aba325f8904e69158eacd3987">apr_dbd_num_tuples</a>(const apr_dbd_driver_t *driver, <a name="l00310"></a>00310 apr_dbd_results_t *res); <a name="l00311"></a>00311 <span class="comment"></span> <a name="l00312"></a>00312 <span class="comment">/** apr_dbd_get_row: get a row from a result set</span> <a name="l00313"></a>00313 <span class="comment"> *</span> <a name="l00314"></a>00314 <span class="comment"> * @param driver - the driver</span> <a name="l00315"></a>00315 <span class="comment"> * @param pool - pool to allocate the row</span> <a name="l00316"></a>00316 <span class="comment"> * @param res - result set pointer</span> <a name="l00317"></a>00317 <span class="comment"> * @param row - pointer to row pointer. May point to NULL on entry</span> <a name="l00318"></a>00318 <span class="comment"> * @param rownum - row number (counting from 1), or -1 for "next row".</span> <a name="l00319"></a>00319 <span class="comment"> * Ignored if random access is not supported.</span> <a name="l00320"></a>00320 <span class="comment"> * @return 0 for success, -1 for rownum out of range or data finished</span> <a name="l00321"></a>00321 <span class="comment"> */</span> <a name="l00322"></a>00322 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#gad4cdc5f4e8981b93f5a467a8c8a768f1">apr_dbd_get_row</a>(const apr_dbd_driver_t *driver, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00323"></a>00323 apr_dbd_results_t *res, apr_dbd_row_t **row, <a name="l00324"></a>00324 <span class="keywordtype">int</span> rownum); <a name="l00325"></a>00325 <span class="comment"></span> <a name="l00326"></a>00326 <span class="comment">/** apr_dbd_get_entry: get an entry from a row</span> <a name="l00327"></a>00327 <span class="comment"> *</span> <a name="l00328"></a>00328 <span class="comment"> * @param driver - the driver</span> <a name="l00329"></a>00329 <span class="comment"> * @param row - row pointer</span> <a name="l00330"></a>00330 <span class="comment"> * @param col - entry number</span> <a name="l00331"></a>00331 <span class="comment"> * @return value from the row, or NULL if col is out of bounds.</span> <a name="l00332"></a>00332 <span class="comment"> */</span> <a name="l00333"></a>00333 APU_DECLARE(const <span class="keywordtype">char</span>*) <a class="code" href="group___a_p_r___util___d_b_d.html#ga1d6d3b38a0d677e3d65501074832a5b8">apr_dbd_get_entry</a>(const apr_dbd_driver_t *driver, <a name="l00334"></a>00334 apr_dbd_row_t *row, <span class="keywordtype">int</span> col); <a name="l00335"></a>00335 <span class="comment"></span> <a name="l00336"></a>00336 <span class="comment">/** apr_dbd_get_name: get an entry name from a result set</span> <a name="l00337"></a>00337 <span class="comment"> *</span> <a name="l00338"></a>00338 <span class="comment"> * @param driver - the driver</span> <a name="l00339"></a>00339 <span class="comment"> * @param res - result set pointer</span> <a name="l00340"></a>00340 <span class="comment"> * @param col - entry number</span> <a name="l00341"></a>00341 <span class="comment"> * @return name of the entry, or NULL if col is out of bounds.</span> <a name="l00342"></a>00342 <span class="comment"> */</span> <a name="l00343"></a>00343 APU_DECLARE(const <span class="keywordtype">char</span>*) <a class="code" href="group___a_p_r___util___d_b_d.html#ga8eac8897bd1211564166b08492f458d7">apr_dbd_get_name</a>(const apr_dbd_driver_t *driver, <a name="l00344"></a>00344 apr_dbd_results_t *res, <span class="keywordtype">int</span> col); <a name="l00345"></a>00345 <a name="l00346"></a>00346 <span class="comment"></span> <a name="l00347"></a>00347 <span class="comment">/** apr_dbd_error: get current error message (if any)</span> <a name="l00348"></a>00348 <span class="comment"> *</span> <a name="l00349"></a>00349 <span class="comment"> * @param driver - the driver</span> <a name="l00350"></a>00350 <span class="comment"> * @param handle - the connection</span> <a name="l00351"></a>00351 <span class="comment"> * @param errnum - error code from operation that returned an error</span> <a name="l00352"></a>00352 <span class="comment"> * @return the database current error message, or message for errnum</span> <a name="l00353"></a>00353 <span class="comment"> * (implementation-dependent whether errnum is ignored)</span> <a name="l00354"></a>00354 <span class="comment"> */</span> <a name="l00355"></a>00355 APU_DECLARE(const <span class="keywordtype">char</span>*) <a class="code" href="group___a_p_r___util___d_b_d.html#gaffa947c657862c2996707da339482287">apr_dbd_error</a>(const apr_dbd_driver_t *driver, <a name="l00356"></a>00356 apr_dbd_t *handle, <span class="keywordtype">int</span> errnum); <a name="l00357"></a>00357 <span class="comment"></span> <a name="l00358"></a>00358 <span class="comment">/** apr_dbd_escape: escape a string so it is safe for use in query/select</span> <a name="l00359"></a>00359 <span class="comment"> *</span> <a name="l00360"></a>00360 <span class="comment"> * @param driver - the driver</span> <a name="l00361"></a>00361 <span class="comment"> * @param pool - pool to alloc the result from</span> <a name="l00362"></a>00362 <span class="comment"> * @param string - the string to escape</span> <a name="l00363"></a>00363 <span class="comment"> * @param handle - the connection</span> <a name="l00364"></a>00364 <span class="comment"> * @return the escaped, safe string</span> <a name="l00365"></a>00365 <span class="comment"> */</span> <a name="l00366"></a>00366 APU_DECLARE(const <span class="keywordtype">char</span>*) <a class="code" href="group___a_p_r___util___d_b_d.html#gab5806cd6535aaeafe8e9f79ef2cc90c9">apr_dbd_escape</a>(const apr_dbd_driver_t *driver, <a name="l00367"></a>00367 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const <span class="keywordtype">char</span> *<span class="keywordtype">string</span>, <a name="l00368"></a>00368 apr_dbd_t *handle); <a name="l00369"></a>00369 <span class="comment"></span> <a name="l00370"></a>00370 <span class="comment">/** apr_dbd_prepare: prepare a statement</span> <a name="l00371"></a>00371 <span class="comment"> *</span> <a name="l00372"></a>00372 <span class="comment"> * @param driver - the driver</span> <a name="l00373"></a>00373 <span class="comment"> * @param pool - pool to alloc the result from</span> <a name="l00374"></a>00374 <span class="comment"> * @param handle - the connection</span> <a name="l00375"></a>00375 <span class="comment"> * @param query - the SQL query</span> <a name="l00376"></a>00376 <span class="comment"> * @param label - A label for the prepared statement.</span> <a name="l00377"></a>00377 <span class="comment"> * use NULL for temporary prepared statements</span> <a name="l00378"></a>00378 <span class="comment"> * (eg within a Request in httpd)</span> <a name="l00379"></a>00379 <span class="comment"> * @param statement - statement to prepare. May point to null on entry.</span> <a name="l00380"></a>00380 <span class="comment"> * @return 0 for success or error code</span> <a name="l00381"></a>00381 <span class="comment"> * @remarks To specify parameters of the prepared query, use \%s, \%d etc.</span> <a name="l00382"></a>00382 <span class="comment"> * (see below for full list) in place of database specific parameter syntax</span> <a name="l00383"></a>00383 <span class="comment"> * (e.g. for PostgreSQL, this would be $1, $2, for SQLite3 this would be ?</span> <a name="l00384"></a>00384 <span class="comment"> * etc.). For instance: "SELECT name FROM customers WHERE name=%s" would be</span> <a name="l00385"></a>00385 <span class="comment"> * a query that this function understands.</span> <a name="l00386"></a>00386 <span class="comment"> * @remarks Here is the full list of format specifiers that this function</span> <a name="l00387"></a>00387 <span class="comment"> * understands and what they map to in SQL: \%hhd (TINY INT), \%hhu (UNSIGNED</span> <a name="l00388"></a>00388 <span class="comment"> * TINY INT), \%hd (SHORT), \%hu (UNSIGNED SHORT), \%d (INT), \%u (UNSIGNED</span> <a name="l00389"></a>00389 <span class="comment"> * INT), \%ld (LONG), \%lu (UNSIGNED LONG), \%lld (LONG LONG), \%llu</span> <a name="l00390"></a>00390 <span class="comment"> * (UNSIGNED LONG LONG), \%f (FLOAT, REAL), \%lf (DOUBLE PRECISION), \%s</span> <a name="l00391"></a>00391 <span class="comment"> * (VARCHAR), \%pDt (TEXT), \%pDi (TIME), \%pDd (DATE), \%pDa (DATETIME),</span> <a name="l00392"></a>00392 <span class="comment"> * \%pDs (TIMESTAMP), \%pDz (TIMESTAMP WITH TIME ZONE), \%pDb (BLOB), \%pDc</span> <a name="l00393"></a>00393 <span class="comment"> * (CLOB) and \%pDn (NULL). Not all databases have support for all these</span> <a name="l00394"></a>00394 <span class="comment"> * types, so the underlying driver will attempt the "best match" where</span> <a name="l00395"></a>00395 <span class="comment"> * possible. A \% followed by any letter not in the above list will be</span> <a name="l00396"></a>00396 <span class="comment"> * interpreted as VARCHAR (i.e. \%s).</span> <a name="l00397"></a>00397 <span class="comment"> */</span> <a name="l00398"></a>00398 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#gacf21412447c4357c64d1e9200a0f5eec">apr_dbd_prepare</a>(const apr_dbd_driver_t *driver, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00399"></a>00399 apr_dbd_t *handle, const <span class="keywordtype">char</span> *query, <a name="l00400"></a>00400 const <span class="keywordtype">char</span> *label, <a name="l00401"></a>00401 apr_dbd_prepared_t **statement); <a name="l00402"></a>00402 <a name="l00403"></a>00403 <span class="comment"></span> <a name="l00404"></a>00404 <span class="comment">/** apr_dbd_pquery: query using a prepared statement + args</span> <a name="l00405"></a>00405 <span class="comment"> *</span> <a name="l00406"></a>00406 <span class="comment"> * @param driver - the driver</span> <a name="l00407"></a>00407 <span class="comment"> * @param pool - working pool</span> <a name="l00408"></a>00408 <span class="comment"> * @param handle - the connection</span> <a name="l00409"></a>00409 <span class="comment"> * @param nrows - number of rows affected.</span> <a name="l00410"></a>00410 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00411"></a>00411 <span class="comment"> * @param nargs - ignored (for backward compatibility only)</span> <a name="l00412"></a>00412 <span class="comment"> * @param args - args to prepared statement</span> <a name="l00413"></a>00413 <span class="comment"> * @return 0 for success or error code</span> <a name="l00414"></a>00414 <span class="comment"> */</span> <a name="l00415"></a>00415 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga1c4b005abda896011ca414679edfe112">apr_dbd_pquery</a>(const apr_dbd_driver_t *driver, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00416"></a>00416 apr_dbd_t *handle, <span class="keywordtype">int</span> *nrows, <a name="l00417"></a>00417 apr_dbd_prepared_t *statement, <span class="keywordtype">int</span> nargs, <a name="l00418"></a>00418 const <span class="keywordtype">char</span> **args); <a name="l00419"></a>00419 <span class="comment"></span> <a name="l00420"></a>00420 <span class="comment">/** apr_dbd_pselect: select using a prepared statement + args</span> <a name="l00421"></a>00421 <span class="comment"> *</span> <a name="l00422"></a>00422 <span class="comment"> * @param driver - the driver</span> <a name="l00423"></a>00423 <span class="comment"> * @param pool - working pool</span> <a name="l00424"></a>00424 <span class="comment"> * @param handle - the connection</span> <a name="l00425"></a>00425 <span class="comment"> * @param res - pointer to query results. May point to NULL on entry</span> <a name="l00426"></a>00426 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00427"></a>00427 <span class="comment"> * @param random - Whether to support random-access to results</span> <a name="l00428"></a>00428 <span class="comment"> * @param nargs - ignored (for backward compatibility only)</span> <a name="l00429"></a>00429 <span class="comment"> * @param args - args to prepared statement</span> <a name="l00430"></a>00430 <span class="comment"> * @return 0 for success or error code</span> <a name="l00431"></a>00431 <span class="comment"> */</span> <a name="l00432"></a>00432 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga9f9ee377c2d335f8f1a9bffe4bf7194f">apr_dbd_pselect</a>(const apr_dbd_driver_t *driver, <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00433"></a>00433 apr_dbd_t *handle, apr_dbd_results_t **res, <a name="l00434"></a>00434 apr_dbd_prepared_t *statement, <span class="keywordtype">int</span> random, <a name="l00435"></a>00435 <span class="keywordtype">int</span> nargs, const <span class="keywordtype">char</span> **args); <a name="l00436"></a>00436 <span class="comment"></span> <a name="l00437"></a>00437 <span class="comment">/** apr_dbd_pvquery: query using a prepared statement + args</span> <a name="l00438"></a>00438 <span class="comment"> *</span> <a name="l00439"></a>00439 <span class="comment"> * @param driver - the driver</span> <a name="l00440"></a>00440 <span class="comment"> * @param pool - working pool</span> <a name="l00441"></a>00441 <span class="comment"> * @param handle - the connection</span> <a name="l00442"></a>00442 <span class="comment"> * @param nrows - number of rows affected.</span> <a name="l00443"></a>00443 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00444"></a>00444 <span class="comment"> * @param ... - varargs list</span> <a name="l00445"></a>00445 <span class="comment"> * @return 0 for success or error code</span> <a name="l00446"></a>00446 <span class="comment"> */</span> <a name="l00447"></a>00447 APU_DECLARE_NONSTD(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga52ad74205d0afa92098e546303b9ee4c">apr_dbd_pvquery</a>(const apr_dbd_driver_t *driver, <a name="l00448"></a>00448 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00449"></a>00449 apr_dbd_t *handle, <span class="keywordtype">int</span> *nrows, <a name="l00450"></a>00450 apr_dbd_prepared_t *statement, ...); <a name="l00451"></a>00451 <span class="comment"></span> <a name="l00452"></a>00452 <span class="comment">/** apr_dbd_pvselect: select using a prepared statement + args</span> <a name="l00453"></a>00453 <span class="comment"> *</span> <a name="l00454"></a>00454 <span class="comment"> * @param driver - the driver</span> <a name="l00455"></a>00455 <span class="comment"> * @param pool - working pool</span> <a name="l00456"></a>00456 <span class="comment"> * @param handle - the connection</span> <a name="l00457"></a>00457 <span class="comment"> * @param res - pointer to query results. May point to NULL on entry</span> <a name="l00458"></a>00458 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00459"></a>00459 <span class="comment"> * @param random - Whether to support random-access to results</span> <a name="l00460"></a>00460 <span class="comment"> * @param ... - varargs list</span> <a name="l00461"></a>00461 <span class="comment"> * @return 0 for success or error code</span> <a name="l00462"></a>00462 <span class="comment"> */</span> <a name="l00463"></a>00463 APU_DECLARE_NONSTD(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#gafbd4dbbddfa76586f172ec0832d4fd37">apr_dbd_pvselect</a>(const apr_dbd_driver_t *driver, <a name="l00464"></a>00464 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, apr_dbd_t *handle, <a name="l00465"></a>00465 apr_dbd_results_t **res, <a name="l00466"></a>00466 apr_dbd_prepared_t *statement, <a name="l00467"></a>00467 <span class="keywordtype">int</span> random, ...); <a name="l00468"></a>00468 <span class="comment"></span> <a name="l00469"></a>00469 <span class="comment">/** apr_dbd_pbquery: query using a prepared statement + binary args</span> <a name="l00470"></a>00470 <span class="comment"> *</span> <a name="l00471"></a>00471 <span class="comment"> * @param driver - the driver</span> <a name="l00472"></a>00472 <span class="comment"> * @param pool - working pool</span> <a name="l00473"></a>00473 <span class="comment"> * @param handle - the connection</span> <a name="l00474"></a>00474 <span class="comment"> * @param nrows - number of rows affected.</span> <a name="l00475"></a>00475 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00476"></a>00476 <span class="comment"> * @param args - binary args to prepared statement</span> <a name="l00477"></a>00477 <span class="comment"> * @return 0 for success or error code</span> <a name="l00478"></a>00478 <span class="comment"> */</span> <a name="l00479"></a>00479 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga7933396b01b4676ae2835d1f09d9a1be">apr_dbd_pbquery</a>(const apr_dbd_driver_t *driver, <a name="l00480"></a>00480 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, apr_dbd_t *handle, <a name="l00481"></a>00481 <span class="keywordtype">int</span> *nrows, apr_dbd_prepared_t *statement, <a name="l00482"></a>00482 const <span class="keywordtype">void</span> **args); <a name="l00483"></a>00483 <span class="comment"></span> <a name="l00484"></a>00484 <span class="comment">/** apr_dbd_pbselect: select using a prepared statement + binary args</span> <a name="l00485"></a>00485 <span class="comment"> *</span> <a name="l00486"></a>00486 <span class="comment"> * @param driver - the driver</span> <a name="l00487"></a>00487 <span class="comment"> * @param pool - working pool</span> <a name="l00488"></a>00488 <span class="comment"> * @param handle - the connection</span> <a name="l00489"></a>00489 <span class="comment"> * @param res - pointer to query results. May point to NULL on entry</span> <a name="l00490"></a>00490 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00491"></a>00491 <span class="comment"> * @param random - Whether to support random-access to results</span> <a name="l00492"></a>00492 <span class="comment"> * @param args - binary args to prepared statement</span> <a name="l00493"></a>00493 <span class="comment"> * @return 0 for success or error code</span> <a name="l00494"></a>00494 <span class="comment"> */</span> <a name="l00495"></a>00495 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga19b88ed11097a2d07bef1e31619fff0a">apr_dbd_pbselect</a>(const apr_dbd_driver_t *driver, <a name="l00496"></a>00496 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00497"></a>00497 apr_dbd_t *handle, apr_dbd_results_t **res, <a name="l00498"></a>00498 apr_dbd_prepared_t *statement, <span class="keywordtype">int</span> random, <a name="l00499"></a>00499 const <span class="keywordtype">void</span> **args); <a name="l00500"></a>00500 <span class="comment"></span> <a name="l00501"></a>00501 <span class="comment">/** apr_dbd_pvbquery: query using a prepared statement + binary args</span> <a name="l00502"></a>00502 <span class="comment"> *</span> <a name="l00503"></a>00503 <span class="comment"> * @param driver - the driver</span> <a name="l00504"></a>00504 <span class="comment"> * @param pool - working pool</span> <a name="l00505"></a>00505 <span class="comment"> * @param handle - the connection</span> <a name="l00506"></a>00506 <span class="comment"> * @param nrows - number of rows affected.</span> <a name="l00507"></a>00507 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00508"></a>00508 <span class="comment"> * @param ... - varargs list of binary args</span> <a name="l00509"></a>00509 <span class="comment"> * @return 0 for success or error code</span> <a name="l00510"></a>00510 <span class="comment"> */</span> <a name="l00511"></a>00511 APU_DECLARE_NONSTD(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga27d1ca34ce4064bb14ac3cb315ba8d14">apr_dbd_pvbquery</a>(const apr_dbd_driver_t *driver, <a name="l00512"></a>00512 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a name="l00513"></a>00513 apr_dbd_t *handle, <span class="keywordtype">int</span> *nrows, <a name="l00514"></a>00514 apr_dbd_prepared_t *statement, ...); <a name="l00515"></a>00515 <span class="comment"></span> <a name="l00516"></a>00516 <span class="comment">/** apr_dbd_pvbselect: select using a prepared statement + binary args</span> <a name="l00517"></a>00517 <span class="comment"> *</span> <a name="l00518"></a>00518 <span class="comment"> * @param driver - the driver</span> <a name="l00519"></a>00519 <span class="comment"> * @param pool - working pool</span> <a name="l00520"></a>00520 <span class="comment"> * @param handle - the connection</span> <a name="l00521"></a>00521 <span class="comment"> * @param res - pointer to query results. May point to NULL on entry</span> <a name="l00522"></a>00522 <span class="comment"> * @param statement - the prepared statement to execute</span> <a name="l00523"></a>00523 <span class="comment"> * @param random - Whether to support random-access to results</span> <a name="l00524"></a>00524 <span class="comment"> * @param ... - varargs list of binary args</span> <a name="l00525"></a>00525 <span class="comment"> * @return 0 for success or error code</span> <a name="l00526"></a>00526 <span class="comment"> */</span> <a name="l00527"></a>00527 APU_DECLARE_NONSTD(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_d.html#gacfe85d56d78d5e4767684238287b700b">apr_dbd_pvbselect</a>(const apr_dbd_driver_t *driver, <a name="l00528"></a>00528 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, apr_dbd_t *handle, <a name="l00529"></a>00529 apr_dbd_results_t **res, <a name="l00530"></a>00530 apr_dbd_prepared_t *statement, <a name="l00531"></a>00531 <span class="keywordtype">int</span> random, ...); <a name="l00532"></a>00532 <span class="comment"></span> <a name="l00533"></a>00533 <span class="comment">/** apr_dbd_datum_get: get a binary entry from a row</span> <a name="l00534"></a>00534 <span class="comment"> *</span> <a name="l00535"></a>00535 <span class="comment"> * @param driver - the driver</span> <a name="l00536"></a>00536 <span class="comment"> * @param row - row pointer</span> <a name="l00537"></a>00537 <span class="comment"> * @param col - entry number</span> <a name="l00538"></a>00538 <span class="comment"> * @param type - type of data to get</span> <a name="l00539"></a>00539 <span class="comment"> * @param data - pointer to data, allocated by the caller</span> <a name="l00540"></a>00540 <span class="comment"> * @return APR_SUCCESS on success, APR_ENOENT if data is NULL or APR_EGENERAL</span> <a name="l00541"></a>00541 <span class="comment"> */</span> <a name="l00542"></a>00542 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_d.html#ga67e57ef4eb7952df79ceaa6e92767d41">apr_dbd_datum_get</a>(const apr_dbd_driver_t *driver, <a name="l00543"></a>00543 apr_dbd_row_t *row, <span class="keywordtype">int</span> col, <a name="l00544"></a>00544 <a class="code" href="group___a_p_r___util___d_b_d.html#ga19608fa5d518a5121bee23daacc5c230">apr_dbd_type_e</a> type, <span class="keywordtype">void</span> *data); <a name="l00545"></a>00545 <span class="comment"></span> <a name="l00546"></a>00546 <span class="comment">/** @} */</span> <a name="l00547"></a>00547 <a name="l00548"></a>00548 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00549"></a>00549 <span class="preprocessor"></span>} <a name="l00550"></a>00550 <span class="preprocessor">#endif</span> <a name="l00551"></a>00551 <span class="preprocessor"></span> <a name="l00552"></a>00552 <span class="preprocessor">#endif</span> </pre></div></div> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Wed May 25 2011 for Apache Portable Runtime by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>