Return to pa_sql_driver.h CVS log

Up to [parser3project] / parser3 / src / sql

Annotation of parser3/src/sql/pa_sql_driver.h, revision 1.16

1.1       paf         1: /** @file
                      2:        Parser: sql driver interface.
                      3: 
                      4:        Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
                      5: 
                      6:        Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
                      7: 
1.16    ! parser      8:        $Id: pa_sql_driver.h,v 1.15 2001/09/05 09:22:45 parser Exp $
1.1       paf         9: 
                     10: 
                     11:        driver dynamic library must look like this:
                     12:        @code
                     13:                class X_SQL_Driver : public SQL_Driver {
                     14:                public:
                     15: 
                     16:                        X_SQL_Driver() : SQL_driver() {}
                     17: 
                     18:                        int api_version() { return SQL_DRIVER_API_VERSION; }
                     19:                        
                     20:                        //...
                     21:                };
                     22: 
                     23:                extern "C" SQL_Driver *create() {
                     24:                        return new X_SQL_Driver();
                     25:                }       
                     26:        @endcode
                     27: */
                     28: 
                     29: #ifndef PA_SQL_DRIVER_H
                     30: #define PA_SQL_DRIVER_H
                     31: 
1.2       paf        32: #include <sys/types.h>
1.1       paf        33: 
                     34: /// service functions for SQL driver to use
1.7       paf        35: class SQL_Driver_services {
1.1       paf        36: public:
                     37:        /// allocates some bytes on pool
                     38:        virtual void *malloc(size_t size) =0;
                     39:        /// allocates some bytes clearing them with zeros
                     40:        virtual void *calloc(size_t size) =0;
                     41:        /// throw exception
                     42:        virtual void _throw(const char *comment) =0;
                     43: };
                     44: 
1.13      parser     45: #define SQL_DRIVER_API_VERSION 0x0304
1.15      parser     46: #define SQL_DRIVER_CREATE create
1.16    ! parser     47: #define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */
1.11      parser     48: 
                     49: /// events, occuring when SQL_Driver::query()-ing
                     50: class SQL_Driver_query_event_handlers {
                     51: public:
                     52:        virtual void add_column(void *ptr, size_t size) =0;
                     53:        virtual void before_rows() =0;
                     54:        virtual void add_row() =0;
                     55:        virtual void add_row_cell(void *ptr, size_t size) =0;
                     56: };
1.1       paf        57: 
                     58: /// SQL driver API
                     59: class SQL_Driver {
                     60: public:
                     61: 
1.10      parser     62:        SQL_Driver() {}
1.1       paf        63:        /// get api version
                     64:        virtual int api_version() =0;
1.6       paf        65:        /// initialize driver by loading sql dynamic link library
                     66:        virtual const char *initialize(const char *dlopen_file_spec) =0;
1.9       parser     67:        /**     connect to sql database using 
                     68:                @param used_only_to_connect_url 
                     69:                        format is driver specific
                     70:                        WARNING: must be used only to connect, for buffer doesn't live long enough
                     71: 
                     72:                @returns true+'connection' on success. 'error' on failure
                     73:        */
1.10      parser     74:        virtual void connect(char *used_only_in_connect_url_cstr, 
                     75:                SQL_Driver_services& services, void **connection) =0;
1.13      parser     76:        virtual void disconnect(void *connection) =0;
1.10      parser     77:        virtual void commit(
                     78:                SQL_Driver_services& services, void *connection) =0;
                     79:        virtual void rollback(
                     80:                SQL_Driver_services& services, void *connection) =0;
1.3       paf        81:        /// @returns true to indicate that connection still alive 
1.10      parser     82:        virtual bool ping(
                     83:                SQL_Driver_services& services, void *connection) =0;
1.4       paf        84:        /// encodes the string in 'from' to an escaped SQL string
1.10      parser     85:        virtual unsigned int quote(
                     86:                SQL_Driver_services& services, void *connection,
1.4       paf        87:                char *to, const char *from, unsigned int length) =0;
1.10      parser     88:        virtual void query(
                     89:                SQL_Driver_services& services, void *connection,
1.3       paf        90:                const char *statement, unsigned long offset, unsigned long limit,
1.11      parser     91:                SQL_Driver_query_event_handlers& handlers) =0;
1.1       paf        92: };
                     93: 
                     94: typedef SQL_Driver *(*SQL_Driver_create_func)();
                     95: 
                     96: #endif