Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1 | /* connection.h - definitions for the connection type |
| 2 | * |
Florent Xicluna | c934f32 | 2010-09-03 23:47:32 +0000 | [diff] [blame] | 3 | * Copyright (C) 2004-2010 Gerhard Häring <gh@ghaering.de> |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 4 | * |
| 5 | * This file is part of pysqlite. |
| 6 | * |
| 7 | * This software is provided 'as-is', without any express or implied |
| 8 | * warranty. In no event will the authors be held liable for any damages |
| 9 | * arising from the use of this software. |
| 10 | * |
| 11 | * Permission is granted to anyone to use this software for any purpose, |
| 12 | * including commercial applications, and to alter it and redistribute it |
| 13 | * freely, subject to the following restrictions: |
| 14 | * |
| 15 | * 1. The origin of this software must not be misrepresented; you must not |
| 16 | * claim that you wrote the original software. If you use this software |
| 17 | * in a product, an acknowledgment in the product documentation would be |
| 18 | * appreciated but is not required. |
| 19 | * 2. Altered source versions must be plainly marked as such, and must not be |
| 20 | * misrepresented as being the original software. |
| 21 | * 3. This notice may not be removed or altered from any source distribution. |
| 22 | */ |
| 23 | |
| 24 | #ifndef PYSQLITE_CONNECTION_H |
| 25 | #define PYSQLITE_CONNECTION_H |
| 26 | #include "Python.h" |
| 27 | #include "pythread.h" |
| 28 | #include "structmember.h" |
| 29 | |
| 30 | #include "cache.h" |
| 31 | #include "module.h" |
| 32 | |
| 33 | #include "sqlite3.h" |
| 34 | |
| 35 | typedef struct |
| 36 | { |
| 37 | PyObject_HEAD |
| 38 | sqlite3* db; |
| 39 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 40 | /* 1 if we are currently within a transaction, i. e. if a BEGIN has been |
| 41 | * issued */ |
Martin v. Löwis | a2e7d9b | 2010-10-17 19:48:29 +0000 | [diff] [blame] | 42 | char inTransaction; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 43 | |
| 44 | /* the type detection mode. Only 0, PARSE_DECLTYPES, PARSE_COLNAMES or a |
| 45 | * bitwise combination thereof makes sense */ |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 46 | int detect_types; |
| 47 | |
| 48 | /* the timeout value in seconds for database locks */ |
| 49 | double timeout; |
| 50 | |
| 51 | /* for internal use in the timeout handler: when did the timeout handler |
| 52 | * first get called with count=0? */ |
| 53 | double timeout_started; |
| 54 | |
| 55 | /* None for autocommit, otherwise a PyString with the isolation level */ |
| 56 | PyObject* isolation_level; |
| 57 | |
Ezio Melotti | 1392500 | 2011-03-16 11:05:33 +0200 | [diff] [blame] | 58 | /* NULL for autocommit, otherwise a string with the BEGIN statement; will be |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 59 | * freed in connection destructor */ |
| 60 | char* begin_statement; |
| 61 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 62 | /* 1 if a check should be performed for each API call if the connection is |
| 63 | * used from the same thread it was created in */ |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 64 | int check_same_thread; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 65 | |
Gerhard Häring | f9cee22 | 2010-03-05 15:20:03 +0000 | [diff] [blame] | 66 | int initialized; |
| 67 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 68 | /* thread identification of the thread the connection was created in */ |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 69 | long thread_ident; |
| 70 | |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 71 | pysqlite_Cache* statement_cache; |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 72 | |
Gerhard Häring | f9cee22 | 2010-03-05 15:20:03 +0000 | [diff] [blame] | 73 | /* Lists of weak references to statements and cursors used within this connection */ |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 74 | PyObject* statements; |
Gerhard Häring | f9cee22 | 2010-03-05 15:20:03 +0000 | [diff] [blame] | 75 | PyObject* cursors; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 76 | |
Gerhard Häring | f9cee22 | 2010-03-05 15:20:03 +0000 | [diff] [blame] | 77 | /* Counters for how many statements/cursors were created in the connection. May be |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 78 | * reset to 0 at certain intervals */ |
| 79 | int created_statements; |
Gerhard Häring | f9cee22 | 2010-03-05 15:20:03 +0000 | [diff] [blame] | 80 | int created_cursors; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 81 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 82 | PyObject* row_factory; |
| 83 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 84 | /* Determines how bytestrings from SQLite are converted to Python objects: |
| 85 | * - PyUnicode_Type: Python Unicode objects are constructed from UTF-8 bytestrings |
| 86 | * - OptimizedUnicode: Like before, but for ASCII data, only PyStrings are created. |
Christian Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 87 | * - PyBytes_Type: PyStrings are created as-is. |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 88 | * - Any custom callable: Any object returned from the callable called with the bytestring |
| 89 | * as single parameter. |
| 90 | */ |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 91 | PyObject* text_factory; |
| 92 | |
| 93 | /* remember references to functions/classes used in |
| 94 | * create_function/create/aggregate, use these as dictionary keys, so we |
| 95 | * can keep the total system refcount constant by clearing that dictionary |
| 96 | * in connection_dealloc */ |
| 97 | PyObject* function_pinboard; |
| 98 | |
| 99 | /* a dictionary of registered collation name => collation callable mappings */ |
| 100 | PyObject* collations; |
| 101 | |
| 102 | /* Exception objects */ |
| 103 | PyObject* Warning; |
| 104 | PyObject* Error; |
| 105 | PyObject* InterfaceError; |
| 106 | PyObject* DatabaseError; |
| 107 | PyObject* DataError; |
| 108 | PyObject* OperationalError; |
| 109 | PyObject* IntegrityError; |
| 110 | PyObject* InternalError; |
| 111 | PyObject* ProgrammingError; |
| 112 | PyObject* NotSupportedError; |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 113 | } pysqlite_Connection; |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 114 | |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 115 | extern PyTypeObject pysqlite_ConnectionType; |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 116 | |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 117 | PyObject* pysqlite_connection_alloc(PyTypeObject* type, int aware); |
| 118 | void pysqlite_connection_dealloc(pysqlite_Connection* self); |
| 119 | PyObject* pysqlite_connection_cursor(pysqlite_Connection* self, PyObject* args, PyObject* kwargs); |
| 120 | PyObject* pysqlite_connection_close(pysqlite_Connection* self, PyObject* args); |
| 121 | PyObject* _pysqlite_connection_begin(pysqlite_Connection* self); |
| 122 | PyObject* pysqlite_connection_commit(pysqlite_Connection* self, PyObject* args); |
| 123 | PyObject* pysqlite_connection_rollback(pysqlite_Connection* self, PyObject* args); |
| 124 | PyObject* pysqlite_connection_new(PyTypeObject* type, PyObject* args, PyObject* kw); |
| 125 | int pysqlite_connection_init(pysqlite_Connection* self, PyObject* args, PyObject* kwargs); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 126 | |
Gerhard Häring | f9cee22 | 2010-03-05 15:20:03 +0000 | [diff] [blame] | 127 | int pysqlite_connection_register_cursor(pysqlite_Connection* connection, PyObject* cursor); |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 128 | int pysqlite_check_thread(pysqlite_Connection* self); |
| 129 | int pysqlite_check_connection(pysqlite_Connection* con); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 130 | |
Thomas Wouters | fc7bb8c | 2007-01-15 15:49:28 +0000 | [diff] [blame] | 131 | int pysqlite_connection_setup_types(void); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 132 | |
| 133 | #endif |