--- parser3/src/sql/pa_sql_driver.h 2001/04/17 19:00:46 1.6 +++ parser3/src/sql/pa_sql_driver.h 2001/11/11 10:52:50 1.21 @@ -1,92 +1,100 @@ -/** @file - Parser: sql driver interface. - - Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) - - Author: Alexander Petrosyan (http://design.ru/paf) - - $Id: pa_sql_driver.h,v 1.6 2001/04/17 19:00:46 paf Exp $ - - - driver dynamic library must look like this: - @code - class X_SQL_Driver : public SQL_Driver { - public: - - X_SQL_Driver() : SQL_driver() {} - - int api_version() { return SQL_DRIVER_API_VERSION; } - - //... - }; - - extern "C" SQL_Driver *create() { - return new X_SQL_Driver(); - } - @endcode -*/ - -#ifndef PA_SQL_DRIVER_H -#define PA_SQL_DRIVER_H - -#include - -/// service functions for SQL driver to use -class Services_for_SQL_driver { -public: - /// allocates some bytes on pool - virtual void *malloc(size_t size) =0; - /// allocates some bytes clearing them with zeros - virtual void *calloc(size_t size) =0; - /// throw exception - virtual void _throw(const char *comment) =0; -}; - -#define SQL_DRIVER_API_VERSION 0x0301 - -/// SQL driver API -class SQL_Driver { -public: - - struct Cell { - void *ptr; - size_t size; - }; - -public: - - /// assignes services to driver. you can not use driver until this - void set_services(Services_for_SQL_driver *aservices) { services=aservices; } - - SQL_Driver() : - services(0) { - } - /// get api version - virtual int api_version() =0; - /// initialize driver by loading sql dynamic link library - virtual const char *initialize(const char *dlopen_file_spec) =0; - /// connect. @returns true+'connection' on success. 'error' on failure - virtual void connect(char *url, void **connection) =0; - virtual void disconnect(void *connection) =0; - virtual void commit(void *connection) =0; - virtual void rollback(void *connection) =0; - /// @returns true to indicate that connection still alive - virtual bool ping(void *connection) =0; - /// encodes the string in 'from' to an escaped SQL string - virtual unsigned int quote(void *connection, - char *to, const char *from, unsigned int length) =0; - virtual void query(void *connection, - const char *statement, unsigned long offset, unsigned long limit, - unsigned int *column_count, Cell **columns, - unsigned long *row_count, Cell ***rows) =0; - /// log error message - //static void log(Pool& pool, const char *fmt, ...); - -protected: - - Services_for_SQL_driver *services; -}; - -typedef SQL_Driver *(*SQL_Driver_create_func)(); - -#endif +/** @file + Parser: sql driver interface. + + Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) + Author: Alexander Petrosyan (http://paf.design.ru) + + $Id: pa_sql_driver.h,v 1.21 2001/11/11 10:52:50 paf Exp $ + + + driver dynamic library must look like this: + @code + class X_SQL_Driver : public SQL_Driver { + public: + + X_SQL_Driver() : SQL_driver() {} + + int api_version() { return SQL_DRIVER_API_VERSION; } + + //... + }; + + extern "C" SQL_Driver *create() { + return new X_SQL_Driver(); + } + @endcode +*/ + +#ifndef PA_SQL_DRIVER_H +#define PA_SQL_DRIVER_H + +#include + +/// service functions for SQL driver to use +class SQL_Driver_services { +public: + /// allocates some bytes on pool + virtual void *malloc(size_t size) =0; + /// allocates some bytes clearing them with zeros + virtual void *calloc(size_t size) =0; + /// prepare throw exception + virtual void _throw(const char *comment) =0; + /// throw C++ exception from prepared + virtual void propagate_exception() =0; +public: + /// regretrully public, because can't make stack frames: "nowhere to return to" + jmp_buf mark; +}; + +#define SQL_DRIVER_API_VERSION 0x0002 +#define SQL_DRIVER_CREATE create +#define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */ + +/// events, occuring when SQL_Driver::query()-ing +class SQL_Driver_query_event_handlers { +public: + virtual void add_column(void *ptr, size_t size) =0; + virtual void before_rows() =0; + virtual void add_row() =0; + virtual void add_row_cell(void *ptr, size_t size) =0; +}; + +/// SQL driver API +class SQL_Driver { +public: + + SQL_Driver() {} + /// get api version + virtual int api_version() =0; + /// initialize driver by loading sql dynamic link library + virtual const char *initialize(char *dlopen_file_spec) =0; + /** connect to sql database using + @param used_only_to_connect_url + format is driver specific + WARNING: must be used only to connect, for buffer doesn't live long enough + + @returns true+'connection' on success. 'error' on failure + */ + virtual void connect(char *used_only_in_connect_url_cstr, + SQL_Driver_services& services, void **connection) =0; + virtual void disconnect(void *connection) =0; + virtual void commit( + SQL_Driver_services& services, void *connection) =0; + virtual void rollback( + SQL_Driver_services& services, void *connection) =0; + /// @returns true to indicate that connection still alive + virtual bool ping( + SQL_Driver_services& services, void *connection) =0; + /// encodes the string in 'from' to an escaped SQL string + virtual unsigned int quote( + SQL_Driver_services& services, void *connection, + char *to, const char *from, unsigned int length) =0; + virtual void query( + SQL_Driver_services& services, void *connection, + const char *statement, unsigned long offset, unsigned long limit, + SQL_Driver_query_event_handlers& handlers) =0; +}; + +typedef SQL_Driver *(*SQL_Driver_create_func)(); + +#endif