apr_dbd.h revision 251876
1251876Speter/* Licensed to the Apache Software Foundation (ASF) under one or more 2251876Speter * contributor license agreements. See the NOTICE file distributed with 3251876Speter * this work for additional information regarding copyright ownership. 4251876Speter * The ASF licenses this file to You under the Apache License, Version 2.0 5251876Speter * (the "License"); you may not use this file except in compliance with 6251876Speter * the License. You may obtain a copy of the License at 7251876Speter * 8251876Speter * http://www.apache.org/licenses/LICENSE-2.0 9251876Speter * 10251876Speter * Unless required by applicable law or agreed to in writing, software 11251876Speter * distributed under the License is distributed on an "AS IS" BASIS, 12251876Speter * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13251876Speter * See the License for the specific language governing permissions and 14251876Speter * limitations under the License. 15251876Speter */ 16251876Speter 17251876Speter/* Overview of what this is and does: 18251876Speter * http://www.apache.org/~niq/dbd.html 19251876Speter */ 20251876Speter 21251876Speter#ifndef APR_DBD_H 22251876Speter#define APR_DBD_H 23251876Speter 24251876Speter#include "apu.h" 25251876Speter#include "apr_pools.h" 26251876Speter 27251876Speter#ifdef __cplusplus 28251876Speterextern "C" { 29251876Speter#endif 30251876Speter 31251876Speter/** 32251876Speter * @file apr_dbd.h 33251876Speter * @brief APR-UTIL DBD library 34251876Speter */ 35251876Speter/** 36251876Speter * @defgroup APR_Util_DBD DBD routines 37251876Speter * @ingroup APR_Util 38251876Speter * @{ 39251876Speter */ 40251876Speter 41251876Speter/** 42251876Speter * Mapping of C to SQL types, used for prepared statements. 43251876Speter * @remarks 44251876Speter * For apr_dbd_p[v]query/select functions, in and out parameters are always 45251876Speter * const char * (i.e. regular nul terminated strings). LOB types are passed 46251876Speter * with four (4) arguments: payload, length, table and column, all as const 47251876Speter * char *, where table and column are reserved for future use by Oracle. 48251876Speter * @remarks 49251876Speter * For apr_dbd_p[v]bquery/select functions, in and out parameters are 50251876Speter * described next to each enumeration constant and are generally native binary 51251876Speter * types or some APR data type. LOB types are passed with four (4) arguments: 52251876Speter * payload (char*), length (apr_size_t*), table (char*) and column (char*). 53251876Speter * Table and column are reserved for future use by Oracle. 54251876Speter */ 55251876Spetertypedef enum { 56251876Speter APR_DBD_TYPE_NONE, 57251876Speter APR_DBD_TYPE_TINY, /**< \%hhd : in, out: char* */ 58251876Speter APR_DBD_TYPE_UTINY, /**< \%hhu : in, out: unsigned char* */ 59251876Speter APR_DBD_TYPE_SHORT, /**< \%hd : in, out: short* */ 60251876Speter APR_DBD_TYPE_USHORT, /**< \%hu : in, out: unsigned short* */ 61251876Speter APR_DBD_TYPE_INT, /**< \%d : in, out: int* */ 62251876Speter APR_DBD_TYPE_UINT, /**< \%u : in, out: unsigned int* */ 63251876Speter APR_DBD_TYPE_LONG, /**< \%ld : in, out: long* */ 64251876Speter APR_DBD_TYPE_ULONG, /**< \%lu : in, out: unsigned long* */ 65251876Speter APR_DBD_TYPE_LONGLONG, /**< \%lld : in, out: apr_int64_t* */ 66251876Speter APR_DBD_TYPE_ULONGLONG, /**< \%llu : in, out: apr_uint64_t* */ 67251876Speter APR_DBD_TYPE_FLOAT, /**< \%f : in, out: float* */ 68251876Speter APR_DBD_TYPE_DOUBLE, /**< \%lf : in, out: double* */ 69251876Speter APR_DBD_TYPE_STRING, /**< \%s : in: char*, out: char** */ 70251876Speter APR_DBD_TYPE_TEXT, /**< \%pDt : in: char*, out: char** */ 71251876Speter APR_DBD_TYPE_TIME, /**< \%pDi : in: char*, out: char** */ 72251876Speter APR_DBD_TYPE_DATE, /**< \%pDd : in: char*, out: char** */ 73251876Speter APR_DBD_TYPE_DATETIME, /**< \%pDa : in: char*, out: char** */ 74251876Speter APR_DBD_TYPE_TIMESTAMP, /**< \%pDs : in: char*, out: char** */ 75251876Speter APR_DBD_TYPE_ZTIMESTAMP, /**< \%pDz : in: char*, out: char** */ 76251876Speter APR_DBD_TYPE_BLOB, /**< \%pDb : in: char* apr_size_t* char* char*, out: apr_bucket_brigade* */ 77251876Speter APR_DBD_TYPE_CLOB, /**< \%pDc : in: char* apr_size_t* char* char*, out: apr_bucket_brigade* */ 78251876Speter APR_DBD_TYPE_NULL /**< \%pDn : in: void*, out: void** */ 79251876Speter} apr_dbd_type_e; 80251876Speter 81251876Speter/* These are opaque structs. Instantiation is up to each backend */ 82251876Spetertypedef struct apr_dbd_driver_t apr_dbd_driver_t; 83251876Spetertypedef struct apr_dbd_t apr_dbd_t; 84251876Spetertypedef struct apr_dbd_transaction_t apr_dbd_transaction_t; 85251876Spetertypedef struct apr_dbd_results_t apr_dbd_results_t; 86251876Spetertypedef struct apr_dbd_row_t apr_dbd_row_t; 87251876Spetertypedef struct apr_dbd_prepared_t apr_dbd_prepared_t; 88251876Speter 89251876Speter/** apr_dbd_init: perform once-only initialisation. Call once only. 90251876Speter * 91251876Speter * @param pool - pool to register any shutdown cleanups, etc 92251876Speter */ 93251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_init(apr_pool_t *pool); 94251876Speter 95251876Speter/** apr_dbd_get_driver: get the driver struct for a name 96251876Speter * 97251876Speter * @param pool - (process) pool to register cleanup 98251876Speter * @param name - driver name 99251876Speter * @param driver - pointer to driver struct. 100251876Speter * @return APR_SUCCESS for success 101251876Speter * @return APR_ENOTIMPL for no driver (when DSO not enabled) 102251876Speter * @return APR_EDSOOPEN if DSO driver file can't be opened 103251876Speter * @return APR_ESYMNOTFOUND if the driver file doesn't contain a driver 104251876Speter */ 105251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_get_driver(apr_pool_t *pool, const char *name, 106251876Speter const apr_dbd_driver_t **driver); 107251876Speter 108251876Speter/** apr_dbd_open_ex: open a connection to a backend 109251876Speter * 110251876Speter * @param pool - working pool 111251876Speter * @param params - arguments to driver (implementation-dependent) 112251876Speter * @param handle - pointer to handle to return 113251876Speter * @param driver - driver struct. 114251876Speter * @param error - descriptive error. 115251876Speter * @return APR_SUCCESS for success 116251876Speter * @return APR_EGENERAL if driver exists but connection failed 117251876Speter * @remarks PostgreSQL: the params is passed directly to the PQconnectdb() 118251876Speter * function (check PostgreSQL documentation for more details on the syntax). 119251876Speter * @remarks SQLite2: the params is split on a colon, with the first part used 120251876Speter * as the filename and second part converted to an integer and used as file 121251876Speter * mode. 122251876Speter * @remarks SQLite3: the params is passed directly to the sqlite3_open() 123251876Speter * function as a filename to be opened (check SQLite3 documentation for more 124251876Speter * details). 125251876Speter * @remarks Oracle: the params can have "user", "pass", "dbname" and "server" 126251876Speter * keys, each followed by an equal sign and a value. Such key/value pairs can 127251876Speter * be delimited by space, CR, LF, tab, semicolon, vertical bar or comma. 128251876Speter * @remarks MySQL: the params can have "host", "port", "user", "pass", 129251876Speter * "dbname", "sock", "flags" "fldsz", "group" and "reconnect" keys, each 130251876Speter * followed by an equal sign and a value. Such key/value pairs can be 131251876Speter * delimited by space, CR, LF, tab, semicolon, vertical bar or comma. For 132251876Speter * now, "flags" can only recognise CLIENT_FOUND_ROWS (check MySQL manual for 133251876Speter * details). The value associated with "fldsz" determines maximum amount of 134251876Speter * memory (in bytes) for each of the fields in the result set of prepared 135251876Speter * statements. By default, this value is 1 MB. The value associated with 136251876Speter * "group" determines which group from configuration file to use (see 137251876Speter * MYSQL_READ_DEFAULT_GROUP option of mysql_options() in MySQL manual). 138251876Speter * Reconnect is set to 1 by default (i.e. true). 139251876Speter * @remarks FreeTDS: the params can have "username", "password", "appname", 140251876Speter * "dbname", "host", "charset", "lang" and "server" keys, each followed by an 141251876Speter * equal sign and a value. 142251876Speter */ 143251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_open_ex(const apr_dbd_driver_t *driver, 144251876Speter apr_pool_t *pool, const char *params, 145251876Speter apr_dbd_t **handle, 146251876Speter const char **error); 147251876Speter 148251876Speter/** apr_dbd_open: open a connection to a backend 149251876Speter * 150251876Speter * @param pool - working pool 151251876Speter * @param params - arguments to driver (implementation-dependent) 152251876Speter * @param handle - pointer to handle to return 153251876Speter * @param driver - driver struct. 154251876Speter * @return APR_SUCCESS for success 155251876Speter * @return APR_EGENERAL if driver exists but connection failed 156251876Speter * @see apr_dbd_open_ex 157251876Speter */ 158251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_open(const apr_dbd_driver_t *driver, 159251876Speter apr_pool_t *pool, const char *params, 160251876Speter apr_dbd_t **handle); 161251876Speter 162251876Speter/** apr_dbd_close: close a connection to a backend 163251876Speter * 164251876Speter * @param handle - handle to close 165251876Speter * @param driver - driver struct. 166251876Speter * @return APR_SUCCESS for success or error status 167251876Speter */ 168251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_close(const apr_dbd_driver_t *driver, 169251876Speter apr_dbd_t *handle); 170251876Speter 171251876Speter/* apr-function-shaped versions of things */ 172251876Speter 173251876Speter/** apr_dbd_name: get the name of the driver 174251876Speter * 175251876Speter * @param driver - the driver 176251876Speter * @return - name 177251876Speter */ 178251876SpeterAPU_DECLARE(const char*) apr_dbd_name(const apr_dbd_driver_t *driver); 179251876Speter 180251876Speter/** apr_dbd_native_handle: get native database handle of the underlying db 181251876Speter * 182251876Speter * @param driver - the driver 183251876Speter * @param handle - apr_dbd handle 184251876Speter * @return - native handle 185251876Speter */ 186251876SpeterAPU_DECLARE(void*) apr_dbd_native_handle(const apr_dbd_driver_t *driver, 187251876Speter apr_dbd_t *handle); 188251876Speter 189251876Speter/** check_conn: check status of a database connection 190251876Speter * 191251876Speter * @param driver - the driver 192251876Speter * @param pool - working pool 193251876Speter * @param handle - the connection to check 194251876Speter * @return APR_SUCCESS or error 195251876Speter */ 196251876SpeterAPU_DECLARE(int) apr_dbd_check_conn(const apr_dbd_driver_t *driver, apr_pool_t *pool, 197251876Speter apr_dbd_t *handle); 198251876Speter 199251876Speter/** apr_dbd_set_dbname: select database name. May be a no-op if not supported. 200251876Speter * 201251876Speter * @param driver - the driver 202251876Speter * @param pool - working pool 203251876Speter * @param handle - the connection 204251876Speter * @param name - the database to select 205251876Speter * @return 0 for success or error code 206251876Speter */ 207251876SpeterAPU_DECLARE(int) apr_dbd_set_dbname(const apr_dbd_driver_t *driver, apr_pool_t *pool, 208251876Speter apr_dbd_t *handle, const char *name); 209251876Speter 210251876Speter/** apr_dbd_transaction_start: start a transaction. May be a no-op. 211251876Speter * 212251876Speter * @param driver - the driver 213251876Speter * @param pool - a pool to use for error messages (if any). 214251876Speter * @param handle - the db connection 215251876Speter * @param trans - ptr to a transaction. May be null on entry 216251876Speter * @return 0 for success or error code 217251876Speter * @remarks Note that transaction modes, set by calling 218251876Speter * apr_dbd_transaction_mode_set(), will affect all query/select calls within 219251876Speter * a transaction. By default, any error in query/select during a transaction 220251876Speter * will cause the transaction to inherit the error code and any further 221251876Speter * query/select calls will fail immediately. Put transaction in "ignore 222251876Speter * errors" mode to avoid that. Use "rollback" mode to do explicit rollback. 223251876Speter */ 224251876SpeterAPU_DECLARE(int) apr_dbd_transaction_start(const apr_dbd_driver_t *driver, 225251876Speter apr_pool_t *pool, 226251876Speter apr_dbd_t *handle, 227251876Speter apr_dbd_transaction_t **trans); 228251876Speter 229251876Speter/** apr_dbd_transaction_end: end a transaction 230251876Speter * (commit on success, rollback on error). 231251876Speter * May be a no-op. 232251876Speter * 233251876Speter * @param driver - the driver 234251876Speter * @param handle - the db connection 235251876Speter * @param trans - the transaction. 236251876Speter * @return 0 for success or error code 237251876Speter */ 238251876SpeterAPU_DECLARE(int) apr_dbd_transaction_end(const apr_dbd_driver_t *driver, 239251876Speter apr_pool_t *pool, 240251876Speter apr_dbd_transaction_t *trans); 241251876Speter 242251876Speter#define APR_DBD_TRANSACTION_COMMIT 0x00 /**< commit the transaction */ 243251876Speter#define APR_DBD_TRANSACTION_ROLLBACK 0x01 /**< rollback the transaction */ 244251876Speter#define APR_DBD_TRANSACTION_IGNORE_ERRORS 0x02 /**< ignore transaction errors */ 245251876Speter 246251876Speter/** apr_dbd_transaction_mode_get: get the mode of transaction 247251876Speter * 248251876Speter * @param driver - the driver 249251876Speter * @param trans - the transaction 250251876Speter * @return mode of transaction 251251876Speter */ 252251876SpeterAPU_DECLARE(int) apr_dbd_transaction_mode_get(const apr_dbd_driver_t *driver, 253251876Speter apr_dbd_transaction_t *trans); 254251876Speter 255251876Speter/** apr_dbd_transaction_mode_set: set the mode of transaction 256251876Speter * 257251876Speter * @param driver - the driver 258251876Speter * @param trans - the transaction 259251876Speter * @param mode - new mode of the transaction 260251876Speter * @return the mode of transaction in force after the call 261251876Speter */ 262251876SpeterAPU_DECLARE(int) apr_dbd_transaction_mode_set(const apr_dbd_driver_t *driver, 263251876Speter apr_dbd_transaction_t *trans, 264251876Speter int mode); 265251876Speter 266251876Speter/** apr_dbd_query: execute an SQL query that doesn't return a result set 267251876Speter * 268251876Speter * @param driver - the driver 269251876Speter * @param handle - the connection 270251876Speter * @param nrows - number of rows affected. 271251876Speter * @param statement - the SQL statement to execute 272251876Speter * @return 0 for success or error code 273251876Speter */ 274251876SpeterAPU_DECLARE(int) apr_dbd_query(const apr_dbd_driver_t *driver, apr_dbd_t *handle, 275251876Speter int *nrows, const char *statement); 276251876Speter 277251876Speter/** apr_dbd_select: execute an SQL query that returns a result set 278251876Speter * 279251876Speter * @param driver - the driver 280251876Speter * @param pool - pool to allocate the result set 281251876Speter * @param handle - the connection 282251876Speter * @param res - pointer to result set pointer. May point to NULL on entry 283251876Speter * @param statement - the SQL statement to execute 284251876Speter * @param random - 1 to support random access to results (seek any row); 285251876Speter * 0 to support only looping through results in order 286251876Speter * (async access - faster) 287251876Speter * @return 0 for success or error code 288251876Speter */ 289251876SpeterAPU_DECLARE(int) apr_dbd_select(const apr_dbd_driver_t *driver, apr_pool_t *pool, 290251876Speter apr_dbd_t *handle, apr_dbd_results_t **res, 291251876Speter const char *statement, int random); 292251876Speter 293251876Speter/** apr_dbd_num_cols: get the number of columns in a results set 294251876Speter * 295251876Speter * @param driver - the driver 296251876Speter * @param res - result set. 297251876Speter * @return number of columns 298251876Speter */ 299251876SpeterAPU_DECLARE(int) apr_dbd_num_cols(const apr_dbd_driver_t *driver, 300251876Speter apr_dbd_results_t *res); 301251876Speter 302251876Speter/** apr_dbd_num_tuples: get the number of rows in a results set 303251876Speter * of a synchronous select 304251876Speter * 305251876Speter * @param driver - the driver 306251876Speter * @param res - result set. 307251876Speter * @return number of rows, or -1 if the results are asynchronous 308251876Speter */ 309251876SpeterAPU_DECLARE(int) apr_dbd_num_tuples(const apr_dbd_driver_t *driver, 310251876Speter apr_dbd_results_t *res); 311251876Speter 312251876Speter/** apr_dbd_get_row: get a row from a result set 313251876Speter * 314251876Speter * @param driver - the driver 315251876Speter * @param pool - pool to allocate the row 316251876Speter * @param res - result set pointer 317251876Speter * @param row - pointer to row pointer. May point to NULL on entry 318251876Speter * @param rownum - row number (counting from 1), or -1 for "next row". 319251876Speter * Ignored if random access is not supported. 320251876Speter * @return 0 for success, -1 for rownum out of range or data finished 321251876Speter */ 322251876SpeterAPU_DECLARE(int) apr_dbd_get_row(const apr_dbd_driver_t *driver, apr_pool_t *pool, 323251876Speter apr_dbd_results_t *res, apr_dbd_row_t **row, 324251876Speter int rownum); 325251876Speter 326251876Speter/** apr_dbd_get_entry: get an entry from a row 327251876Speter * 328251876Speter * @param driver - the driver 329251876Speter * @param row - row pointer 330251876Speter * @param col - entry number 331251876Speter * @return value from the row, or NULL if col is out of bounds. 332251876Speter */ 333251876SpeterAPU_DECLARE(const char*) apr_dbd_get_entry(const apr_dbd_driver_t *driver, 334251876Speter apr_dbd_row_t *row, int col); 335251876Speter 336251876Speter/** apr_dbd_get_name: get an entry name from a result set 337251876Speter * 338251876Speter * @param driver - the driver 339251876Speter * @param res - result set pointer 340251876Speter * @param col - entry number 341251876Speter * @return name of the entry, or NULL if col is out of bounds. 342251876Speter */ 343251876SpeterAPU_DECLARE(const char*) apr_dbd_get_name(const apr_dbd_driver_t *driver, 344251876Speter apr_dbd_results_t *res, int col); 345251876Speter 346251876Speter 347251876Speter/** apr_dbd_error: get current error message (if any) 348251876Speter * 349251876Speter * @param driver - the driver 350251876Speter * @param handle - the connection 351251876Speter * @param errnum - error code from operation that returned an error 352251876Speter * @return the database current error message, or message for errnum 353251876Speter * (implementation-dependent whether errnum is ignored) 354251876Speter */ 355251876SpeterAPU_DECLARE(const char*) apr_dbd_error(const apr_dbd_driver_t *driver, 356251876Speter apr_dbd_t *handle, int errnum); 357251876Speter 358251876Speter/** apr_dbd_escape: escape a string so it is safe for use in query/select 359251876Speter * 360251876Speter * @param driver - the driver 361251876Speter * @param pool - pool to alloc the result from 362251876Speter * @param string - the string to escape 363251876Speter * @param handle - the connection 364251876Speter * @return the escaped, safe string 365251876Speter */ 366251876SpeterAPU_DECLARE(const char*) apr_dbd_escape(const apr_dbd_driver_t *driver, 367251876Speter apr_pool_t *pool, const char *string, 368251876Speter apr_dbd_t *handle); 369251876Speter 370251876Speter/** apr_dbd_prepare: prepare a statement 371251876Speter * 372251876Speter * @param driver - the driver 373251876Speter * @param pool - pool to alloc the result from 374251876Speter * @param handle - the connection 375251876Speter * @param query - the SQL query 376251876Speter * @param label - A label for the prepared statement. 377251876Speter * use NULL for temporary prepared statements 378251876Speter * (eg within a Request in httpd) 379251876Speter * @param statement - statement to prepare. May point to null on entry. 380251876Speter * @return 0 for success or error code 381251876Speter * @remarks To specify parameters of the prepared query, use \%s, \%d etc. 382251876Speter * (see below for full list) in place of database specific parameter syntax 383251876Speter * (e.g. for PostgreSQL, this would be $1, $2, for SQLite3 this would be ? 384251876Speter * etc.). For instance: "SELECT name FROM customers WHERE name=%s" would be 385251876Speter * a query that this function understands. 386251876Speter * @remarks Here is the full list of format specifiers that this function 387251876Speter * understands and what they map to in SQL: \%hhd (TINY INT), \%hhu (UNSIGNED 388251876Speter * TINY INT), \%hd (SHORT), \%hu (UNSIGNED SHORT), \%d (INT), \%u (UNSIGNED 389251876Speter * INT), \%ld (LONG), \%lu (UNSIGNED LONG), \%lld (LONG LONG), \%llu 390251876Speter * (UNSIGNED LONG LONG), \%f (FLOAT, REAL), \%lf (DOUBLE PRECISION), \%s 391251876Speter * (VARCHAR), \%pDt (TEXT), \%pDi (TIME), \%pDd (DATE), \%pDa (DATETIME), 392251876Speter * \%pDs (TIMESTAMP), \%pDz (TIMESTAMP WITH TIME ZONE), \%pDb (BLOB), \%pDc 393251876Speter * (CLOB) and \%pDn (NULL). Not all databases have support for all these 394251876Speter * types, so the underlying driver will attempt the "best match" where 395251876Speter * possible. A \% followed by any letter not in the above list will be 396251876Speter * interpreted as VARCHAR (i.e. \%s). 397251876Speter */ 398251876SpeterAPU_DECLARE(int) apr_dbd_prepare(const apr_dbd_driver_t *driver, apr_pool_t *pool, 399251876Speter apr_dbd_t *handle, const char *query, 400251876Speter const char *label, 401251876Speter apr_dbd_prepared_t **statement); 402251876Speter 403251876Speter 404251876Speter/** apr_dbd_pquery: query using a prepared statement + args 405251876Speter * 406251876Speter * @param driver - the driver 407251876Speter * @param pool - working pool 408251876Speter * @param handle - the connection 409251876Speter * @param nrows - number of rows affected. 410251876Speter * @param statement - the prepared statement to execute 411251876Speter * @param nargs - ignored (for backward compatibility only) 412251876Speter * @param args - args to prepared statement 413251876Speter * @return 0 for success or error code 414251876Speter */ 415251876SpeterAPU_DECLARE(int) apr_dbd_pquery(const apr_dbd_driver_t *driver, apr_pool_t *pool, 416251876Speter apr_dbd_t *handle, int *nrows, 417251876Speter apr_dbd_prepared_t *statement, int nargs, 418251876Speter const char **args); 419251876Speter 420251876Speter/** apr_dbd_pselect: select using a prepared statement + args 421251876Speter * 422251876Speter * @param driver - the driver 423251876Speter * @param pool - working pool 424251876Speter * @param handle - the connection 425251876Speter * @param res - pointer to query results. May point to NULL on entry 426251876Speter * @param statement - the prepared statement to execute 427251876Speter * @param random - Whether to support random-access to results 428251876Speter * @param nargs - ignored (for backward compatibility only) 429251876Speter * @param args - args to prepared statement 430251876Speter * @return 0 for success or error code 431251876Speter */ 432251876SpeterAPU_DECLARE(int) apr_dbd_pselect(const apr_dbd_driver_t *driver, apr_pool_t *pool, 433251876Speter apr_dbd_t *handle, apr_dbd_results_t **res, 434251876Speter apr_dbd_prepared_t *statement, int random, 435251876Speter int nargs, const char **args); 436251876Speter 437251876Speter/** apr_dbd_pvquery: query using a prepared statement + args 438251876Speter * 439251876Speter * @param driver - the driver 440251876Speter * @param pool - working pool 441251876Speter * @param handle - the connection 442251876Speter * @param nrows - number of rows affected. 443251876Speter * @param statement - the prepared statement to execute 444251876Speter * @param ... - varargs list 445251876Speter * @return 0 for success or error code 446251876Speter */ 447251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvquery(const apr_dbd_driver_t *driver, 448251876Speter apr_pool_t *pool, 449251876Speter apr_dbd_t *handle, int *nrows, 450251876Speter apr_dbd_prepared_t *statement, ...); 451251876Speter 452251876Speter/** apr_dbd_pvselect: select using a prepared statement + args 453251876Speter * 454251876Speter * @param driver - the driver 455251876Speter * @param pool - working pool 456251876Speter * @param handle - the connection 457251876Speter * @param res - pointer to query results. May point to NULL on entry 458251876Speter * @param statement - the prepared statement to execute 459251876Speter * @param random - Whether to support random-access to results 460251876Speter * @param ... - varargs list 461251876Speter * @return 0 for success or error code 462251876Speter */ 463251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvselect(const apr_dbd_driver_t *driver, 464251876Speter apr_pool_t *pool, apr_dbd_t *handle, 465251876Speter apr_dbd_results_t **res, 466251876Speter apr_dbd_prepared_t *statement, 467251876Speter int random, ...); 468251876Speter 469251876Speter/** apr_dbd_pbquery: query using a prepared statement + binary args 470251876Speter * 471251876Speter * @param driver - the driver 472251876Speter * @param pool - working pool 473251876Speter * @param handle - the connection 474251876Speter * @param nrows - number of rows affected. 475251876Speter * @param statement - the prepared statement to execute 476251876Speter * @param args - binary args to prepared statement 477251876Speter * @return 0 for success or error code 478251876Speter */ 479251876SpeterAPU_DECLARE(int) apr_dbd_pbquery(const apr_dbd_driver_t *driver, 480251876Speter apr_pool_t *pool, apr_dbd_t *handle, 481251876Speter int *nrows, apr_dbd_prepared_t *statement, 482251876Speter const void **args); 483251876Speter 484251876Speter/** apr_dbd_pbselect: select using a prepared statement + binary args 485251876Speter * 486251876Speter * @param driver - the driver 487251876Speter * @param pool - working pool 488251876Speter * @param handle - the connection 489251876Speter * @param res - pointer to query results. May point to NULL on entry 490251876Speter * @param statement - the prepared statement to execute 491251876Speter * @param random - Whether to support random-access to results 492251876Speter * @param args - binary args to prepared statement 493251876Speter * @return 0 for success or error code 494251876Speter */ 495251876SpeterAPU_DECLARE(int) apr_dbd_pbselect(const apr_dbd_driver_t *driver, 496251876Speter apr_pool_t *pool, 497251876Speter apr_dbd_t *handle, apr_dbd_results_t **res, 498251876Speter apr_dbd_prepared_t *statement, int random, 499251876Speter const void **args); 500251876Speter 501251876Speter/** apr_dbd_pvbquery: query using a prepared statement + binary args 502251876Speter * 503251876Speter * @param driver - the driver 504251876Speter * @param pool - working pool 505251876Speter * @param handle - the connection 506251876Speter * @param nrows - number of rows affected. 507251876Speter * @param statement - the prepared statement to execute 508251876Speter * @param ... - varargs list of binary args 509251876Speter * @return 0 for success or error code 510251876Speter */ 511251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvbquery(const apr_dbd_driver_t *driver, 512251876Speter apr_pool_t *pool, 513251876Speter apr_dbd_t *handle, int *nrows, 514251876Speter apr_dbd_prepared_t *statement, ...); 515251876Speter 516251876Speter/** apr_dbd_pvbselect: select using a prepared statement + binary args 517251876Speter * 518251876Speter * @param driver - the driver 519251876Speter * @param pool - working pool 520251876Speter * @param handle - the connection 521251876Speter * @param res - pointer to query results. May point to NULL on entry 522251876Speter * @param statement - the prepared statement to execute 523251876Speter * @param random - Whether to support random-access to results 524251876Speter * @param ... - varargs list of binary args 525251876Speter * @return 0 for success or error code 526251876Speter */ 527251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvbselect(const apr_dbd_driver_t *driver, 528251876Speter apr_pool_t *pool, apr_dbd_t *handle, 529251876Speter apr_dbd_results_t **res, 530251876Speter apr_dbd_prepared_t *statement, 531251876Speter int random, ...); 532251876Speter 533251876Speter/** apr_dbd_datum_get: get a binary entry from a row 534251876Speter * 535251876Speter * @param driver - the driver 536251876Speter * @param row - row pointer 537251876Speter * @param col - entry number 538251876Speter * @param type - type of data to get 539251876Speter * @param data - pointer to data, allocated by the caller 540251876Speter * @return APR_SUCCESS on success, APR_ENOENT if data is NULL or APR_EGENERAL 541251876Speter */ 542251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_datum_get(const apr_dbd_driver_t *driver, 543251876Speter apr_dbd_row_t *row, int col, 544251876Speter apr_dbd_type_e type, void *data); 545251876Speter 546251876Speter/** @} */ 547251876Speter 548251876Speter#ifdef __cplusplus 549251876Speter} 550251876Speter#endif 551251876Speter 552251876Speter#endif 553