|
|
| version 1.6, 2001/04/17 19:00:46 | version 1.30, 2002/12/09 11:11:33 |
|---|---|
| Line 1 | Line 1 |
| /** @file | /** @file |
| Parser: sql driver interface. | Parser: sql driver interface. |
| Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) | Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | |
| Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf) | |
| $Id$ | |
| driver dynamic library must look like this: | driver dynamic library must look like this: |
| Line 29 | Line 26 |
| #ifndef PA_SQL_DRIVER_H | #ifndef PA_SQL_DRIVER_H |
| #define PA_SQL_DRIVER_H | #define PA_SQL_DRIVER_H |
| static const char* IDENT_SQL_DRIVER_H="$Date$"; | |
| #include <sys/types.h> | #include <sys/types.h> |
| #define SQL_DRIVER_API_VERSION 0x0004 | |
| #define SQL_DRIVER_CREATE create /* used in driver implementation */ | |
| #define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */ | |
| /// fields are freed elsewhere | |
| class SQL_Exception { | |
| friend class SQL_Driver_services_impl; | |
| bool fdefined; | |
| const char *ftype; | |
| const void *fproblem_source; | |
| const char *fcomment; | |
| public: | |
| SQL_Exception(): | |
| fdefined(false) {} | |
| SQL_Exception( | |
| const char *atype, | |
| const void *aproblem_source, | |
| const char *acomment): | |
| fdefined(true), | |
| ftype(atype), | |
| fproblem_source(aproblem_source), | |
| fcomment(acomment) {} | |
| SQL_Exception(const char *acomment): | |
| fdefined(true), | |
| ftype(0), | |
| fproblem_source(0), | |
| fcomment(acomment) {} | |
| /* | |
| SQL_Exception(const SQL_Exception& src) : | |
| fdefined(src.fdefined), | |
| ftype(src.ftype), | |
| fproblem_source(src.fproblem_source), | |
| fcomment(src.fcomment) {} | |
| */ | |
| const SQL_Exception& operator =(const SQL_Exception& src) { | |
| fdefined=src.fdefined; | |
| ftype=src.ftype; | |
| fproblem_source=src.fproblem_source; | |
| fcomment=src.fcomment; | |
| return *this; | |
| } | |
| bool defined() { return fdefined; } | |
| const char *type() { return ftype; } | |
| const void *problem_source() { return fproblem_source; } | |
| const char *comment() { return fcomment; } | |
| }; | |
| /// service functions for SQL driver to use | /// service functions for SQL driver to use |
| class Services_for_SQL_driver { | class SQL_Driver_services { |
| public: | public: |
| /// allocates some bytes on pool | /// allocates some bytes on pool |
| virtual void *malloc(size_t size) =0; | virtual void *malloc(size_t size) =0; |
| /// allocates some bytes clearing them with zeros | /// allocates some bytes clearing them with zeros |
| virtual void *calloc(size_t size) =0; | virtual void *calloc(size_t size) =0; |
| /// throw exception | /// prepare throw exception |
| virtual void _throw(const char *comment) =0; | virtual void _throw(const SQL_Exception& e) =0; |
| /// throw C++ exception from prepared | |
| virtual void propagate_exception() =0; | |
| /// helper func | |
| void _throw(const char *comment) { _throw(SQL_Exception(0, 0, comment)); } | |
| public: | |
| /// regretrully public, because can't make stack frames: "nowhere to return to" | |
| jmp_buf mark; | |
| }; | }; |
| #define SQL_DRIVER_API_VERSION 0x0301 | /// 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 | /// SQL driver API |
| class SQL_Driver { | class SQL_Driver { |
| public: | 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 | /// get api version |
| virtual int api_version() =0; | virtual int api_version() =0; |
| /// initialize driver by loading sql dynamic link library | /// initialize driver by loading sql dynamic link library |
| virtual const char *initialize(const char *dlopen_file_spec) =0; | virtual const char *initialize(char *dlopen_file_spec) =0; |
| /// connect. @returns true+'connection' on success. 'error' on failure | /** connect to sql database using |
| virtual void connect(char *url, void **connection) =0; | @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 disconnect(void *connection) =0; |
| virtual void commit(void *connection) =0; | virtual void commit( |
| virtual void rollback(void *connection) =0; | 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 | /// @returns true to indicate that connection still alive |
| virtual bool ping(void *connection) =0; | virtual bool ping( |
| SQL_Driver_services& services, void *connection) =0; | |
| /// encodes the string in 'from' to an escaped SQL string | /// encodes the string in 'from' to an escaped SQL string |
| virtual unsigned int quote(void *connection, | virtual unsigned int quote( |
| SQL_Driver_services& services, void *connection, | |
| char *to, const char *from, unsigned int length) =0; | char *to, const char *from, unsigned int length) =0; |
| virtual void query(void *connection, | virtual void query( |
| SQL_Driver_services& services, void *connection, | |
| const char *statement, unsigned long offset, unsigned long limit, | const char *statement, unsigned long offset, unsigned long limit, |
| unsigned int *column_count, Cell **columns, | SQL_Driver_query_event_handlers& handlers) =0; |
| 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)(); | typedef SQL_Driver *(*SQL_Driver_create_func)(); |