|
|
| version 1.36, 2003/11/20 16:34:27 | version 1.44, 2008/06/26 09:42:35 |
|---|---|
| Line 1 | Line 1 |
| /** @file | /** @file |
| Parser: sql driver interface. | Parser: sql driver interface. |
| Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) | Copyright (c) 2001-2005 ArtLebedev Group (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) |
| Line 31 static const char * const IDENT_SQL_DRIV | Line 31 static const char * const IDENT_SQL_DRIV |
| #include <sys/types.h> | #include <sys/types.h> |
| #include <setjmp.h> | #include <setjmp.h> |
| #include <stdlib.h> | #include <stdlib.h> |
| #include <limits.h> | |
| #define SQL_DRIVER_API_VERSION 0x0007 | /* |
| 1..8 not logged | |
| 9 introducing placeholders | |
| 10 limit fixed (default: SQL_NO_LIMIT [ULONG_MAX]), path to document_root added | |
| */ | |
| //#define SQL_DRIVER_API_VERSION 10 | |
| #define SQL_DRIVER_API_VERSION 9 | |
| #define SQL_DRIVER_CREATE create /* used in driver implementation */ | #define SQL_DRIVER_CREATE create /* used in driver implementation */ |
| #define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */ | #define SQL_DRIVER_CREATE_NAME "create" /* could not figure out how to # it :( */ |
| //#define SQL_NO_LIMIT ULONG_MAX | |
| #define SQL_NO_LIMIT 0 | |
| /// fields are freed elsewhere | /// fields are freed elsewhere |
| class SQL_Error { | class SQL_Error { |
| bool fdefined; | bool fdefined; |
| Line 75 public: | Line 85 public: |
| virtual void *malloc_atomic(size_t size) =0; | virtual void *malloc_atomic(size_t size) =0; |
| /// reallocates bytes | /// reallocates bytes |
| virtual void *realloc(void *ptr, size_t size) =0; | virtual void *realloc(void *ptr, size_t size) =0; |
| /// $request:charset | |
| virtual const char* request_charset() =0; | |
| /// $request:document-root | |
| virtual const char* request_document_root() =0; | |
| /// transcoder. | |
| /// WARNING: can store pointers to charset names to speedup name-to-instance resolving | |
| /// so do NOT pass pointers to local vars and change those vars after that | |
| virtual void transcode(const char* src, size_t src_length, | |
| const char*& dst, size_t& dst_length, | |
| const char* charset_from_name, | |
| const char* charset_to_name | |
| ) =0; | |
| /// prepare throw exception | /// prepare throw exception |
| virtual void _throw(const SQL_Error& e) =0; | virtual void _throw(const SQL_Error& e) =0; |
| /// throw C++ exception from prepared | /// throw C++ exception from prepared |
| Line 103 public: | Line 125 public: |
| class SQL_Driver { | class SQL_Driver { |
| public: | public: |
| /// @todo can be optimized to contain type information, | |
| /// to pass IN and OUT int/double NOT in string format | |
| struct Placeholder { | |
| const char* name; | |
| const char* value; | |
| bool is_null; | |
| bool were_updated; | |
| }; | |
| /** allocated using our allocator, | /** allocated using our allocator, |
| @todo never freed | @todo never freed |
| */ | */ |
| Line 118 public: | Line 149 public: |
| /// initialize driver by loading sql dynamic link library | /// initialize driver by loading sql dynamic link library |
| virtual const char* initialize(char *dlopen_file_spec) =0; | virtual const char* initialize(char *dlopen_file_spec) =0; |
| /** connect to sql database using | /** connect to sql database using |
| @param used_only_to_connect_url | @param url_cstr |
| format is driver specific | 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 | @returns true+'connection' on success. 'error' on failure |
| */ | */ |
| virtual void connect(char *used_only_in_connect_url_cstr, | virtual void connect(char *url_cstr, |
| SQL_Driver_services& services, void **connection) =0; | SQL_Driver_services& services, void **connection) =0; |
| virtual void disconnect(void *connection) =0; | virtual void disconnect(void *connection) =0; |
| virtual void commit( | virtual void commit(void *connection) =0; |
| SQL_Driver_services& services, void *connection) =0; | virtual void rollback(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( | virtual bool ping(void *connection) =0; |
| 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 const char* quote( | virtual const char* quote(void *connection, |
| SQL_Driver_services& services, void *connection, | |
| const char* str, unsigned int length) =0; | const char* str, unsigned int length) =0; |
| virtual void query( | virtual void query(void *connection, |
| SQL_Driver_services& services, void *connection, | const char* statement, |
| const char* statement, unsigned long offset, unsigned long limit, | size_t placeholders_count, Placeholder* placeholders, |
| unsigned long offset, unsigned long limit, | |
| SQL_Driver_query_event_handlers& handlers) =0; | SQL_Driver_query_event_handlers& handlers) =0; |
| }; | }; |