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 * 110258602Speter * @param driver - driver struct. 111251876Speter * @param pool - working pool 112251876Speter * @param params - arguments to driver (implementation-dependent) 113251876Speter * @param handle - pointer to handle to return 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 */ 140251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_open_ex(const apr_dbd_driver_t *driver, 141251876Speter apr_pool_t *pool, const char *params, 142251876Speter apr_dbd_t **handle, 143251876Speter const char **error); 144251876Speter 145251876Speter/** apr_dbd_open: open a connection to a backend 146251876Speter * 147258602Speter * @param driver - driver struct. 148251876Speter * @param pool - working pool 149251876Speter * @param params - arguments to driver (implementation-dependent) 150251876Speter * @param handle - pointer to handle to return 151251876Speter * @return APR_SUCCESS for success 152251876Speter * @return APR_EGENERAL if driver exists but connection failed 153251876Speter * @see apr_dbd_open_ex 154251876Speter */ 155251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_open(const apr_dbd_driver_t *driver, 156251876Speter apr_pool_t *pool, const char *params, 157251876Speter apr_dbd_t **handle); 158251876Speter 159251876Speter/** apr_dbd_close: close a connection to a backend 160251876Speter * 161258602Speter * @param driver - driver struct. 162251876Speter * @param handle - handle to close 163251876Speter * @return APR_SUCCESS for success or error status 164251876Speter */ 165251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_close(const apr_dbd_driver_t *driver, 166251876Speter apr_dbd_t *handle); 167251876Speter 168251876Speter/* apr-function-shaped versions of things */ 169251876Speter 170251876Speter/** apr_dbd_name: get the name of the driver 171251876Speter * 172251876Speter * @param driver - the driver 173251876Speter * @return - name 174251876Speter */ 175251876SpeterAPU_DECLARE(const char*) apr_dbd_name(const apr_dbd_driver_t *driver); 176251876Speter 177251876Speter/** apr_dbd_native_handle: get native database handle of the underlying db 178251876Speter * 179251876Speter * @param driver - the driver 180251876Speter * @param handle - apr_dbd handle 181251876Speter * @return - native handle 182251876Speter */ 183251876SpeterAPU_DECLARE(void*) apr_dbd_native_handle(const apr_dbd_driver_t *driver, 184251876Speter apr_dbd_t *handle); 185251876Speter 186251876Speter/** check_conn: check status of a database connection 187251876Speter * 188251876Speter * @param driver - the driver 189251876Speter * @param pool - working pool 190251876Speter * @param handle - the connection to check 191251876Speter * @return APR_SUCCESS or error 192251876Speter */ 193251876SpeterAPU_DECLARE(int) apr_dbd_check_conn(const apr_dbd_driver_t *driver, apr_pool_t *pool, 194251876Speter apr_dbd_t *handle); 195251876Speter 196251876Speter/** apr_dbd_set_dbname: select database name. May be a no-op if not supported. 197251876Speter * 198251876Speter * @param driver - the driver 199251876Speter * @param pool - working pool 200251876Speter * @param handle - the connection 201251876Speter * @param name - the database to select 202251876Speter * @return 0 for success or error code 203251876Speter */ 204251876SpeterAPU_DECLARE(int) apr_dbd_set_dbname(const apr_dbd_driver_t *driver, apr_pool_t *pool, 205251876Speter apr_dbd_t *handle, const char *name); 206251876Speter 207251876Speter/** apr_dbd_transaction_start: start a transaction. May be a no-op. 208251876Speter * 209251876Speter * @param driver - the driver 210251876Speter * @param pool - a pool to use for error messages (if any). 211251876Speter * @param handle - the db connection 212251876Speter * @param trans - ptr to a transaction. May be null on entry 213251876Speter * @return 0 for success or error code 214251876Speter * @remarks Note that transaction modes, set by calling 215251876Speter * apr_dbd_transaction_mode_set(), will affect all query/select calls within 216251876Speter * a transaction. By default, any error in query/select during a transaction 217251876Speter * will cause the transaction to inherit the error code and any further 218251876Speter * query/select calls will fail immediately. Put transaction in "ignore 219251876Speter * errors" mode to avoid that. Use "rollback" mode to do explicit rollback. 220251876Speter */ 221251876SpeterAPU_DECLARE(int) apr_dbd_transaction_start(const apr_dbd_driver_t *driver, 222251876Speter apr_pool_t *pool, 223251876Speter apr_dbd_t *handle, 224251876Speter apr_dbd_transaction_t **trans); 225251876Speter 226251876Speter/** apr_dbd_transaction_end: end a transaction 227251876Speter * (commit on success, rollback on error). 228251876Speter * May be a no-op. 229251876Speter * 230251876Speter * @param driver - the driver 231251876Speter * @param handle - the db connection 232251876Speter * @param trans - the transaction. 233251876Speter * @return 0 for success or error code 234251876Speter */ 235251876SpeterAPU_DECLARE(int) apr_dbd_transaction_end(const apr_dbd_driver_t *driver, 236251876Speter apr_pool_t *pool, 237251876Speter apr_dbd_transaction_t *trans); 238251876Speter 239251876Speter#define APR_DBD_TRANSACTION_COMMIT 0x00 /**< commit the transaction */ 240251876Speter#define APR_DBD_TRANSACTION_ROLLBACK 0x01 /**< rollback the transaction */ 241251876Speter#define APR_DBD_TRANSACTION_IGNORE_ERRORS 0x02 /**< ignore transaction errors */ 242251876Speter 243251876Speter/** apr_dbd_transaction_mode_get: get the mode of transaction 244251876Speter * 245251876Speter * @param driver - the driver 246251876Speter * @param trans - the transaction 247251876Speter * @return mode of transaction 248251876Speter */ 249251876SpeterAPU_DECLARE(int) apr_dbd_transaction_mode_get(const apr_dbd_driver_t *driver, 250251876Speter apr_dbd_transaction_t *trans); 251251876Speter 252251876Speter/** apr_dbd_transaction_mode_set: set the mode of transaction 253251876Speter * 254251876Speter * @param driver - the driver 255251876Speter * @param trans - the transaction 256251876Speter * @param mode - new mode of the transaction 257251876Speter * @return the mode of transaction in force after the call 258251876Speter */ 259251876SpeterAPU_DECLARE(int) apr_dbd_transaction_mode_set(const apr_dbd_driver_t *driver, 260251876Speter apr_dbd_transaction_t *trans, 261251876Speter int mode); 262251876Speter 263251876Speter/** apr_dbd_query: execute an SQL query that doesn't return a result set 264251876Speter * 265251876Speter * @param driver - the driver 266251876Speter * @param handle - the connection 267251876Speter * @param nrows - number of rows affected. 268251876Speter * @param statement - the SQL statement to execute 269251876Speter * @return 0 for success or error code 270251876Speter */ 271251876SpeterAPU_DECLARE(int) apr_dbd_query(const apr_dbd_driver_t *driver, apr_dbd_t *handle, 272251876Speter int *nrows, const char *statement); 273251876Speter 274251876Speter/** apr_dbd_select: execute an SQL query that returns a result set 275251876Speter * 276251876Speter * @param driver - the driver 277251876Speter * @param pool - pool to allocate the result set 278251876Speter * @param handle - the connection 279251876Speter * @param res - pointer to result set pointer. May point to NULL on entry 280251876Speter * @param statement - the SQL statement to execute 281251876Speter * @param random - 1 to support random access to results (seek any row); 282251876Speter * 0 to support only looping through results in order 283251876Speter * (async access - faster) 284251876Speter * @return 0 for success or error code 285251876Speter */ 286251876SpeterAPU_DECLARE(int) apr_dbd_select(const apr_dbd_driver_t *driver, apr_pool_t *pool, 287251876Speter apr_dbd_t *handle, apr_dbd_results_t **res, 288251876Speter const char *statement, int random); 289251876Speter 290251876Speter/** apr_dbd_num_cols: get the number of columns in a results set 291251876Speter * 292251876Speter * @param driver - the driver 293251876Speter * @param res - result set. 294251876Speter * @return number of columns 295251876Speter */ 296251876SpeterAPU_DECLARE(int) apr_dbd_num_cols(const apr_dbd_driver_t *driver, 297251876Speter apr_dbd_results_t *res); 298251876Speter 299251876Speter/** apr_dbd_num_tuples: get the number of rows in a results set 300251876Speter * of a synchronous select 301251876Speter * 302251876Speter * @param driver - the driver 303251876Speter * @param res - result set. 304251876Speter * @return number of rows, or -1 if the results are asynchronous 305251876Speter */ 306251876SpeterAPU_DECLARE(int) apr_dbd_num_tuples(const apr_dbd_driver_t *driver, 307251876Speter apr_dbd_results_t *res); 308251876Speter 309251876Speter/** apr_dbd_get_row: get a row from a result set 310251876Speter * 311251876Speter * @param driver - the driver 312251876Speter * @param pool - pool to allocate the row 313251876Speter * @param res - result set pointer 314251876Speter * @param row - pointer to row pointer. May point to NULL on entry 315251876Speter * @param rownum - row number (counting from 1), or -1 for "next row". 316251876Speter * Ignored if random access is not supported. 317251876Speter * @return 0 for success, -1 for rownum out of range or data finished 318251876Speter */ 319251876SpeterAPU_DECLARE(int) apr_dbd_get_row(const apr_dbd_driver_t *driver, apr_pool_t *pool, 320251876Speter apr_dbd_results_t *res, apr_dbd_row_t **row, 321251876Speter int rownum); 322251876Speter 323251876Speter/** apr_dbd_get_entry: get an entry from a row 324251876Speter * 325251876Speter * @param driver - the driver 326251876Speter * @param row - row pointer 327251876Speter * @param col - entry number 328251876Speter * @return value from the row, or NULL if col is out of bounds. 329251876Speter */ 330251876SpeterAPU_DECLARE(const char*) apr_dbd_get_entry(const apr_dbd_driver_t *driver, 331251876Speter apr_dbd_row_t *row, int col); 332251876Speter 333251876Speter/** apr_dbd_get_name: get an entry name from a result set 334251876Speter * 335251876Speter * @param driver - the driver 336251876Speter * @param res - result set pointer 337251876Speter * @param col - entry number 338251876Speter * @return name of the entry, or NULL if col is out of bounds. 339251876Speter */ 340251876SpeterAPU_DECLARE(const char*) apr_dbd_get_name(const apr_dbd_driver_t *driver, 341251876Speter apr_dbd_results_t *res, int col); 342251876Speter 343251876Speter 344251876Speter/** apr_dbd_error: get current error message (if any) 345251876Speter * 346251876Speter * @param driver - the driver 347251876Speter * @param handle - the connection 348251876Speter * @param errnum - error code from operation that returned an error 349251876Speter * @return the database current error message, or message for errnum 350251876Speter * (implementation-dependent whether errnum is ignored) 351251876Speter */ 352251876SpeterAPU_DECLARE(const char*) apr_dbd_error(const apr_dbd_driver_t *driver, 353251876Speter apr_dbd_t *handle, int errnum); 354251876Speter 355251876Speter/** apr_dbd_escape: escape a string so it is safe for use in query/select 356251876Speter * 357251876Speter * @param driver - the driver 358251876Speter * @param pool - pool to alloc the result from 359251876Speter * @param string - the string to escape 360251876Speter * @param handle - the connection 361251876Speter * @return the escaped, safe string 362251876Speter */ 363251876SpeterAPU_DECLARE(const char*) apr_dbd_escape(const apr_dbd_driver_t *driver, 364251876Speter apr_pool_t *pool, const char *string, 365251876Speter apr_dbd_t *handle); 366251876Speter 367251876Speter/** apr_dbd_prepare: prepare a statement 368251876Speter * 369251876Speter * @param driver - the driver 370251876Speter * @param pool - pool to alloc the result from 371251876Speter * @param handle - the connection 372251876Speter * @param query - the SQL query 373251876Speter * @param label - A label for the prepared statement. 374251876Speter * use NULL for temporary prepared statements 375251876Speter * (eg within a Request in httpd) 376251876Speter * @param statement - statement to prepare. May point to null on entry. 377251876Speter * @return 0 for success or error code 378251876Speter * @remarks To specify parameters of the prepared query, use \%s, \%d etc. 379251876Speter * (see below for full list) in place of database specific parameter syntax 380251876Speter * (e.g. for PostgreSQL, this would be $1, $2, for SQLite3 this would be ? 381251876Speter * etc.). For instance: "SELECT name FROM customers WHERE name=%s" would be 382251876Speter * a query that this function understands. 383251876Speter * @remarks Here is the full list of format specifiers that this function 384251876Speter * understands and what they map to in SQL: \%hhd (TINY INT), \%hhu (UNSIGNED 385251876Speter * TINY INT), \%hd (SHORT), \%hu (UNSIGNED SHORT), \%d (INT), \%u (UNSIGNED 386251876Speter * INT), \%ld (LONG), \%lu (UNSIGNED LONG), \%lld (LONG LONG), \%llu 387251876Speter * (UNSIGNED LONG LONG), \%f (FLOAT, REAL), \%lf (DOUBLE PRECISION), \%s 388251876Speter * (VARCHAR), \%pDt (TEXT), \%pDi (TIME), \%pDd (DATE), \%pDa (DATETIME), 389251876Speter * \%pDs (TIMESTAMP), \%pDz (TIMESTAMP WITH TIME ZONE), \%pDb (BLOB), \%pDc 390251876Speter * (CLOB) and \%pDn (NULL). Not all databases have support for all these 391251876Speter * types, so the underlying driver will attempt the "best match" where 392251876Speter * possible. A \% followed by any letter not in the above list will be 393251876Speter * interpreted as VARCHAR (i.e. \%s). 394251876Speter */ 395251876SpeterAPU_DECLARE(int) apr_dbd_prepare(const apr_dbd_driver_t *driver, apr_pool_t *pool, 396251876Speter apr_dbd_t *handle, const char *query, 397251876Speter const char *label, 398251876Speter apr_dbd_prepared_t **statement); 399251876Speter 400251876Speter 401251876Speter/** apr_dbd_pquery: query using a prepared statement + args 402251876Speter * 403251876Speter * @param driver - the driver 404251876Speter * @param pool - working pool 405251876Speter * @param handle - the connection 406251876Speter * @param nrows - number of rows affected. 407251876Speter * @param statement - the prepared statement to execute 408251876Speter * @param nargs - ignored (for backward compatibility only) 409251876Speter * @param args - args to prepared statement 410251876Speter * @return 0 for success or error code 411251876Speter */ 412251876SpeterAPU_DECLARE(int) apr_dbd_pquery(const apr_dbd_driver_t *driver, apr_pool_t *pool, 413251876Speter apr_dbd_t *handle, int *nrows, 414251876Speter apr_dbd_prepared_t *statement, int nargs, 415251876Speter const char **args); 416251876Speter 417251876Speter/** apr_dbd_pselect: select using a prepared statement + args 418251876Speter * 419251876Speter * @param driver - the driver 420251876Speter * @param pool - working pool 421251876Speter * @param handle - the connection 422251876Speter * @param res - pointer to query results. May point to NULL on entry 423251876Speter * @param statement - the prepared statement to execute 424251876Speter * @param random - Whether to support random-access to results 425251876Speter * @param nargs - ignored (for backward compatibility only) 426251876Speter * @param args - args to prepared statement 427251876Speter * @return 0 for success or error code 428251876Speter */ 429251876SpeterAPU_DECLARE(int) apr_dbd_pselect(const apr_dbd_driver_t *driver, apr_pool_t *pool, 430251876Speter apr_dbd_t *handle, apr_dbd_results_t **res, 431251876Speter apr_dbd_prepared_t *statement, int random, 432251876Speter int nargs, const char **args); 433251876Speter 434251876Speter/** apr_dbd_pvquery: query using a prepared statement + args 435251876Speter * 436251876Speter * @param driver - the driver 437251876Speter * @param pool - working pool 438251876Speter * @param handle - the connection 439251876Speter * @param nrows - number of rows affected. 440251876Speter * @param statement - the prepared statement to execute 441251876Speter * @param ... - varargs list 442251876Speter * @return 0 for success or error code 443251876Speter */ 444251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvquery(const apr_dbd_driver_t *driver, 445251876Speter apr_pool_t *pool, 446251876Speter apr_dbd_t *handle, int *nrows, 447251876Speter apr_dbd_prepared_t *statement, ...); 448251876Speter 449251876Speter/** apr_dbd_pvselect: select using a prepared statement + args 450251876Speter * 451251876Speter * @param driver - the driver 452251876Speter * @param pool - working pool 453251876Speter * @param handle - the connection 454251876Speter * @param res - pointer to query results. May point to NULL on entry 455251876Speter * @param statement - the prepared statement to execute 456251876Speter * @param random - Whether to support random-access to results 457251876Speter * @param ... - varargs list 458251876Speter * @return 0 for success or error code 459251876Speter */ 460251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvselect(const apr_dbd_driver_t *driver, 461251876Speter apr_pool_t *pool, apr_dbd_t *handle, 462251876Speter apr_dbd_results_t **res, 463251876Speter apr_dbd_prepared_t *statement, 464251876Speter int random, ...); 465251876Speter 466251876Speter/** apr_dbd_pbquery: query using a prepared statement + binary args 467251876Speter * 468251876Speter * @param driver - the driver 469251876Speter * @param pool - working pool 470251876Speter * @param handle - the connection 471251876Speter * @param nrows - number of rows affected. 472251876Speter * @param statement - the prepared statement to execute 473251876Speter * @param args - binary args to prepared statement 474251876Speter * @return 0 for success or error code 475251876Speter */ 476251876SpeterAPU_DECLARE(int) apr_dbd_pbquery(const apr_dbd_driver_t *driver, 477251876Speter apr_pool_t *pool, apr_dbd_t *handle, 478251876Speter int *nrows, apr_dbd_prepared_t *statement, 479251876Speter const void **args); 480251876Speter 481251876Speter/** apr_dbd_pbselect: select using a prepared statement + binary args 482251876Speter * 483251876Speter * @param driver - the driver 484251876Speter * @param pool - working pool 485251876Speter * @param handle - the connection 486251876Speter * @param res - pointer to query results. May point to NULL on entry 487251876Speter * @param statement - the prepared statement to execute 488251876Speter * @param random - Whether to support random-access to results 489251876Speter * @param args - binary args to prepared statement 490251876Speter * @return 0 for success or error code 491251876Speter */ 492251876SpeterAPU_DECLARE(int) apr_dbd_pbselect(const apr_dbd_driver_t *driver, 493251876Speter apr_pool_t *pool, 494251876Speter apr_dbd_t *handle, apr_dbd_results_t **res, 495251876Speter apr_dbd_prepared_t *statement, int random, 496251876Speter const void **args); 497251876Speter 498251876Speter/** apr_dbd_pvbquery: query using a prepared statement + binary args 499251876Speter * 500251876Speter * @param driver - the driver 501251876Speter * @param pool - working pool 502251876Speter * @param handle - the connection 503251876Speter * @param nrows - number of rows affected. 504251876Speter * @param statement - the prepared statement to execute 505251876Speter * @param ... - varargs list of binary args 506251876Speter * @return 0 for success or error code 507251876Speter */ 508251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvbquery(const apr_dbd_driver_t *driver, 509251876Speter apr_pool_t *pool, 510251876Speter apr_dbd_t *handle, int *nrows, 511251876Speter apr_dbd_prepared_t *statement, ...); 512251876Speter 513251876Speter/** apr_dbd_pvbselect: select using a prepared statement + binary args 514251876Speter * 515251876Speter * @param driver - the driver 516251876Speter * @param pool - working pool 517251876Speter * @param handle - the connection 518251876Speter * @param res - pointer to query results. May point to NULL on entry 519251876Speter * @param statement - the prepared statement to execute 520251876Speter * @param random - Whether to support random-access to results 521251876Speter * @param ... - varargs list of binary args 522251876Speter * @return 0 for success or error code 523251876Speter */ 524251876SpeterAPU_DECLARE_NONSTD(int) apr_dbd_pvbselect(const apr_dbd_driver_t *driver, 525251876Speter apr_pool_t *pool, apr_dbd_t *handle, 526251876Speter apr_dbd_results_t **res, 527251876Speter apr_dbd_prepared_t *statement, 528251876Speter int random, ...); 529251876Speter 530251876Speter/** apr_dbd_datum_get: get a binary entry from a row 531251876Speter * 532251876Speter * @param driver - the driver 533251876Speter * @param row - row pointer 534251876Speter * @param col - entry number 535251876Speter * @param type - type of data to get 536251876Speter * @param data - pointer to data, allocated by the caller 537251876Speter * @return APR_SUCCESS on success, APR_ENOENT if data is NULL or APR_EGENERAL 538251876Speter */ 539251876SpeterAPU_DECLARE(apr_status_t) apr_dbd_datum_get(const apr_dbd_driver_t *driver, 540251876Speter apr_dbd_row_t *row, int col, 541251876Speter apr_dbd_type_e type, void *data); 542251876Speter 543251876Speter/** @} */ 544251876Speter 545251876Speter#ifdef __cplusplus 546251876Speter} 547251876Speter#endif 548251876Speter 549251876Speter#endif 550