1 /* connection.h - definitions for the connection type
2  *
3  * Copyright (C) 2004-2015 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     /* the type detection mode. Only 0, PARSE_DECLTYPES, PARSE_COLNAMES or a
41      * bitwise combination thereof makes sense */
42     int detect_types;
43 
44     /* the timeout value in seconds for database locks */
45     double timeout;
46 
47     /* for internal use in the timeout handler: when did the timeout handler
48      * first get called with count=0? */
49     double timeout_started;
50 
51     /* None for autocommit, otherwise a PyString with the isolation level */
52     PyObject* isolation_level;
53 
54     /* NULL for autocommit, otherwise a string with the BEGIN statement; will be
55      * freed in connection destructor */
56     char* begin_statement;
57 
58     /* 1 if a check should be performed for each API call if the connection is
59      * used from the same thread it was created in */
60     int check_same_thread;
61 
62     int initialized;
63 
64     /* thread identification of the thread the connection was created in */
65     long thread_ident;
66 
67     pysqlite_Cache* statement_cache;
68 
69     /* Lists of weak references to statements and cursors used within this connection */
70     PyObject* statements;
71     PyObject* cursors;
72 
73     /* Counters for how many statements/cursors were created in the connection. May be
74      * reset to 0 at certain intervals */
75     int created_statements;
76     int created_cursors;
77 
78     PyObject* row_factory;
79 
80     /* Determines how bytestrings from SQLite are converted to Python objects:
81      * - PyUnicode_Type:        Python Unicode objects are constructed from UTF-8 bytestrings
82      * - OptimizedUnicode:      Like before, but for ASCII data, only PyStrings are created.
83      * - PyString_Type:         PyStrings are created as-is.
84      * - Any custom callable:   Any object returned from the callable called with the bytestring
85      *                          as single parameter.
86      */
87     PyObject* text_factory;
88 
89     /* remember references to functions/classes used in
90      * create_function/create/aggregate, use these as dictionary keys, so we
91      * can keep the total system refcount constant by clearing that dictionary
92      * in connection_dealloc */
93     PyObject* function_pinboard;
94 
95     /* a dictionary of registered collation name => collation callable mappings */
96     PyObject* collations;
97 
98     /* Exception objects */
99     PyObject* Warning;
100     PyObject* Error;
101     PyObject* InterfaceError;
102     PyObject* DatabaseError;
103     PyObject* DataError;
104     PyObject* OperationalError;
105     PyObject* IntegrityError;
106     PyObject* InternalError;
107     PyObject* ProgrammingError;
108     PyObject* NotSupportedError;
109 } pysqlite_Connection;
110 
111 extern PyTypeObject pysqlite_ConnectionType;
112 
113 PyObject* pysqlite_connection_alloc(PyTypeObject* type, int aware);
114 void pysqlite_connection_dealloc(pysqlite_Connection* self);
115 PyObject* pysqlite_connection_cursor(pysqlite_Connection* self, PyObject* args, PyObject* kwargs);
116 PyObject* pysqlite_connection_close(pysqlite_Connection* self, PyObject* args);
117 PyObject* _pysqlite_connection_begin(pysqlite_Connection* self);
118 PyObject* pysqlite_connection_commit(pysqlite_Connection* self, PyObject* args);
119 PyObject* pysqlite_connection_rollback(pysqlite_Connection* self, PyObject* args);
120 PyObject* pysqlite_connection_new(PyTypeObject* type, PyObject* args, PyObject* kw);
121 int pysqlite_connection_init(pysqlite_Connection* self, PyObject* args, PyObject* kwargs);
122 
123 int pysqlite_connection_register_cursor(pysqlite_Connection* connection, PyObject* cursor);
124 int pysqlite_check_thread(pysqlite_Connection* self);
125 int pysqlite_check_connection(pysqlite_Connection* con);
126 
127 int pysqlite_connection_setup_types(void);
128 
129 #endif
130