• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* connection.h - definitions for the connection type
2  *
3  * Copyright (C) 2004-2010 Gerhard H�ring <gh@ghaering.de>
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 
40     /* 1 if we are currently within a transaction, i. e. if a BEGIN has been
41      * issued */
42     int inTransaction;
43 
44     /* the type detection mode. Only 0, PARSE_DECLTYPES, PARSE_COLNAMES or a
45      * bitwise combination thereof makes sense */
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 
58     /* NULL for autocommit, otherwise a string with the BEGIN statement; will be
59      * freed in connection destructor */
60     char* begin_statement;
61 
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 */
64     int check_same_thread;
65 
66     int initialized;
67 
68     /* thread identification of the thread the connection was created in */
69     long thread_ident;
70 
71     pysqlite_Cache* statement_cache;
72 
73     /* Lists of weak references to statements and cursors used within this connection */
74     PyObject* statements;
75     PyObject* cursors;
76 
77     /* Counters for how many statements/cursors were created in the connection. May be
78      * reset to 0 at certain intervals */
79     int created_statements;
80     int created_cursors;
81 
82     PyObject* row_factory;
83 
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.
87      * - PyString_Type:         PyStrings are created as-is.
88      * - Any custom callable:   Any object returned from the callable called with the bytestring
89      *                          as single parameter.
90      */
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     /* if our connection was created from a APSW connection, we keep a
103      * reference to the APSW connection around and get rid of it in our
104      * destructor */
105     PyObject* apsw_connection;
106 
107     /* Exception objects */
108     PyObject* Warning;
109     PyObject* Error;
110     PyObject* InterfaceError;
111     PyObject* DatabaseError;
112     PyObject* DataError;
113     PyObject* OperationalError;
114     PyObject* IntegrityError;
115     PyObject* InternalError;
116     PyObject* ProgrammingError;
117     PyObject* NotSupportedError;
118 } pysqlite_Connection;
119 
120 extern PyTypeObject pysqlite_ConnectionType;
121 
122 PyObject* pysqlite_connection_alloc(PyTypeObject* type, int aware);
123 void pysqlite_connection_dealloc(pysqlite_Connection* self);
124 PyObject* pysqlite_connection_cursor(pysqlite_Connection* self, PyObject* args, PyObject* kwargs);
125 PyObject* pysqlite_connection_close(pysqlite_Connection* self, PyObject* args);
126 PyObject* _pysqlite_connection_begin(pysqlite_Connection* self);
127 PyObject* pysqlite_connection_commit(pysqlite_Connection* self, PyObject* args);
128 PyObject* pysqlite_connection_rollback(pysqlite_Connection* self, PyObject* args);
129 PyObject* pysqlite_connection_new(PyTypeObject* type, PyObject* args, PyObject* kw);
130 int pysqlite_connection_init(pysqlite_Connection* self, PyObject* args, PyObject* kwargs);
131 
132 int pysqlite_connection_register_cursor(pysqlite_Connection* connection, PyObject* cursor);
133 int pysqlite_check_thread(pysqlite_Connection* self);
134 int pysqlite_check_connection(pysqlite_Connection* con);
135 
136 int pysqlite_connection_setup_types(void);
137 
138 #endif
139