blob: 85925f4b453fc73b57a6709f71abd5165cc505a2 [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001:mod:`sqlite3` --- DB-API 2.0 interface for SQLite databases
2============================================================
3
4.. module:: sqlite3
5 :synopsis: A DB-API 2.0 implementation using SQLite 3.x.
6.. sectionauthor:: Gerhard Häring <gh@ghaering.de>
7
8
9.. versionadded:: 2.5
10
11SQLite is a C library that provides a lightweight disk-based database that
12doesn't require a separate server process and allows accessing the database
13using a nonstandard variant of the SQL query language. Some applications can use
14SQLite for internal data storage. It's also possible to prototype an
15application using SQLite and then port the code to a larger database such as
16PostgreSQL or Oracle.
17
18pysqlite was written by Gerhard Häring and provides a SQL interface compliant
19with the DB-API 2.0 specification described by :pep:`249`.
20
21To use the module, you must first create a :class:`Connection` object that
22represents the database. Here the data will be stored in the
23:file:`/tmp/example` file::
24
25 conn = sqlite3.connect('/tmp/example')
26
27You can also supply the special name ``:memory:`` to create a database in RAM.
28
29Once you have a :class:`Connection`, you can create a :class:`Cursor` object
30and call its :meth:`execute` method to perform SQL commands::
31
32 c = conn.cursor()
33
34 # Create table
35 c.execute('''create table stocks
36 (date text, trans text, symbol text,
37 qty real, price real)''')
38
39 # Insert a row of data
40 c.execute("""insert into stocks
41 values ('2006-01-05','BUY','RHAT',100,35.14)""")
42
43 # Save (commit) the changes
44 conn.commit()
45
46 # We can also close the cursor if we are done with it
47 c.close()
48
49Usually your SQL operations will need to use values from Python variables. You
50shouldn't assemble your query using Python's string operations because doing so
51is insecure; it makes your program vulnerable to an SQL injection attack.
52
53Instead, use the DB-API's parameter substitution. Put ``?`` as a placeholder
54wherever you want to use a value, and then provide a tuple of values as the
55second argument to the cursor's :meth:`execute` method. (Other database modules
56may use a different placeholder, such as ``%s`` or ``:1``.) For example::
57
58 # Never do this -- insecure!
59 symbol = 'IBM'
60 c.execute("... where symbol = '%s'" % symbol)
61
62 # Do this instead
63 t = (symbol,)
64 c.execute('select * from stocks where symbol=?', t)
65
66 # Larger example
67 for t in (('2006-03-28', 'BUY', 'IBM', 1000, 45.00),
68 ('2006-04-05', 'BUY', 'MSOFT', 1000, 72.00),
69 ('2006-04-06', 'SELL', 'IBM', 500, 53.00),
70 ):
71 c.execute('insert into stocks values (?,?,?,?,?)', t)
72
Georg Brandle7a09902007-10-21 12:10:28 +000073To retrieve data after executing a SELECT statement, you can either treat the
74cursor as an :term:`iterator`, call the cursor's :meth:`fetchone` method to
75retrieve a single matching row, or call :meth:`fetchall` to get a list of the
76matching rows.
Georg Brandl8ec7f652007-08-15 14:28:01 +000077
78This example uses the iterator form::
79
80 >>> c = conn.cursor()
81 >>> c.execute('select * from stocks order by price')
82 >>> for row in c:
83 ... print row
84 ...
85 (u'2006-01-05', u'BUY', u'RHAT', 100, 35.140000000000001)
86 (u'2006-03-28', u'BUY', u'IBM', 1000, 45.0)
87 (u'2006-04-06', u'SELL', u'IBM', 500, 53.0)
88 (u'2006-04-05', u'BUY', u'MSOFT', 1000, 72.0)
89 >>>
90
91
92.. seealso::
93
94 http://www.pysqlite.org
95 The pysqlite web page.
96
97 http://www.sqlite.org
98 The SQLite web page; the documentation describes the syntax and the available
99 data types for the supported SQL dialect.
100
101 :pep:`249` - Database API Specification 2.0
102 PEP written by Marc-André Lemburg.
103
104
105.. _sqlite3-module-contents:
106
107Module functions and constants
108------------------------------
109
110
111.. data:: PARSE_DECLTYPES
112
113 This constant is meant to be used with the *detect_types* parameter of the
114 :func:`connect` function.
115
116 Setting it makes the :mod:`sqlite3` module parse the declared type for each
117 column it returns. It will parse out the first word of the declared type, i. e.
118 for "integer primary key", it will parse out "integer". Then for that column, it
119 will look into the converters dictionary and use the converter function
120 registered for that type there. Converter names are case-sensitive!
121
122
123.. data:: PARSE_COLNAMES
124
125 This constant is meant to be used with the *detect_types* parameter of the
126 :func:`connect` function.
127
128 Setting this makes the SQLite interface parse the column name for each column it
129 returns. It will look for a string formed [mytype] in there, and then decide
130 that 'mytype' is the type of the column. It will try to find an entry of
131 'mytype' in the converters dictionary and then use the converter function found
132 there to return the value. The column name found in :attr:`cursor.description`
133 is only the first word of the column name, i. e. if you use something like
134 ``'as "x [datetime]"'`` in your SQL, then we will parse out everything until the
135 first blank for the column name: the column name would simply be "x".
136
137
138.. function:: connect(database[, timeout, isolation_level, detect_types, factory])
139
140 Opens a connection to the SQLite database file *database*. You can use
141 ``":memory:"`` to open a database connection to a database that resides in RAM
142 instead of on disk.
143
144 When a database is accessed by multiple connections, and one of the processes
145 modifies the database, the SQLite database is locked until that transaction is
146 committed. The *timeout* parameter specifies how long the connection should wait
147 for the lock to go away until raising an exception. The default for the timeout
148 parameter is 5.0 (five seconds).
149
150 For the *isolation_level* parameter, please see the
151 :attr:`Connection.isolation_level` property of :class:`Connection` objects.
152
153 SQLite natively supports only the types TEXT, INTEGER, FLOAT, BLOB and NULL. If
154 you want to use other types you must add support for them yourself. The
155 *detect_types* parameter and the using custom **converters** registered with the
156 module-level :func:`register_converter` function allow you to easily do that.
157
158 *detect_types* defaults to 0 (i. e. off, no type detection), you can set it to
159 any combination of :const:`PARSE_DECLTYPES` and :const:`PARSE_COLNAMES` to turn
160 type detection on.
161
162 By default, the :mod:`sqlite3` module uses its :class:`Connection` class for the
163 connect call. You can, however, subclass the :class:`Connection` class and make
164 :func:`connect` use your class instead by providing your class for the *factory*
165 parameter.
166
167 Consult the section :ref:`sqlite3-types` of this manual for details.
168
169 The :mod:`sqlite3` module internally uses a statement cache to avoid SQL parsing
170 overhead. If you want to explicitly set the number of statements that are cached
171 for the connection, you can set the *cached_statements* parameter. The currently
172 implemented default is to cache 100 statements.
173
174
175.. function:: register_converter(typename, callable)
176
177 Registers a callable to convert a bytestring from the database into a custom
178 Python type. The callable will be invoked for all database values that are of
179 the type *typename*. Confer the parameter *detect_types* of the :func:`connect`
180 function for how the type detection works. Note that the case of *typename* and
181 the name of the type in your query must match!
182
183
184.. function:: register_adapter(type, callable)
185
186 Registers a callable to convert the custom Python type *type* into one of
187 SQLite's supported types. The callable *callable* accepts as single parameter
188 the Python value, and must return a value of the following types: int, long,
189 float, str (UTF-8 encoded), unicode or buffer.
190
191
192.. function:: complete_statement(sql)
193
194 Returns :const:`True` if the string *sql* contains one or more complete SQL
195 statements terminated by semicolons. It does not verify that the SQL is
196 syntactically correct, only that there are no unclosed string literals and the
197 statement is terminated by a semicolon.
198
199 This can be used to build a shell for SQLite, as in the following example:
200
201
202 .. literalinclude:: ../includes/sqlite3/complete_statement.py
203
204
205.. function:: enable_callback_tracebacks(flag)
206
207 By default you will not get any tracebacks in user-defined functions,
208 aggregates, converters, authorizer callbacks etc. If you want to debug them, you
209 can call this function with *flag* as True. Afterwards, you will get tracebacks
210 from callbacks on ``sys.stderr``. Use :const:`False` to disable the feature
211 again.
212
213
214.. _sqlite3-connection-objects:
215
216Connection Objects
217------------------
218
219A :class:`Connection` instance has the following attributes and methods:
220
221.. attribute:: Connection.isolation_level
222
223 Get or set the current isolation level. None for autocommit mode or one of
224 "DEFERRED", "IMMEDIATE" or "EXLUSIVE". See section
225 :ref:`sqlite3-controlling-transactions` for a more detailed explanation.
226
227
228.. method:: Connection.cursor([cursorClass])
229
230 The cursor method accepts a single optional parameter *cursorClass*. If
231 supplied, this must be a custom cursor class that extends
232 :class:`sqlite3.Cursor`.
233
234
Gerhard Häring41309302008-03-29 01:27:37 +0000235.. method:: Connection.commit()
236
237 This method commits the current transaction. If you don't call this method,
238 anything you did since the last call to commit() is not visible from from
239 other database connections. If you wonder why you don't see the data you've
240 written to the database, please check you didn't forget to call this method.
241
242.. method:: Connection.rollback()
243
244 This method rolls back any changes to the database since the last call to
245 :meth:`commit`.
246
247.. method:: Connection.close()
248
249 This closes the database connection. Note that this does not automatically
250 call :meth:`commit`. If you just close your database connection without
251 calling :meth:`commit` first, your changes will be lost!
252
Georg Brandl8ec7f652007-08-15 14:28:01 +0000253.. method:: Connection.execute(sql, [parameters])
254
255 This is a nonstandard shortcut that creates an intermediate cursor object by
256 calling the cursor method, then calls the cursor's :meth:`execute` method with
257 the parameters given.
258
259
260.. method:: Connection.executemany(sql, [parameters])
261
262 This is a nonstandard shortcut that creates an intermediate cursor object by
263 calling the cursor method, then calls the cursor's :meth:`executemany` method
264 with the parameters given.
265
Georg Brandl8ec7f652007-08-15 14:28:01 +0000266.. method:: Connection.executescript(sql_script)
267
268 This is a nonstandard shortcut that creates an intermediate cursor object by
269 calling the cursor method, then calls the cursor's :meth:`executescript` method
270 with the parameters given.
271
272
273.. method:: Connection.create_function(name, num_params, func)
274
275 Creates a user-defined function that you can later use from within SQL
276 statements under the function name *name*. *num_params* is the number of
277 parameters the function accepts, and *func* is a Python callable that is called
278 as the SQL function.
279
280 The function can return any of the types supported by SQLite: unicode, str, int,
281 long, float, buffer and None.
282
283 Example:
284
285 .. literalinclude:: ../includes/sqlite3/md5func.py
286
287
288.. method:: Connection.create_aggregate(name, num_params, aggregate_class)
289
290 Creates a user-defined aggregate function.
291
292 The aggregate class must implement a ``step`` method, which accepts the number
293 of parameters *num_params*, and a ``finalize`` method which will return the
294 final result of the aggregate.
295
296 The ``finalize`` method can return any of the types supported by SQLite:
297 unicode, str, int, long, float, buffer and None.
298
299 Example:
300
301 .. literalinclude:: ../includes/sqlite3/mysumaggr.py
302
303
304.. method:: Connection.create_collation(name, callable)
305
306 Creates a collation with the specified *name* and *callable*. The callable will
307 be passed two string arguments. It should return -1 if the first is ordered
308 lower than the second, 0 if they are ordered equal and 1 if the first is ordered
309 higher than the second. Note that this controls sorting (ORDER BY in SQL) so
310 your comparisons don't affect other SQL operations.
311
312 Note that the callable will get its parameters as Python bytestrings, which will
313 normally be encoded in UTF-8.
314
315 The following example shows a custom collation that sorts "the wrong way":
316
317 .. literalinclude:: ../includes/sqlite3/collation_reverse.py
318
319 To remove a collation, call ``create_collation`` with None as callable::
320
321 con.create_collation("reverse", None)
322
323
324.. method:: Connection.interrupt()
325
326 You can call this method from a different thread to abort any queries that might
327 be executing on the connection. The query will then abort and the caller will
328 get an exception.
329
330
331.. method:: Connection.set_authorizer(authorizer_callback)
332
333 This routine registers a callback. The callback is invoked for each attempt to
334 access a column of a table in the database. The callback should return
335 :const:`SQLITE_OK` if access is allowed, :const:`SQLITE_DENY` if the entire SQL
336 statement should be aborted with an error and :const:`SQLITE_IGNORE` if the
337 column should be treated as a NULL value. These constants are available in the
338 :mod:`sqlite3` module.
339
340 The first argument to the callback signifies what kind of operation is to be
341 authorized. The second and third argument will be arguments or :const:`None`
342 depending on the first argument. The 4th argument is the name of the database
343 ("main", "temp", etc.) if applicable. The 5th argument is the name of the
344 inner-most trigger or view that is responsible for the access attempt or
345 :const:`None` if this access attempt is directly from input SQL code.
346
347 Please consult the SQLite documentation about the possible values for the first
348 argument and the meaning of the second and third argument depending on the first
349 one. All necessary constants are available in the :mod:`sqlite3` module.
350
351
Gerhard Häring41309302008-03-29 01:27:37 +0000352.. method:: Connection.set_progress_handler(handler, n)
353
354 .. versionadded:: 2.6
355
356 This routine registers a callback. The callback is invoked for every *n*
357 instructions of the SQLite virtual machine. This is useful if you want to
358 get called from SQLite during long-running operations, for example to update
359 a GUI.
360
361 If you want to clear any previously installed progress handler, call the
362 method with :const:`None` for *handler*.
363
364
Georg Brandl8ec7f652007-08-15 14:28:01 +0000365.. attribute:: Connection.row_factory
366
367 You can change this attribute to a callable that accepts the cursor and the
368 original row as a tuple and will return the real result row. This way, you can
369 implement more advanced ways of returning results, such as returning an object
370 that can also access columns by name.
371
372 Example:
373
374 .. literalinclude:: ../includes/sqlite3/row_factory.py
375
376 If returning a tuple doesn't suffice and you want name-based access to
377 columns, you should consider setting :attr:`row_factory` to the
378 highly-optimized :class:`sqlite3.Row` type. :class:`Row` provides both
379 index-based and case-insensitive name-based access to columns with almost no
380 memory overhead. It will probably be better than your own custom
381 dictionary-based approach or even a db_row based solution.
382
Georg Brandlb19be572007-12-29 10:57:00 +0000383 .. XXX what's a db_row-based solution?
Georg Brandl8ec7f652007-08-15 14:28:01 +0000384
385
386.. attribute:: Connection.text_factory
387
388 Using this attribute you can control what objects are returned for the TEXT data
389 type. By default, this attribute is set to :class:`unicode` and the
390 :mod:`sqlite3` module will return Unicode objects for TEXT. If you want to
391 return bytestrings instead, you can set it to :class:`str`.
392
393 For efficiency reasons, there's also a way to return Unicode objects only for
394 non-ASCII data, and bytestrings otherwise. To activate it, set this attribute to
395 :const:`sqlite3.OptimizedUnicode`.
396
397 You can also set it to any other callable that accepts a single bytestring
398 parameter and returns the resulting object.
399
400 See the following example code for illustration:
401
402 .. literalinclude:: ../includes/sqlite3/text_factory.py
403
404
405.. attribute:: Connection.total_changes
406
407 Returns the total number of database rows that have been modified, inserted, or
408 deleted since the database connection was opened.
409
410
Gregory P. Smithb9803422008-03-28 08:32:09 +0000411.. attribute:: Connection.iterdump
412
413 Returns an iterator to dump the database in an SQL text format. Useful when
414 saving an in-memory database for later restoration. This function provides
415 the same capabilities as the :kbd:`.dump` command in the :program:`sqlite3`
416 shell.
417
418 .. versionadded:: 2.6
419
420 Example::
421
422 # Convert file existing_db.db to SQL dump file dump.sql
423 import sqlite3, os
424
425 con = sqlite3.connect('existing_db.db')
426 full_dump = os.linesep.join([line for line in con.iterdump()])
427 f = open('dump.sql', 'w')
428 f.writelines(full_dump)
429 f.close()
430
431
Georg Brandl8ec7f652007-08-15 14:28:01 +0000432.. _sqlite3-cursor-objects:
433
434Cursor Objects
435--------------
436
437A :class:`Cursor` instance has the following attributes and methods:
438
439
440.. method:: Cursor.execute(sql, [parameters])
441
Georg Brandlf558d2e2008-01-19 20:53:07 +0000442 Executes an SQL statement. The SQL statement may be parametrized (i. e.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000443 placeholders instead of SQL literals). The :mod:`sqlite3` module supports two
444 kinds of placeholders: question marks (qmark style) and named placeholders
445 (named style).
446
447 This example shows how to use parameters with qmark style:
448
449 .. literalinclude:: ../includes/sqlite3/execute_1.py
450
451 This example shows how to use the named style:
452
453 .. literalinclude:: ../includes/sqlite3/execute_2.py
454
455 :meth:`execute` will only execute a single SQL statement. If you try to execute
456 more than one statement with it, it will raise a Warning. Use
457 :meth:`executescript` if you want to execute multiple SQL statements with one
458 call.
459
460
461.. method:: Cursor.executemany(sql, seq_of_parameters)
462
Georg Brandlf558d2e2008-01-19 20:53:07 +0000463 Executes an SQL command against all parameter sequences or mappings found in
Georg Brandle7a09902007-10-21 12:10:28 +0000464 the sequence *sql*. The :mod:`sqlite3` module also allows using an
465 :term:`iterator` yielding parameters instead of a sequence.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000466
467 .. literalinclude:: ../includes/sqlite3/executemany_1.py
468
Georg Brandlcf3fb252007-10-21 10:52:38 +0000469 Here's a shorter example using a :term:`generator`:
Georg Brandl8ec7f652007-08-15 14:28:01 +0000470
471 .. literalinclude:: ../includes/sqlite3/executemany_2.py
472
473
474.. method:: Cursor.executescript(sql_script)
475
476 This is a nonstandard convenience method for executing multiple SQL statements
477 at once. It issues a COMMIT statement first, then executes the SQL script it
478 gets as a parameter.
479
480 *sql_script* can be a bytestring or a Unicode string.
481
482 Example:
483
484 .. literalinclude:: ../includes/sqlite3/executescript.py
485
486
Georg Brandlf558d2e2008-01-19 20:53:07 +0000487.. method:: Cursor.fetchone()
488
489 Fetches the next row of a query result set, returning a single sequence,
490 or ``None`` when no more data is available.
491
492
493.. method:: Cursor.fetchmany([size=cursor.arraysize])
494
495 Fetches the next set of rows of a query result, returning a list. An empty
496 list is returned when no more rows are available.
497
498 The number of rows to fetch per call is specified by the *size* parameter.
499 If it is not given, the cursor's arraysize determines the number of rows
500 to be fetched. The method should try to fetch as many rows as indicated by
501 the size parameter. If this is not possible due to the specified number of
502 rows not being available, fewer rows may be returned.
503
504 Note there are performance considerations involved with the *size* parameter.
505 For optimal performance, it is usually best to use the arraysize attribute.
506 If the *size* parameter is used, then it is best for it to retain the same
507 value from one :meth:`fetchmany` call to the next.
508
509.. method:: Cursor.fetchall()
510
511 Fetches all (remaining) rows of a query result, returning a list. Note that
512 the cursor's arraysize attribute can affect the performance of this operation.
513 An empty list is returned when no rows are available.
514
515
Georg Brandl8ec7f652007-08-15 14:28:01 +0000516.. attribute:: Cursor.rowcount
517
518 Although the :class:`Cursor` class of the :mod:`sqlite3` module implements this
519 attribute, the database engine's own support for the determination of "rows
520 affected"/"rows selected" is quirky.
521
Georg Brandl8ec7f652007-08-15 14:28:01 +0000522 For ``DELETE`` statements, SQLite reports :attr:`rowcount` as 0 if you make a
523 ``DELETE FROM table`` without any condition.
524
525 For :meth:`executemany` statements, the number of modifications are summed up
526 into :attr:`rowcount`.
527
528 As required by the Python DB API Spec, the :attr:`rowcount` attribute "is -1 in
529 case no executeXX() has been performed on the cursor or the rowcount of the last
530 operation is not determinable by the interface".
531
Georg Brandl891f1d32007-08-23 20:40:01 +0000532 This includes ``SELECT`` statements because we cannot determine the number of
533 rows a query produced until all rows were fetched.
534
Gerhard Häringc15317e2008-03-29 19:11:52 +0000535.. attribute:: Cursor.lastrowid
536
537 This read-only attribute provides the rowid of the last modified row. It is
538 only set if you issued a ``INSERT`` statement using the :meth:`execute`
539 method. For operations other than ``INSERT`` or when :meth:`executemany` is
540 called, :attr:`lastrowid` is set to :const:`None`.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000541
542.. _sqlite3-types:
543
544SQLite and Python types
545-----------------------
546
547
548Introduction
549^^^^^^^^^^^^
550
551SQLite natively supports the following types: NULL, INTEGER, REAL, TEXT, BLOB.
552
553The following Python types can thus be sent to SQLite without any problem:
554
555+------------------------+-------------+
556| Python type | SQLite type |
557+========================+=============+
558| ``None`` | NULL |
559+------------------------+-------------+
560| ``int`` | INTEGER |
561+------------------------+-------------+
562| ``long`` | INTEGER |
563+------------------------+-------------+
564| ``float`` | REAL |
565+------------------------+-------------+
566| ``str (UTF8-encoded)`` | TEXT |
567+------------------------+-------------+
568| ``unicode`` | TEXT |
569+------------------------+-------------+
570| ``buffer`` | BLOB |
571+------------------------+-------------+
572
573This is how SQLite types are converted to Python types by default:
574
575+-------------+---------------------------------------------+
576| SQLite type | Python type |
577+=============+=============================================+
578| ``NULL`` | None |
579+-------------+---------------------------------------------+
580| ``INTEGER`` | int or long, depending on size |
581+-------------+---------------------------------------------+
582| ``REAL`` | float |
583+-------------+---------------------------------------------+
584| ``TEXT`` | depends on text_factory, unicode by default |
585+-------------+---------------------------------------------+
586| ``BLOB`` | buffer |
587+-------------+---------------------------------------------+
588
589The type system of the :mod:`sqlite3` module is extensible in two ways: you can
590store additional Python types in a SQLite database via object adaptation, and
591you can let the :mod:`sqlite3` module convert SQLite types to different Python
592types via converters.
593
594
595Using adapters to store additional Python types in SQLite databases
596^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
597
598As described before, SQLite supports only a limited set of types natively. To
599use other Python types with SQLite, you must **adapt** them to one of the
600sqlite3 module's supported types for SQLite: one of NoneType, int, long, float,
601str, unicode, buffer.
602
603The :mod:`sqlite3` module uses Python object adaptation, as described in
604:pep:`246` for this. The protocol to use is :class:`PrepareProtocol`.
605
606There are two ways to enable the :mod:`sqlite3` module to adapt a custom Python
607type to one of the supported ones.
608
609
610Letting your object adapt itself
611""""""""""""""""""""""""""""""""
612
613This is a good approach if you write the class yourself. Let's suppose you have
614a class like this::
615
616 class Point(object):
617 def __init__(self, x, y):
618 self.x, self.y = x, y
619
620Now you want to store the point in a single SQLite column. First you'll have to
621choose one of the supported types first to be used for representing the point.
622Let's just use str and separate the coordinates using a semicolon. Then you need
623to give your class a method ``__conform__(self, protocol)`` which must return
624the converted value. The parameter *protocol* will be :class:`PrepareProtocol`.
625
626.. literalinclude:: ../includes/sqlite3/adapter_point_1.py
627
628
629Registering an adapter callable
630"""""""""""""""""""""""""""""""
631
632The other possibility is to create a function that converts the type to the
633string representation and register the function with :meth:`register_adapter`.
634
635.. note::
636
Georg Brandla7395032007-10-21 12:15:05 +0000637 The type/class to adapt must be a :term:`new-style class`, i. e. it must have
Georg Brandl8ec7f652007-08-15 14:28:01 +0000638 :class:`object` as one of its bases.
639
640.. literalinclude:: ../includes/sqlite3/adapter_point_2.py
641
642The :mod:`sqlite3` module has two default adapters for Python's built-in
643:class:`datetime.date` and :class:`datetime.datetime` types. Now let's suppose
644we want to store :class:`datetime.datetime` objects not in ISO representation,
645but as a Unix timestamp.
646
647.. literalinclude:: ../includes/sqlite3/adapter_datetime.py
648
649
650Converting SQLite values to custom Python types
651^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
652
653Writing an adapter lets you send custom Python types to SQLite. But to make it
654really useful we need to make the Python to SQLite to Python roundtrip work.
655
656Enter converters.
657
658Let's go back to the :class:`Point` class. We stored the x and y coordinates
659separated via semicolons as strings in SQLite.
660
661First, we'll define a converter function that accepts the string as a parameter
662and constructs a :class:`Point` object from it.
663
664.. note::
665
666 Converter functions **always** get called with a string, no matter under which
667 data type you sent the value to SQLite.
668
669.. note::
670
671 Converter names are looked up in a case-sensitive manner.
672
673::
674
675 def convert_point(s):
676 x, y = map(float, s.split(";"))
677 return Point(x, y)
678
679Now you need to make the :mod:`sqlite3` module know that what you select from
680the database is actually a point. There are two ways of doing this:
681
682* Implicitly via the declared type
683
684* Explicitly via the column name
685
686Both ways are described in section :ref:`sqlite3-module-contents`, in the entries
687for the constants :const:`PARSE_DECLTYPES` and :const:`PARSE_COLNAMES`.
688
689The following example illustrates both approaches.
690
691.. literalinclude:: ../includes/sqlite3/converter_point.py
692
693
694Default adapters and converters
695^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
696
697There are default adapters for the date and datetime types in the datetime
698module. They will be sent as ISO dates/ISO timestamps to SQLite.
699
700The default converters are registered under the name "date" for
701:class:`datetime.date` and under the name "timestamp" for
702:class:`datetime.datetime`.
703
704This way, you can use date/timestamps from Python without any additional
705fiddling in most cases. The format of the adapters is also compatible with the
706experimental SQLite date/time functions.
707
708The following example demonstrates this.
709
710.. literalinclude:: ../includes/sqlite3/pysqlite_datetime.py
711
712
713.. _sqlite3-controlling-transactions:
714
715Controlling Transactions
716------------------------
717
718By default, the :mod:`sqlite3` module opens transactions implicitly before a
719Data Modification Language (DML) statement (i.e. INSERT/UPDATE/DELETE/REPLACE),
720and commits transactions implicitly before a non-DML, non-query statement (i. e.
721anything other than SELECT/INSERT/UPDATE/DELETE/REPLACE).
722
723So if you are within a transaction and issue a command like ``CREATE TABLE
724...``, ``VACUUM``, ``PRAGMA``, the :mod:`sqlite3` module will commit implicitly
725before executing that command. There are two reasons for doing that. The first
726is that some of these commands don't work within transactions. The other reason
727is that pysqlite needs to keep track of the transaction state (if a transaction
728is active or not).
729
730You can control which kind of "BEGIN" statements pysqlite implicitly executes
731(or none at all) via the *isolation_level* parameter to the :func:`connect`
732call, or via the :attr:`isolation_level` property of connections.
733
734If you want **autocommit mode**, then set :attr:`isolation_level` to None.
735
736Otherwise leave it at its default, which will result in a plain "BEGIN"
737statement, or set it to one of SQLite's supported isolation levels: DEFERRED,
738IMMEDIATE or EXCLUSIVE.
739
Georg Brandl8ec7f652007-08-15 14:28:01 +0000740
741
742Using pysqlite efficiently
743--------------------------
744
745
746Using shortcut methods
747^^^^^^^^^^^^^^^^^^^^^^
748
749Using the nonstandard :meth:`execute`, :meth:`executemany` and
750:meth:`executescript` methods of the :class:`Connection` object, your code can
751be written more concisely because you don't have to create the (often
752superfluous) :class:`Cursor` objects explicitly. Instead, the :class:`Cursor`
753objects are created implicitly and these shortcut methods return the cursor
754objects. This way, you can execute a SELECT statement and iterate over it
755directly using only a single call on the :class:`Connection` object.
756
757.. literalinclude:: ../includes/sqlite3/shortcut_methods.py
758
759
760Accessing columns by name instead of by index
761^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
762
763One useful feature of the :mod:`sqlite3` module is the builtin
764:class:`sqlite3.Row` class designed to be used as a row factory.
765
766Rows wrapped with this class can be accessed both by index (like tuples) and
767case-insensitively by name:
768
769.. literalinclude:: ../includes/sqlite3/rowclass.py
770
Gerhard Häring41309302008-03-29 01:27:37 +0000771
772Using the connection as a context manager
773^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
774
775.. versionadded:: 2.6
776
777Connection objects can be used as context managers
778that automatically commit or rollback transactions. In the event of an
779exception, the transaction is rolled back; otherwise, the transaction is
780committed:
781
782.. literalinclude:: ../includes/sqlite3/ctx_manager.py