Apache Portable Runtime
|
Macros | |
#define | APR_DBD_TRANSACTION_COMMIT 0x00 |
#define | APR_DBD_TRANSACTION_ROLLBACK 0x01 |
#define | APR_DBD_TRANSACTION_IGNORE_ERRORS 0x02 |
Typedefs | |
typedef struct apr_dbd_driver_t | apr_dbd_driver_t |
typedef struct apr_dbd_t | apr_dbd_t |
typedef struct apr_dbd_transaction_t | apr_dbd_transaction_t |
typedef struct apr_dbd_results_t | apr_dbd_results_t |
typedef struct apr_dbd_row_t | apr_dbd_row_t |
typedef struct apr_dbd_prepared_t | apr_dbd_prepared_t |
Functions | |
apr_status_t | apr_dbd_init (apr_pool_t *pool) |
apr_status_t | apr_dbd_get_driver (apr_pool_t *pool, const char *name, const apr_dbd_driver_t **driver) |
apr_status_t | apr_dbd_open_ex (const apr_dbd_driver_t *driver, apr_pool_t *pool, const char *params, apr_dbd_t **handle, const char **error) |
apr_status_t | apr_dbd_open (const apr_dbd_driver_t *driver, apr_pool_t *pool, const char *params, apr_dbd_t **handle) |
apr_status_t | apr_dbd_close (const apr_dbd_driver_t *driver, apr_dbd_t *handle) |
const char * | apr_dbd_name (const apr_dbd_driver_t *driver) |
void * | apr_dbd_native_handle (const apr_dbd_driver_t *driver, apr_dbd_t *handle) |
int | apr_dbd_check_conn (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle) |
int | apr_dbd_set_dbname (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, const char *name) |
int | apr_dbd_transaction_start (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_transaction_t **trans) |
int | apr_dbd_transaction_end (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_transaction_t *trans) |
int | apr_dbd_transaction_mode_get (const apr_dbd_driver_t *driver, apr_dbd_transaction_t *trans) |
int | apr_dbd_transaction_mode_set (const apr_dbd_driver_t *driver, apr_dbd_transaction_t *trans, int mode) |
int | apr_dbd_query (const apr_dbd_driver_t *driver, apr_dbd_t *handle, int *nrows, const char *statement) |
int | apr_dbd_select (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_results_t **res, const char *statement, int random) |
int | apr_dbd_num_cols (const apr_dbd_driver_t *driver, apr_dbd_results_t *res) |
int | apr_dbd_num_tuples (const apr_dbd_driver_t *driver, apr_dbd_results_t *res) |
int | apr_dbd_get_row (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_results_t *res, apr_dbd_row_t **row, int rownum) |
const char * | apr_dbd_get_entry (const apr_dbd_driver_t *driver, apr_dbd_row_t *row, int col) |
const char * | apr_dbd_get_name (const apr_dbd_driver_t *driver, apr_dbd_results_t *res, int col) |
const char * | apr_dbd_error (const apr_dbd_driver_t *driver, apr_dbd_t *handle, int errnum) |
const char * | apr_dbd_escape (const apr_dbd_driver_t *driver, apr_pool_t *pool, const char *string, apr_dbd_t *handle) |
int | apr_dbd_prepare (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, const char *query, const char *label, apr_dbd_prepared_t **statement) |
int | apr_dbd_pquery (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, int *nrows, apr_dbd_prepared_t *statement, int nargs, const char **args) |
int | apr_dbd_pselect (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_results_t **res, apr_dbd_prepared_t *statement, int random, int nargs, const char **args) |
int | apr_dbd_pvquery (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, int *nrows, apr_dbd_prepared_t *statement,...) |
int | apr_dbd_pvselect (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_results_t **res, apr_dbd_prepared_t *statement, int random,...) |
int | apr_dbd_pbquery (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, int *nrows, apr_dbd_prepared_t *statement, const void **args) |
int | apr_dbd_pbselect (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_results_t **res, apr_dbd_prepared_t *statement, int random, const void **args) |
int | apr_dbd_pvbquery (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, int *nrows, apr_dbd_prepared_t *statement,...) |
int | apr_dbd_pvbselect (const apr_dbd_driver_t *driver, apr_pool_t *pool, apr_dbd_t *handle, apr_dbd_results_t **res, apr_dbd_prepared_t *statement, int random,...) |
apr_status_t | apr_dbd_datum_get (const apr_dbd_driver_t *driver, apr_dbd_row_t *row, int col, apr_dbd_type_e type, void *data) |
#define APR_DBD_TRANSACTION_COMMIT 0x00 |
commit the transaction
#define APR_DBD_TRANSACTION_IGNORE_ERRORS 0x02 |
ignore transaction errors
#define APR_DBD_TRANSACTION_ROLLBACK 0x01 |
rollback the transaction
enum apr_dbd_type_e |
Mapping of C to SQL types, used for prepared statements.
int apr_dbd_check_conn | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle | ||
) |
check_conn: check status of a database connection
driver | - the driver |
pool | - working pool |
handle | - the connection to check |
apr_status_t apr_dbd_close | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_t * | handle | ||
) |
apr_dbd_close: close a connection to a backend
driver | - driver struct. |
handle | - handle to close |
apr_status_t apr_dbd_datum_get | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_row_t * | row, | ||
int | col, | ||
apr_dbd_type_e | type, | ||
void * | data | ||
) |
apr_dbd_datum_get: get a binary entry from a row
driver | - the driver |
row | - row pointer |
col | - entry number |
type | - type of data to get |
data | - pointer to data, allocated by the caller |
const char* apr_dbd_error | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_t * | handle, | ||
int | errnum | ||
) |
apr_dbd_error: get current error message (if any)
driver | - the driver |
handle | - the connection |
errnum | - error code from operation that returned an error |
const char* apr_dbd_escape | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
const char * | string, | ||
apr_dbd_t * | handle | ||
) |
apr_dbd_escape: escape a string so it is safe for use in query/select
driver | - the driver |
pool | - pool to alloc the result from |
string | - the string to escape |
handle | - the connection |
apr_status_t apr_dbd_get_driver | ( | apr_pool_t * | pool, |
const char * | name, | ||
const apr_dbd_driver_t ** | driver | ||
) |
apr_dbd_get_driver: get the driver struct for a name
pool | - (process) pool to register cleanup |
name | - driver name |
driver | - pointer to driver struct. |
const char* apr_dbd_get_entry | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_row_t * | row, | ||
int | col | ||
) |
apr_dbd_get_entry: get an entry from a row
driver | - the driver |
row | - row pointer |
col | - entry number |
const char* apr_dbd_get_name | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_results_t * | res, | ||
int | col | ||
) |
apr_dbd_get_name: get an entry name from a result set
driver | - the driver |
res | - result set pointer |
col | - entry number |
int apr_dbd_get_row | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_results_t * | res, | ||
apr_dbd_row_t ** | row, | ||
int | rownum | ||
) |
apr_dbd_get_row: get a row from a result set
driver | - the driver |
pool | - pool to allocate the row |
res | - result set pointer |
row | - pointer to row pointer. May point to NULL on entry |
rownum | - row number (counting from 1), or -1 for "next row". Ignored if random access is not supported. |
apr_status_t apr_dbd_init | ( | apr_pool_t * | pool | ) |
apr_dbd_init: perform once-only initialisation. Call once only.
pool | - pool to register any shutdown cleanups, etc |
const char* apr_dbd_name | ( | const apr_dbd_driver_t * | driver | ) |
apr_dbd_name: get the name of the driver
driver | - the driver |
void* apr_dbd_native_handle | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_t * | handle | ||
) |
apr_dbd_native_handle: get native database handle of the underlying db
driver | - the driver |
handle | - apr_dbd handle |
int apr_dbd_num_cols | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_results_t * | res | ||
) |
apr_dbd_num_cols: get the number of columns in a results set
driver | - the driver |
res | - result set. |
int apr_dbd_num_tuples | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_results_t * | res | ||
) |
apr_dbd_num_tuples: get the number of rows in a results set of a synchronous select
driver | - the driver |
res | - result set. |
apr_status_t apr_dbd_open | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
const char * | params, | ||
apr_dbd_t ** | handle | ||
) |
apr_dbd_open: open a connection to a backend
driver | - driver struct. |
pool | - working pool |
params | - arguments to driver (implementation-dependent) |
handle | - pointer to handle to return |
apr_status_t apr_dbd_open_ex | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
const char * | params, | ||
apr_dbd_t ** | handle, | ||
const char ** | error | ||
) |
apr_dbd_open_ex: open a connection to a backend
driver | - driver struct. |
pool | - working pool |
params | - arguments to driver (implementation-dependent) |
handle | - pointer to handle to return |
error | - descriptive error. |
int apr_dbd_pbquery | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
int * | nrows, | ||
apr_dbd_prepared_t * | statement, | ||
const void ** | args | ||
) |
apr_dbd_pbquery: query using a prepared statement + binary args
driver | - the driver |
pool | - working pool |
handle | - the connection |
nrows | - number of rows affected. |
statement | - the prepared statement to execute |
args | - binary args to prepared statement |
int apr_dbd_pbselect | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
apr_dbd_results_t ** | res, | ||
apr_dbd_prepared_t * | statement, | ||
int | random, | ||
const void ** | args | ||
) |
apr_dbd_pbselect: select using a prepared statement + binary args
driver | - the driver |
pool | - working pool |
handle | - the connection |
res | - pointer to query results. May point to NULL on entry |
statement | - the prepared statement to execute |
random | - Whether to support random-access to results |
args | - binary args to prepared statement |
int apr_dbd_pquery | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
int * | nrows, | ||
apr_dbd_prepared_t * | statement, | ||
int | nargs, | ||
const char ** | args | ||
) |
apr_dbd_pquery: query using a prepared statement + args
driver | - the driver |
pool | - working pool |
handle | - the connection |
nrows | - number of rows affected. |
statement | - the prepared statement to execute |
nargs | - ignored (for backward compatibility only) |
args | - args to prepared statement |
int apr_dbd_prepare | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
const char * | query, | ||
const char * | label, | ||
apr_dbd_prepared_t ** | statement | ||
) |
apr_dbd_prepare: prepare a statement
driver | - the driver |
pool | - pool to alloc the result from |
handle | - the connection |
query | - the SQL query |
label | - A label for the prepared statement. use NULL for temporary prepared statements (eg within a Request in httpd) |
statement | - statement to prepare. May point to null on entry. |
int apr_dbd_pselect | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
apr_dbd_results_t ** | res, | ||
apr_dbd_prepared_t * | statement, | ||
int | random, | ||
int | nargs, | ||
const char ** | args | ||
) |
apr_dbd_pselect: select using a prepared statement + args
driver | - the driver |
pool | - working pool |
handle | - the connection |
res | - pointer to query results. May point to NULL on entry |
statement | - the prepared statement to execute |
random | - Whether to support random-access to results |
nargs | - ignored (for backward compatibility only) |
args | - args to prepared statement |
int apr_dbd_pvbquery | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
int * | nrows, | ||
apr_dbd_prepared_t * | statement, | ||
... | |||
) |
apr_dbd_pvbquery: query using a prepared statement + binary args
driver | - the driver |
pool | - working pool |
handle | - the connection |
nrows | - number of rows affected. |
statement | - the prepared statement to execute |
... | - varargs list of binary args |
int apr_dbd_pvbselect | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
apr_dbd_results_t ** | res, | ||
apr_dbd_prepared_t * | statement, | ||
int | random, | ||
... | |||
) |
apr_dbd_pvbselect: select using a prepared statement + binary args
driver | - the driver |
pool | - working pool |
handle | - the connection |
res | - pointer to query results. May point to NULL on entry |
statement | - the prepared statement to execute |
random | - Whether to support random-access to results |
... | - varargs list of binary args |
int apr_dbd_pvquery | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
int * | nrows, | ||
apr_dbd_prepared_t * | statement, | ||
... | |||
) |
apr_dbd_pvquery: query using a prepared statement + args
driver | - the driver |
pool | - working pool |
handle | - the connection |
nrows | - number of rows affected. |
statement | - the prepared statement to execute |
... | - varargs list |
int apr_dbd_pvselect | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
apr_dbd_results_t ** | res, | ||
apr_dbd_prepared_t * | statement, | ||
int | random, | ||
... | |||
) |
apr_dbd_pvselect: select using a prepared statement + args
driver | - the driver |
pool | - working pool |
handle | - the connection |
res | - pointer to query results. May point to NULL on entry |
statement | - the prepared statement to execute |
random | - Whether to support random-access to results |
... | - varargs list |
int apr_dbd_query | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_t * | handle, | ||
int * | nrows, | ||
const char * | statement | ||
) |
apr_dbd_query: execute an SQL query that doesn't return a result set
driver | - the driver |
handle | - the connection |
nrows | - number of rows affected. |
statement | - the SQL statement to execute |
int apr_dbd_select | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
apr_dbd_results_t ** | res, | ||
const char * | statement, | ||
int | random | ||
) |
apr_dbd_select: execute an SQL query that returns a result set
driver | - the driver |
pool | - pool to allocate the result set |
handle | - the connection |
res | - pointer to result set pointer. May point to NULL on entry |
statement | - the SQL statement to execute |
random | - 1 to support random access to results (seek any row); 0 to support only looping through results in order (async access - faster) |
int apr_dbd_set_dbname | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
const char * | name | ||
) |
apr_dbd_set_dbname: select database name. May be a no-op if not supported.
driver | - the driver |
pool | - working pool |
handle | - the connection |
name | - the database to select |
int apr_dbd_transaction_end | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_transaction_t * | trans | ||
) |
apr_dbd_transaction_end: end a transaction (commit on success, rollback on error). May be a no-op.
driver | - the driver |
pool | - working pool |
trans | - the transaction |
int apr_dbd_transaction_mode_get | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_transaction_t * | trans | ||
) |
apr_dbd_transaction_mode_get: get the mode of transaction
driver | - the driver |
trans | - the transaction |
int apr_dbd_transaction_mode_set | ( | const apr_dbd_driver_t * | driver, |
apr_dbd_transaction_t * | trans, | ||
int | mode | ||
) |
apr_dbd_transaction_mode_set: set the mode of transaction
driver | - the driver |
trans | - the transaction |
mode | - new mode of the transaction |
int apr_dbd_transaction_start | ( | const apr_dbd_driver_t * | driver, |
apr_pool_t * | pool, | ||
apr_dbd_t * | handle, | ||
apr_dbd_transaction_t ** | trans | ||
) |
apr_dbd_transaction_start: start a transaction. May be a no-op.
driver | - the driver |
pool | - a pool to use for error messages (if any). |
handle | - the db connection |
trans | - ptr to a transaction. May be null on entry |