Find file
Fetching contributors…
Cannot retrieve contributors at this time
261 lines (186 sloc) 10.2 KB
$Id: dbdimp.h 13162 2009-08-04 18:10:35Z turnstep $
Copyright (c) 2000-2009 Greg Sabino Mullane and others: see the Changes file
Portions Copyright (c) 1997-2000 Edmund Mergl
Portions Copyright (c) 1994-1997 Tim Bunce
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the Perl README file.
typedef enum {
COERR_PGFATAL, /* postgres failed for some reason; connection now busted */
COERR_INTERRUPTED, /* failed while waiting for read/writability */
COERR_EXTRA_RESULT, /* got a second PGresult */
COERR_PGRESULT, /* failed, but got a PGresult; read the error off of that */
} coro_error_t;
/* Define drh implementor data structure */
struct imp_drh_st {
dbih_drc_t com; /* MUST be first element in structure */
/* Define dbh implementor data structure */
struct imp_dbh_st {
dbih_dbc_t com; /* MUST be first element in structure */
int pg_protocol; /* value of PQprotocolVersion, usually 3 (could also be 0) */
int pg_server_version; /* server version e.g. 80100 */
int pid_number; /* prefixed before prepare_number */
int prepare_number; /* internal prepared statement name modifier */
int copystate; /* 0=none PGRES_COPY_IN PGRES_COPY_OUT */
int pg_errorlevel; /* PQsetErrorVerbosity. Set by user, defaults to 1 */
int server_prepare; /* do we want to use PQexecPrepared? 0=no 1=yes 2=smart. Can be changed by user */
int async_status; /* 0=no async 1=async started -1=async has been cancelled */
imp_sth_t *async_sth; /* current async statement handle */
AV *savepoints; /* list of savepoints */
PGconn *conn; /* connection structure */
char *sqlstate; /* from the last result */
bool pg_bool_tf; /* do bools return 't'/'f'? Set by user, default is 0 */
bool pg_enable_utf8; /* should we attempt to make utf8 strings? Set by user, default is 0 */
bool prepare_now; /* force immediate prepares, even with placeholders. Set by user, default is 0 */
bool done_begin; /* have we done a begin? (e.g. are we in a transaction?) */
bool dollaronly; /* only consider $1, $2 ... as valid placeholders */
bool expand_array; /* transform arrays from the db into Perl arrays? Default is 1 */
bool txn_read_only; /* are we in read-only mode? Set with $dbh->{ReadOnly} */
int socket_fd;
SV *coro_handle;
coro_error_t coro_error;
const char *last_result_err;
ExecStatusType last_result_status;
/* Each statement is broken up into segments */
struct seg_st {
char *segment; /* non-placeholder string segment */
int placeholder; /* which placeholder this points to, 0=none */
struct ph_st *ph; /* points to the relevant ph structure */
struct seg_st *nextseg; /* linked lists are fun */
typedef struct seg_st seg_t;
/* The placeholders are also a linked list */
struct ph_st {
char *fooname; /* name if using :foo style */
char *value; /* the literal passed-in value, may be binary */
STRLEN valuelen; /* length of the value */
char *quoted; /* quoted version of the value, for PQexec only */
STRLEN quotedlen; /* length of the quoted value */
bool referenced; /* used for PREPARE AS construction */
bool defaultval; /* is it using a generic 'default' value? */
bool iscurrent; /* do we want to use a literal CURRENT_TIMESTAMP? */
bool isdefault; /* are we passing a literal 'DEFAULT'? */
bool isinout; /* is this a bind_param_inout value? */
SV *inout; /* what variable we are updating via inout magic */
sql_type_info_t* bind_type; /* type information for this placeholder */
struct ph_st *nextph; /* more linked list goodness */
typedef struct ph_st ph_t;
/* Define sth implementor data structure */
struct imp_sth_st {
dbih_stc_t com; /* MUST be first element in structure */
int server_prepare; /* inherited from dbh. 3 states: 0=no 1=yes 2=smart */
int placeholder_type; /* which style is being used 1=? 2=$1 3=:foo */
int numsegs; /* how many segments this statement has */
int numphs; /* how many placeholders this statement has */
int numbound; /* how many placeholders were explicitly bound by the client, not us */
int cur_tuple; /* current tuple being fetched */
int rows; /* number of affected rows */
int async_flag; /* async? 0=no 1=async 2=cancel 4=wait */
int async_status; /* 0=no async 1=async started -1=async has been cancelled */
STRLEN totalsize; /* total string length of the statement (with no placeholders)*/
const char ** PQvals; /* List of values to pass to PQ* */
int * PQlens; /* List of lengths to pass to PQ* */
int * PQfmts; /* List of formats to pass to PQ* */
Oid * PQoids; /* List of types to pass to PQ* */
char *prepare_name; /* name of the prepared query; NULL if not prepared */
char *firstword; /* first word of the statement */
PGresult *result; /* result structure from the executed query */
sql_type_info_t **type_info; /* type of each column in result */
seg_t *seg; /* linked list of segments */
ph_t *ph; /* linked list of placeholders */
bool prepare_now; /* prepare this statement right away, even if it has placeholders */
bool prepared_by_us; /* false if {prepare_name} set directly */
bool onetime; /* this statement is guaranteed not to be run again - so don't use SSP */
bool direct; /* allow bypassing of the statement parsing */
bool is_dml; /* is this SELECT/INSERT/UPDATE/DELETE? */
bool has_binary; /* does it have one or more binary placeholders? */
bool has_default; /* does it have one or more 'DEFAULT' values? */
bool has_current; /* does it have one or more 'DEFAULT' values? */
bool dollaronly; /* Only use $1 as placeholders, allow all else */
bool use_inout; /* Any placeholders using inout? */
bool all_bound; /* Have all placeholders been bound? */
/* Avoid name clashes by assigning DBI funcs to a pg_ name. */
/* In order of appearance in dbdimp.c */
#define dbd_init pg_init
extern void dbd_init (dbistate_t *dbistate);
#define dbd_db_login pg_db_login
int dbd_db_login (SV * dbh, imp_dbh_t * imp_dbh, char * dbname, char * uid, char * pwd);
#define dbd_db_ping pg_db_ping
int dbd_db_ping(SV *dbh);
#define dbd_db_commit pg_db_commit
int dbd_db_commit (SV * dbh, imp_dbh_t * imp_dbh);
#define dbd_db_rollback pg_db_rollback
int dbd_db_rollback (SV * dbh, imp_dbh_t * imp_dbh);
#define dbd_db_disconnect pg_db_disconnect
int dbd_db_disconnect (SV * dbh, imp_dbh_t * imp_dbh);
#define dbd_db_destroy pg_db_destroy
void dbd_db_destroy (SV * dbh, imp_dbh_t * imp_dbh);
#define dbd_db_FETCH_attrib pg_db_FETCH_attrib
SV * dbd_db_FETCH_attrib (SV * dbh, imp_dbh_t * imp_dbh, SV * keysv);
#define dbd_db_STORE_attrib pg_db_STORE_attrib
int dbd_db_STORE_attrib (SV * dbh, imp_dbh_t * imp_dbh, SV * keysv, SV * valuesv);
#define dbd_st_FETCH_attrib pg_st_FETCH_attrib
SV * dbd_st_FETCH_attrib (SV * sth, imp_sth_t * imp_sth, SV * keysv);
#define dbd_st_STORE_attrib pg_st_STORE_attrib
int dbd_st_STORE_attrib (SV * sth, imp_sth_t * imp_sth, SV * keysv, SV * valuesv);
#define dbd_discon_all pg_discon_all
int dbd_discon_all (SV * drh, imp_drh_t * imp_drh);
#define dbd_st_prepare pg_st_prepare
int dbd_st_prepare (SV * sth, imp_sth_t * imp_sth, char * statement, SV * attribs);
#define dbd_bind_ph pg_bind_ph
int dbd_bind_ph (SV * sth, imp_sth_t * imp_sth, SV * ph_name, SV * newvalue, IV sql_type, SV * attribs, int is_inout, IV maxlen);
#define dbd_st_execute pg_st_execute
int dbd_st_execute (SV * sth, imp_sth_t * imp_sth);
#define dbd_st_fetch pg_st_fetch
AV * dbd_st_fetch (SV * sth, imp_sth_t * imp_sth);
#define dbd_st_rows pg_st_rows
int dbd_st_rows (SV * sth, imp_sth_t * imp_sth);
#define dbd_st_finish pg_st_finidh
int dbd_st_finish (SV * sth, imp_sth_t * imp_sth);
#define dbd_st_destroy pg_st_destroy
void dbd_st_destroy (SV * sth, imp_sth_t * imp_sth);
#define dbd_st_blob_read pg_st_blob_read
int dbd_st_blob_read (SV * sth, imp_sth_t * imp_sth, int lobjId, long offset, long len, SV * destrv, long destoffset);
Everything else should map back to the DBI version, or be handled by
TODO: Explicitly map out each one.
/* Custom PG functions, in order they appear in dbdimp.c */
int pg_db_getfd (imp_dbh_t * imp_dbh);
SV * pg_db_pg_notifies (SV *dbh, imp_dbh_t *imp_dbh);
SV * pg_stringify_array(SV * input, const char * array_delim, int server_version, int extraquotes);
int pg_quickexec (SV *dbh, const char *sql, const int asyncflag);
int pg_db_putline (pTHX_ SV *dbh, SV *svbuf);
int pg_db_getline (pTHX_ SV *dbh, SV * svbuf, int length);
int pg_db_getcopydata (pTHX_ SV *dbh, SV * dataline, int async);
int pg_db_putcopydata (pTHX_ SV *dbh, SV * dataline);
int pg_db_putcopyend (pTHX_ SV * dbh);
int pg_db_endcopy (pTHX_ SV * dbh);
void pg_db_pg_server_trace (SV *dbh, FILE *fh);
void pg_db_pg_server_untrace (SV *dbh);
int pg_db_savepoint (SV *dbh, imp_dbh_t *imp_dbh, char * savepoint);
int pg_db_rollback_to (SV *dbh, imp_dbh_t *imp_dbh, const char * savepoint);
int pg_db_release (SV *dbh, imp_dbh_t *imp_dbh, char * savepoint);
unsigned int pg_db_lo_creat (SV *dbh, int mode);
int pg_db_lo_open (SV *dbh, unsigned int lobjId, int mode);
int pg_db_lo_close (SV *dbh, int fd);
int pg_db_lo_read (SV *dbh, int fd, char *buf, size_t len);
int pg_db_lo_write (SV *dbh, int fd, char *buf, size_t len);
int pg_db_lo_lseek (SV *dbh, int fd, int offset, int whence);
int pg_db_lo_tell (SV *dbh, int fd);
int pg_db_lo_unlink (SV *dbh, unsigned int lobjId);
unsigned int pg_db_lo_import (SV *dbh, char *filename);
int pg_db_lo_export (SV *dbh, unsigned int lobjId, char *filename);
int pg_db_result (SV *h, imp_dbh_t *imp_dbh);
int pg_db_ready(SV *h, imp_dbh_t *imp_dbh);
int pg_db_cancel (SV *h, imp_dbh_t *imp_dbh);
int pg_db_cancel_sth (SV *sth, imp_sth_t *imp_sth);
/* end of dbdimp.h */
/* vim: noet sts=0 ts=8 sw=8 */