• 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 "module.h"
31 
32 #include "sqlite3.h"
33 
34 typedef struct _callback_context
35 {
36     PyObject *callable;
37     PyObject *module;
38     pysqlite_state *state;
39 } callback_context;
40 
41 enum autocommit_mode {
42     AUTOCOMMIT_LEGACY = LEGACY_TRANSACTION_CONTROL,
43     AUTOCOMMIT_ENABLED = 1,
44     AUTOCOMMIT_DISABLED = 0,
45 };
46 
47 typedef struct
48 {
49     PyObject_HEAD
50     sqlite3 *db;
51     pysqlite_state *state;
52 
53     /* the type detection mode. Only 0, PARSE_DECLTYPES, PARSE_COLNAMES or a
54      * bitwise combination thereof makes sense */
55     int detect_types;
56 
57     /* NULL for autocommit, otherwise a string with the isolation level */
58     const char *isolation_level;
59     enum autocommit_mode autocommit;
60 
61     /* 1 if a check should be performed for each API call if the connection is
62      * used from the same thread it was created in */
63     int check_same_thread;
64 
65     int initialized;
66 
67     /* thread identification of the thread the connection was created in */
68     unsigned long thread_ident;
69 
70     PyObject *statement_cache;
71 
72     /* Lists of weak references to cursors and blobs used within this connection */
73     PyObject *cursors;
74     PyObject *blobs;
75 
76     /* Counters for how many cursors were created in the connection. May be
77      * reset to 0 at certain intervals */
78     int created_cursors;
79 
80     PyObject* row_factory;
81 
82     /* Determines how bytestrings from SQLite are converted to Python objects:
83      * - PyUnicode_Type:        Python Unicode objects are constructed from UTF-8 bytestrings
84      * - PyBytes_Type:          The bytestrings are returned as-is.
85      * - Any custom callable:   Any object returned from the callable called with the bytestring
86      *                          as single parameter.
87      */
88     PyObject* text_factory;
89 
90     // Remember contexts used by the trace, progress, and authoriser callbacks
91     callback_context *trace_ctx;
92     callback_context *progress_ctx;
93     callback_context *authorizer_ctx;
94 
95     /* Exception objects: borrowed refs. */
96     PyObject* Warning;
97     PyObject* Error;
98     PyObject* InterfaceError;
99     PyObject* DatabaseError;
100     PyObject* DataError;
101     PyObject* OperationalError;
102     PyObject* IntegrityError;
103     PyObject* InternalError;
104     PyObject* ProgrammingError;
105     PyObject* NotSupportedError;
106 } pysqlite_Connection;
107 
108 int pysqlite_check_thread(pysqlite_Connection* self);
109 int pysqlite_check_connection(pysqlite_Connection* con);
110 
111 int pysqlite_connection_setup_types(PyObject *module);
112 
113 #endif
114