db-lib
for self-help.
More...Classes | |
struct | _dblib_error_message |
For internal use only. More... | |
Typedefs | |
typedef struct _dblib_error_message | DBLIB_ERROR_MESSAGE |
Functions | |
int | _dblib_check_and_handle_interrupt (void *vdbproc) |
check interrupts for libtds. | |
RETCODE | dbcmdrow (DBPROCESS *dbproc) |
For internal use only.
| |
DBINT | dbcount (DBPROCESS *dbproc) |
For internal use only.
| |
int | dbcurcmd (DBPROCESS *dbproc) |
For internal use only.
| |
DBINT | dbcurrow (DBPROCESS *dbproc) |
For internal use only.
| |
DBBOOL | dbdead (DBPROCESS *dbproc) |
For internal use only.
| |
DBINT | dbfirstrow (DBPROCESS *dbproc) |
For internal use only.
| |
int | dbiordesc (DBPROCESS *dbproc) |
For internal use only.
| |
int | dbiowdesc (DBPROCESS *dbproc) |
For internal use only.
| |
DBINT | dblastrow (DBPROCESS *dbproc) |
For internal use only.
| |
int | dbperror (DBPROCESS *dbproc, DBINT msgno, long errnum,...) |
For internal use only.
| |
RETCODE | dbrows (DBPROCESS *dbproc) |
For internal use only.
| |
STATUS | dbrowtype (DBPROCESS *dbproc) |
For internal use only.
| |
void | dbsetavail (DBPROCESS *dbproc) |
For internal use only.
| |
RETCODE | dbsetlbool (LOGINREC *login, int value, int which) |
For internal use only.
| |
RETCODE | dbsetllong (LOGINREC *login, long value, int which) |
For internal use only.
| |
RETCODE | dbsetlname (LOGINREC *login, const char *value, int which) |
For internal use only.
| |
RETCODE | dbsetlshort (LOGINREC *login, int value, int which) |
For internal use only.
| |
int | dbtds (DBPROCESS *dbproc) |
For internal use only.
| |
static int | default_err_handler (DBPROCESS *dbproc, int severity, int dberr, int oserr, char *dberrstr, char *oserrstr) |
For internal use only.
| |
DBPROCESS * | tdsdbopen (LOGINREC *login, const char *server, int msdblib) |
For internal use only.
|
db-lib
for self-help.
These functions are of interest only to people hacking on the FreeTDS db-lib implementation.
int _dblib_check_and_handle_interrupt | ( | void * | vdbproc | ) |
check interrupts for libtds.
vdbproc | a DBPROCESS pointer, contains all information needed by db-lib to manage communications with the server. |
RETCODE dbcmdrow | ( | DBPROCESS * | dbproc | ) |
For internal use only.
See if the current command can return rows.
dbproc | contains all information needed by db-lib to manage communications with the server. |
SUCCEED | Yes, it can. | |
FAIL | No, it can't. |
DBINT dbcount | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get count of rows processed
dbproc | contains all information needed by db-lib to manage communications with the server. |
int dbcurcmd | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get number of the row just returned.
dbproc | contains all information needed by db-lib to manage communications with the server. |
DBINT dbcurrow | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get number of the row currently being read.
dbproc | contains all information needed by db-lib to manage communications with the server. |
0 | Always. |
DBBOOL dbdead | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Check if dbproc is an ex-parrot.
dbproc | contains all information needed by db-lib to manage communications with the server. |
TRUE | process has been marked dead. | |
FALSE | process is OK. |
FALSE
. DBINT dbfirstrow | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get number of the first row in the row buffer.
dbproc | contains all information needed by db-lib to manage communications with the server. |
int dbiordesc | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get file descriptor of the socket used by a DBPROCESS
to read data coming from the server. (!)
dbproc | contains all information needed by db-lib to manage communications with the server. |
int dbiowdesc | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get file descriptor of the socket used by a DBPROCESS
to write data coming to the server. (!)
dbproc | contains all information needed by db-lib to manage communications with the server. |
DBINT dblastrow | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get number of the last row in the row buffer.
dbproc | contains all information needed by db-lib to manage communications with the server. |
int dbperror | ( | DBPROCESS * | dbproc, | |
DBINT | msgno, | |||
long | errnum, | |||
... | ||||
) |
For internal use only.
Call client-installed error handler
dbproc | contains all information needed by db-lib to manage communications with the server. | |
msgno | identifies the error message to be passed to the client's handler. | |
errnum | identifies the OS error (errno), if any. Use 0 if not applicable. |
Instead of sprinkling error text all over db-lib, we consolidate it here, where it can be translated (one day), and where it can be mapped to the TDS error number. The libraries don't use consistent error numbers or messages, so when libtds has to emit an error message, it can't include the text. It can pass its error number to a client-library function, which will interpret it, add the text, call the application's installed handler (if any) and return the handler's return code back to the caller.
The call stack may look something like this:
The error handling in this case is unambiguous: the caller invokes this function, the client's handler returns its instruction, which the caller receives. Quite often the caller will get INT_CANCEL, in which case it should put its house in order and return FAIL.
The call stack may otherwise look something like this:
Because different client libraries specify their handler semantics differently, and because libtds doesn't know which client library is in charge of any given connection, it cannot interpret the raw return code from a db-lib error handler. For these reasons, libtds calls _dblib_handle_err_message, which translates between libtds and db-lib semantics.
RETCODE dbrows | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Indicate whether a query returned rows.
dbproc | contains all information needed by db-lib to manage communications with the server. |
STATUS dbrowtype | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get returned row's type.
dbproc | contains all information needed by db-lib to manage communications with the server. |
void dbsetavail | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Mark a DBPROCESS
as "available".
dbproc | contains all information needed by db-lib to manage communications with the server. |
FreeTDS
behaves the way Sybase's implementation does, but so what? Many db-lib
functions set the DBPROCESS
to "not available", but only dbsetavail() resets it to "available". RETCODE dbsetlbool | ( | LOGINREC * | login, | |
int | value, | |||
int | which | |||
) |
For internal use only.
Set a boolean value in a LOGINREC
structure.
Called by various macros to populate login.
login | the LOGINREC* to modify. | |
value | the value to set it to. | |
which | the field to set. |
SUCCEED | the value was set. | |
FAIL | invalid value passed for which. |
RETCODE dbsetllong | ( | LOGINREC * | login, | |
long | value, | |||
int | which | |||
) |
For internal use only.
Set an integer value in a LOGINREC
structure.
Called by various macros to populate login.
login | the LOGINREC* to modify. | |
value | the value to set it to. | |
which | the field to set. |
SUCCEED | the value was set. | |
FAIL | anything other than DBSETPACKET was passed for which. |
RETCODE dbsetlname | ( | LOGINREC * | login, | |
const char * | value, | |||
int | which | |||
) |
For internal use only.
Set the value of a string in a LOGINREC
structure.
Called by various macros to populate login.
login | the LOGINREC* to modify. | |
value | the value to set it to. | |
which | the field to set. |
SUCCEED | the value was set. | |
FAIL | DBSETHID or other invalid which was tried. |
RETCODE dbsetlshort | ( | LOGINREC * | login, | |
int | value, | |||
int | which | |||
) |
For internal use only.
Set an integer value in a LOGINREC
structure.
Called by various macros to populate login.
login | the LOGINREC* to modify. | |
value | the value to set it to. | |
which | the field to set. |
SUCCEED | the value was set. | |
FAIL | anything other than DBSETHIER was passed for which. |
int dbtds | ( | DBPROCESS * | dbproc | ) |
For internal use only.
Get the TDS version in use for dbproc.
dbproc | contains all information needed by db-lib to manage communications with the server. |
DBTDS*
token. static int default_err_handler | ( | DBPROCESS * | dbproc, | |
int | severity, | |||
int | dberr, | |||
int | oserr, | |||
char * | dberrstr, | |||
char * | oserrstr | |||
) | [static] |
For internal use only.
default error handler for db-lib (handles library-generated errors)
The default error handler doesn't print anything. If you want to see your messages printed, install an error handler. If you think that should be an optional compile- or run-time default, submit a patch. It could be done.
DBPROCESS* tdsdbopen | ( | LOGINREC * | login, | |
const char * | server, | |||
int | msdblib | |||
) |
For internal use only.
Form a connection with the server.
Called by the dbopen()
macro, normally. If FreeTDS was configured with --enable-msdblib
, this function is called by (exported) dbopen()
function. tdsdbopen
is so-named to avoid namespace conflicts with other database libraries that use the same function name.
login | LOGINREC* carrying the account information. | |
server | name of the dataserver to connect to. |
NULL | insufficient memory, unable to connect for any reason. |
asprintf()
to avoid buffer overflow.