databases.txt 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727
  1. =========
  2. Databases
  3. =========
  4. Django attempts to support as many features as possible on all database
  5. backends. However, not all database backends are alike, and we've had to make
  6. design decisions on which features to support and which assumptions we can make
  7. safely.
  8. This file describes some of the features that might be relevant to Django
  9. usage. Of course, it is not intended as a replacement for server-specific
  10. documentation or reference manuals.
  11. .. _postgresql-notes:
  12. PostgreSQL notes
  13. ================
  14. .. versionchanged:: 1.4
  15. Django supports PostgreSQL 8.2 and higher.
  16. PostgreSQL 8.2 to 8.2.4
  17. -----------------------
  18. The implementation of the population statistics aggregates ``STDDEV_POP`` and
  19. ``VAR_POP`` that shipped with PostgreSQL 8.2 to 8.2.4 are `known to be
  20. faulty`_. Users of these releases of PostgreSQL are advised to upgrade to
  21. `Release 8.2.5`_ or later. Django will raise a ``NotImplementedError`` if you
  22. attempt to use the ``StdDev(sample=False)`` or ``Variance(sample=False)``
  23. aggregate with a database backend that falls within the affected release range.
  24. .. _known to be faulty: http://archives.postgresql.org/pgsql-bugs/2007-07/msg00046.php
  25. .. _Release 8.2.5: http://developer.postgresql.org/pgdocs/postgres/release-8-2-5.html
  26. Optimizing PostgreSQL's configuration
  27. -------------------------------------
  28. Django needs the following parameters for its database connections:
  29. - ``client_encoding``: ``'UTF8'``,
  30. - ``default_transaction_isolation``: ``'read committed'``,
  31. - ``timezone``: ``'UTC'`` when :setting:`USE_TZ` is ``True``, value of
  32. :setting:`TIME_ZONE` otherwise.
  33. If these parameters already have the correct values, Django won't set them for
  34. every new connection, which improves performance slightly. You can configure
  35. them directly in :file:`postgresql.conf` or more conveniently per database
  36. user with `ALTER ROLE`_.
  37. Django will work just fine without this optimization, but each new connection
  38. will do some additional queries to set these parameters.
  39. .. _ALTER ROLE: http://www.postgresql.org/docs/current/interactive/sql-alterrole.html
  40. Transaction handling
  41. ---------------------
  42. :doc:`By default </topics/db/transactions>`, Django starts a transaction when a
  43. database connection is first used and commits the result at the end of the
  44. request/response handling. The PostgreSQL backends normally operate the same
  45. as any other Django backend in this respect.
  46. .. _postgresql-autocommit-mode:
  47. Autocommit mode
  48. ~~~~~~~~~~~~~~~
  49. If your application is particularly read-heavy and doesn't make many
  50. database writes, the overhead of a constantly open transaction can
  51. sometimes be noticeable. For those situations, you can configure Django
  52. to use *"autocommit"* behavior for the connection, meaning that each database
  53. operation will normally be in its own transaction, rather than having
  54. the transaction extend over multiple operations. In this case, you can
  55. still manually start a transaction if you're doing something that
  56. requires consistency across multiple database operations. The
  57. autocommit behavior is enabled by setting the ``autocommit`` key in
  58. the :setting:`OPTIONS` part of your database configuration in
  59. :setting:`DATABASES`::
  60. 'OPTIONS': {
  61. 'autocommit': True,
  62. }
  63. In this configuration, Django still ensures that :ref:`delete()
  64. <topics-db-queries-delete>` and :ref:`update() <topics-db-queries-update>`
  65. queries run inside a single transaction, so that either all the affected
  66. objects are changed or none of them are.
  67. .. admonition:: This is database-level autocommit
  68. This functionality is not the same as the :ref:`autocommit
  69. <topics-db-transactions-autocommit>` decorator. That decorator is
  70. a Django-level implementation that commits automatically after
  71. data changing operations. The feature enabled using the
  72. :setting:`OPTIONS` option provides autocommit behavior at the
  73. database adapter level. It commits after *every* operation.
  74. If you are using this feature and performing an operation akin to delete or
  75. updating that requires multiple operations, you are strongly recommended to
  76. wrap you operations in manual transaction handling to ensure data consistency.
  77. You should also audit your existing code for any instances of this behavior
  78. before enabling this feature. It's faster, but it provides less automatic
  79. protection for multi-call operations.
  80. Indexes for ``varchar`` and ``text`` columns
  81. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  82. When specifying ``db_index=True`` on your model fields, Django typically
  83. outputs a single ``CREATE INDEX`` statement. However, if the database type
  84. for the field is either ``varchar`` or ``text`` (e.g., used by ``CharField``,
  85. ``FileField``, and ``TextField``), then Django will create
  86. an additional index that uses an appropriate `PostgreSQL operator class`_
  87. for the column. The extra index is necessary to correctly perfrom
  88. lookups that use the ``LIKE`` operator in their SQL, as is done with the
  89. ``contains`` and ``startswith`` lookup types.
  90. .. _PostgreSQL operator class: http://www.postgresql.org/docs/8.4/static/indexes-opclass.html
  91. .. _mysql-notes:
  92. MySQL notes
  93. ===========
  94. Version support
  95. ---------------
  96. Django supports MySQL 5.0.3 and higher.
  97. `MySQL 5.0`_ adds the ``information_schema`` database, which contains detailed
  98. data on all database schema. Django's ``inspectdb`` feature uses it.
  99. .. versionchanged:: 1.5
  100. The minimum version requirement of MySQL 5.0.3 was set in Django 1.5.
  101. Django expects the database to support Unicode (UTF-8 encoding) and delegates to
  102. it the task of enforcing transactions and referential integrity. It is important
  103. to be aware of the fact that the two latter ones aren't actually enforced by
  104. MySQL when using the MyISAM storage engine, see the next section.
  105. .. _MySQL: http://www.mysql.com/
  106. .. _MySQL 5.0: http://dev.mysql.com/doc/refman/5.0/en/index.html
  107. .. _mysql-storage-engines:
  108. Storage engines
  109. ---------------
  110. MySQL has several `storage engines`_ (previously called table types). You can
  111. change the default storage engine in the server configuration.
  112. Until MySQL 5.5.4, the default engine was MyISAM_ [#]_. The main drawbacks of
  113. MyISAM are that it doesn't support transactions or enforce foreign-key
  114. constraints. On the plus side, it's currently the only engine that supports
  115. full-text indexing and searching.
  116. Since MySQL 5.5.5, the default storage engine is InnoDB_. This engine is fully
  117. transactional and supports foreign key references. It's probably the best
  118. choice at this point.
  119. .. versionchanged:: 1.4
  120. In previous versions of Django, fixtures with forward references (i.e.
  121. relations to rows that have not yet been inserted into the database) would fail
  122. to load when using the InnoDB storage engine. This was due to the fact that InnoDB
  123. deviates from the SQL standard by checking foreign key constraints immediately
  124. instead of deferring the check until the transaction is committed. This
  125. problem has been resolved in Django 1.4. Fixture data is now loaded with foreign key
  126. checks turned off; foreign key checks are then re-enabled when the data has
  127. finished loading, at which point the entire table is checked for invalid foreign
  128. key references and an `IntegrityError` is raised if any are found.
  129. .. _storage engines: http://dev.mysql.com/doc/refman/5.5/en/storage-engines.html
  130. .. _MyISAM: http://dev.mysql.com/doc/refman/5.5/en/myisam-storage-engine.html
  131. .. _InnoDB: http://dev.mysql.com/doc/refman/5.5/en/innodb.html
  132. .. [#] Unless this was changed by the packager of your MySQL package. We've
  133. had reports that the Windows Community Server installer sets up InnoDB as
  134. the default storage engine, for example.
  135. MySQLdb
  136. -------
  137. `MySQLdb`_ is the Python interface to MySQL. Version 1.2.1p2 or later is
  138. required for full MySQL support in Django.
  139. .. note::
  140. If you see ``ImportError: cannot import name ImmutableSet`` when trying to
  141. use Django, your MySQLdb installation may contain an outdated ``sets.py``
  142. file that conflicts with the built-in module of the same name from Python
  143. 2.4 and later. To fix this, verify that you have installed MySQLdb version
  144. 1.2.1p2 or newer, then delete the ``sets.py`` file in the MySQLdb
  145. directory that was left by an earlier version.
  146. .. _MySQLdb: http://sourceforge.net/projects/mysql-python
  147. Creating your database
  148. ----------------------
  149. You can `create your database`_ using the command-line tools and this SQL::
  150. CREATE DATABASE <dbname> CHARACTER SET utf8;
  151. This ensures all tables and columns will use UTF-8 by default.
  152. .. _create your database: http://dev.mysql.com/doc/refman/5.0/en/create-database.html
  153. .. _mysql-collation:
  154. Collation settings
  155. ~~~~~~~~~~~~~~~~~~
  156. The collation setting for a column controls the order in which data is sorted
  157. as well as what strings compare as equal. It can be set on a database-wide
  158. level and also per-table and per-column. This is `documented thoroughly`_ in
  159. the MySQL documentation. In all cases, you set the collation by directly
  160. manipulating the database tables; Django doesn't provide a way to set this on
  161. the model definition.
  162. .. _documented thoroughly: http://dev.mysql.com/doc/refman/5.0/en/charset.html
  163. By default, with a UTF-8 database, MySQL will use the
  164. ``utf8_general_ci_swedish`` collation. This results in all string equality
  165. comparisons being done in a *case-insensitive* manner. That is, ``"Fred"`` and
  166. ``"freD"`` are considered equal at the database level. If you have a unique
  167. constraint on a field, it would be illegal to try to insert both ``"aa"`` and
  168. ``"AA"`` into the same column, since they compare as equal (and, hence,
  169. non-unique) with the default collation.
  170. In many cases, this default will not be a problem. However, if you really want
  171. case-sensitive comparisons on a particular column or table, you would change
  172. the column or table to use the ``utf8_bin`` collation. The main thing to be
  173. aware of in this case is that if you are using MySQLdb 1.2.2, the database
  174. backend in Django will then return bytestrings (instead of unicode strings) for
  175. any character fields it receive from the database. This is a strong variation
  176. from Django's normal practice of *always* returning unicode strings. It is up
  177. to you, the developer, to handle the fact that you will receive bytestrings if
  178. you configure your table(s) to use ``utf8_bin`` collation. Django itself should
  179. mostly work smoothly with such columns (except for the ``contrib.sessions``
  180. ``Session`` and ``contrib.admin`` ``LogEntry`` tables described below), but
  181. your code must be prepared to call ``django.utils.encoding.smart_unicode()`` at
  182. times if it really wants to work with consistent data -- Django will not do
  183. this for you (the database backend layer and the model population layer are
  184. separated internally so the database layer doesn't know it needs to make this
  185. conversion in this one particular case).
  186. If you're using MySQLdb 1.2.1p2, Django's standard
  187. :class:`~django.db.models.CharField` class will return unicode strings even
  188. with ``utf8_bin`` collation. However, :class:`~django.db.models.TextField`
  189. fields will be returned as an ``array.array`` instance (from Python's standard
  190. ``array`` module). There isn't a lot Django can do about that, since, again,
  191. the information needed to make the necessary conversions isn't available when
  192. the data is read in from the database. This problem was `fixed in MySQLdb
  193. 1.2.2`_, so if you want to use :class:`~django.db.models.TextField` with
  194. ``utf8_bin`` collation, upgrading to version 1.2.2 and then dealing with the
  195. bytestrings (which shouldn't be too difficult) as described above is the
  196. recommended solution.
  197. Should you decide to use ``utf8_bin`` collation for some of your tables with
  198. MySQLdb 1.2.1p2 or 1.2.2, you should still use ``utf8_collation_ci_swedish``
  199. (the default) collation for the :class:`django.contrib.sessions.models.Session`
  200. table (usually called ``django_session``) and the
  201. :class:`django.contrib.admin.models.LogEntry` table (usually called
  202. ``django_admin_log``). Those are the two standard tables that use
  203. :class:`~django.db.models.TextField` internally.
  204. .. _fixed in MySQLdb 1.2.2: http://sourceforge.net/tracker/index.php?func=detail&aid=1495765&group_id=22307&atid=374932
  205. Connecting to the database
  206. --------------------------
  207. Refer to the :doc:`settings documentation </ref/settings>`.
  208. Connection settings are used in this order:
  209. 1. :setting:`OPTIONS`.
  210. 2. :setting:`NAME`, :setting:`USER`, :setting:`PASSWORD`,
  211. :setting:`HOST`, :setting:`PORT`
  212. 3. MySQL option files.
  213. In other words, if you set the name of the database in :setting:`OPTIONS`,
  214. this will take precedence over :setting:`NAME`, which would override
  215. anything in a `MySQL option file`_.
  216. Here's a sample configuration which uses a MySQL option file::
  217. # settings.py
  218. DATABASES = {
  219. 'default': {
  220. 'ENGINE': 'django.db.backends.mysql',
  221. 'OPTIONS': {
  222. 'read_default_file': '/path/to/my.cnf',
  223. },
  224. }
  225. }
  226. # my.cnf
  227. [client]
  228. database = NAME
  229. user = USER
  230. password = PASSWORD
  231. default-character-set = utf8
  232. Several other MySQLdb connection options may be useful, such as ``ssl``,
  233. ``use_unicode``, ``init_command``, and ``sql_mode``. Consult the
  234. `MySQLdb documentation`_ for more details.
  235. .. _MySQL option file: http://dev.mysql.com/doc/refman/5.0/en/option-files.html
  236. .. _MySQLdb documentation: http://mysql-python.sourceforge.net/
  237. Creating your tables
  238. --------------------
  239. When Django generates the schema, it doesn't specify a storage engine, so
  240. tables will be created with whatever default storage engine your database
  241. server is configured for. The easiest solution is to set your database server's
  242. default storage engine to the desired engine.
  243. If you're using a hosting service and can't change your server's default
  244. storage engine, you have a couple of options.
  245. * After the tables are created, execute an ``ALTER TABLE`` statement to
  246. convert a table to a new storage engine (such as InnoDB)::
  247. ALTER TABLE <tablename> ENGINE=INNODB;
  248. This can be tedious if you have a lot of tables.
  249. * Another option is to use the ``init_command`` option for MySQLdb prior to
  250. creating your tables::
  251. 'OPTIONS': {
  252. 'init_command': 'SET storage_engine=INNODB',
  253. }
  254. This sets the default storage engine upon connecting to the database.
  255. After your tables have been created, you should remove this option.
  256. * Another method for changing the storage engine is described in
  257. AlterModelOnSyncDB_.
  258. .. _AlterModelOnSyncDB: https://code.djangoproject.com/wiki/AlterModelOnSyncDB
  259. Table names
  260. -----------
  261. There are `known issues`_ in even the latest versions of MySQL that can cause the
  262. case of a table name to be altered when certain SQL statements are executed
  263. under certain conditions. It is recommended that you use lowercase table
  264. names, if possible, to avoid any problems that might arise from this behavior.
  265. Django uses lowercase table names when it auto-generates table names from
  266. models, so this is mainly a consideration if you are overriding the table name
  267. via the :class:`~django.db.models.Options.db_table` parameter.
  268. .. _known issues: http://bugs.mysql.com/bug.php?id=48875
  269. Savepoints
  270. ----------
  271. Both the Django ORM and MySQL (when using the InnoDB :ref:`storage engine
  272. <mysql-storage-engines>`) support database :ref:`savepoints
  273. <topics-db-transactions-savepoints>`, but this feature wasn't available in
  274. Django until version 1.4 when such supports was added.
  275. If you use the MyISAM storage engine please be aware of the fact that you will
  276. receive database-generated errors if you try to use the :ref:`savepoint-related
  277. methods of the transactions API <topics-db-transactions-savepoints>`. The reason
  278. for this is that detecting the storage engine of a MySQL database/table is an
  279. expensive operation so it was decided it isn't worth to dynamically convert
  280. these methods in no-op's based in the results of such detection.
  281. Notes on specific fields
  282. ------------------------
  283. Character fields
  284. ~~~~~~~~~~~~~~~~
  285. Any fields that are stored with ``VARCHAR`` column types have their
  286. ``max_length`` restricted to 255 characters if you are using ``unique=True``
  287. for the field. This affects :class:`~django.db.models.CharField`,
  288. :class:`~django.db.models.SlugField` and
  289. :class:`~django.db.models.CommaSeparatedIntegerField`.
  290. DateTime fields
  291. ~~~~~~~~~~~~~~~
  292. MySQL does not have a timezone-aware column type. If an attempt is made to
  293. store a timezone-aware ``time`` or ``datetime`` to a
  294. :class:`~django.db.models.TimeField` or :class:`~django.db.models.DateTimeField`
  295. respectively, a ``ValueError`` is raised rather than truncating data.
  296. MySQL does not store fractions of seconds. Fractions of seconds are truncated
  297. to zero when the time is stored.
  298. Row locking with ``QuerySet.select_for_update()``
  299. -------------------------------------------------
  300. MySQL does not support the ``NOWAIT`` option to the ``SELECT ... FOR UPDATE``
  301. statement. If ``select_for_update()`` is used with ``nowait=True`` then a
  302. ``DatabaseError`` will be raised.
  303. .. _sqlite-notes:
  304. SQLite notes
  305. ============
  306. SQLite_ provides an excellent development alternative for applications that
  307. are predominantly read-only or require a smaller installation footprint. As
  308. with all database servers, though, there are some differences that are
  309. specific to SQLite that you should be aware of.
  310. .. _SQLite: http://www.sqlite.org/
  311. .. _sqlite-string-matching:
  312. Substring matching and case sensitivity
  313. -----------------------------------------
  314. For all SQLite versions, there is some slightly counter-intuitive behavior when
  315. attempting to match some types of strings. These are triggered when using the
  316. :lookup:`iexact` or :lookup:`contains` filters in Querysets. The behavior
  317. splits into two cases:
  318. 1. For substring matching, all matches are done case-insensitively. That is a
  319. filter such as ``filter(name__contains="aa")`` will match a name of ``"Aabb"``.
  320. 2. For strings containing characters outside the ASCII range, all exact string
  321. matches are performed case-sensitively, even when the case-insensitive options
  322. are passed into the query. So the :lookup:`iexact` filter will behave exactly
  323. the same as the :lookup:`exact` filter in these cases.
  324. Some possible workarounds for this are `documented at sqlite.org`_, but they
  325. aren't utilised by the default SQLite backend in Django, as incorporating them
  326. would be fairly difficult to do robustly. Thus, Django exposes the default
  327. SQLite behavior and you should be aware of this when doing case-insensitive or
  328. substring filtering.
  329. .. _documented at sqlite.org: http://www.sqlite.org/faq.html#q18
  330. SQLite 3.3.6 or newer strongly recommended
  331. ------------------------------------------
  332. Versions of SQLite 3.3.5 and older contains the following bugs:
  333. * A bug when `handling`_ ``ORDER BY`` parameters. This can cause problems when
  334. you use the ``select`` parameter for the ``extra()`` QuerySet method. The bug
  335. can be identified by the error message ``OperationalError: ORDER BY terms
  336. must not be non-integer constants``.
  337. * A bug when handling `aggregation`_ together with DateFields and
  338. DecimalFields.
  339. .. _handling: http://www.sqlite.org/cvstrac/tktview?tn=1768
  340. .. _aggregation: https://code.djangoproject.com/ticket/10031
  341. SQLite 3.3.6 was released in April 2006, so most current binary distributions
  342. for different platforms include newer version of SQLite usable from Python
  343. through either the ``pysqlite2`` or the ``sqlite3`` modules.
  344. Version 3.5.9
  345. -------------
  346. The Ubuntu "Intrepid Ibex" (8.10) SQLite 3.5.9-3 package contains a bug that
  347. causes problems with the evaluation of query expressions. If you are using
  348. Ubuntu "Intrepid Ibex", you will need to update the package to version
  349. 3.5.9-3ubuntu1 or newer (recommended) or find an alternate source for SQLite
  350. packages, or install SQLite from source.
  351. At one time, Debian Lenny shipped with the same malfunctioning SQLite 3.5.9-3
  352. package. However the Debian project has subsequently issued updated versions
  353. of the SQLite package that correct these bugs. If you find you are getting
  354. unexpected results under Debian, ensure you have updated your SQLite package
  355. to 3.5.9-5 or later.
  356. The problem does not appear to exist with other versions of SQLite packaged
  357. with other operating systems.
  358. Version 3.6.2
  359. --------------
  360. SQLite version 3.6.2 (released August 30, 2008) introduced a bug into ``SELECT
  361. DISTINCT`` handling that is triggered by, amongst other things, Django's
  362. ``DateQuerySet`` (returned by the ``dates()`` method on a queryset).
  363. You should avoid using this version of SQLite with Django. Either upgrade to
  364. 3.6.3 (released September 22, 2008) or later, or downgrade to an earlier
  365. version of SQLite.
  366. .. _using-newer-versions-of-pysqlite:
  367. Using newer versions of the SQLite DB-API 2.0 driver
  368. ----------------------------------------------------
  369. For versions of Python 2.5 or newer that include ``sqlite3`` in the standard
  370. library Django will now use a ``pysqlite2`` interface in preference to
  371. ``sqlite3`` if it finds one is available.
  372. This provides the ability to upgrade both the DB-API 2.0 interface or SQLite 3
  373. itself to versions newer than the ones included with your particular Python
  374. binary distribution, if needed.
  375. "Database is locked" errors
  376. ---------------------------
  377. SQLite is meant to be a lightweight database, and thus can't support a high
  378. level of concurrency. ``OperationalError: database is locked`` errors indicate
  379. that your application is experiencing more concurrency than ``sqlite`` can
  380. handle in default configuration. This error means that one thread or process has
  381. an exclusive lock on the database connection and another thread timed out
  382. waiting for the lock the be released.
  383. Python's SQLite wrapper has
  384. a default timeout value that determines how long the second thread is allowed to
  385. wait on the lock before it times out and raises the ``OperationalError: database
  386. is locked`` error.
  387. If you're getting this error, you can solve it by:
  388. * Switching to another database backend. At a certain point SQLite becomes
  389. too "lite" for real-world applications, and these sorts of concurrency
  390. errors indicate you've reached that point.
  391. * Rewriting your code to reduce concurrency and ensure that database
  392. transactions are short-lived.
  393. * Increase the default timeout value by setting the ``timeout`` database
  394. option option::
  395. 'OPTIONS': {
  396. # ...
  397. 'timeout': 20,
  398. # ...
  399. }
  400. This will simply make SQLite wait a bit longer before throwing "database
  401. is locked" errors; it won't really do anything to solve them.
  402. ``QuerySet.select_for_update()`` not supported
  403. ----------------------------------------------
  404. SQLite does not support the ``SELECT ... FOR UPDATE`` syntax. Calling it will
  405. have no effect.
  406. .. _sqlite-connection-queries:
  407. Parameters not quoted in ``connection.queries``
  408. -----------------------------------------------
  409. ``sqlite3`` does not provide a way to retrieve the SQL after quoting and
  410. substituting the parameters. Instead, the SQL in ``connection.queries`` is
  411. rebuilt with a simple string interpolation. It may be incorrect. Make sure
  412. you add quotes where necessary before copying a query into a SQLite shell.
  413. .. _oracle-notes:
  414. Oracle notes
  415. ============
  416. Django supports `Oracle Database Server`_ versions 9i and
  417. higher. Oracle version 10g or later is required to use Django's
  418. ``regex`` and ``iregex`` query operators. You will also need at least
  419. version 4.3.1 of the `cx_Oracle`_ Python driver.
  420. Note that due to a Unicode-corruption bug in ``cx_Oracle`` 5.0, that
  421. version of the driver should **not** be used with Django;
  422. ``cx_Oracle`` 5.0.1 resolved this issue, so if you'd like to use a
  423. more recent ``cx_Oracle``, use version 5.0.1.
  424. ``cx_Oracle`` 5.0.1 or greater can optionally be compiled with the
  425. ``WITH_UNICODE`` environment variable. This is recommended but not
  426. required.
  427. .. _`Oracle Database Server`: http://www.oracle.com/
  428. .. _`cx_Oracle`: http://cx-oracle.sourceforge.net/
  429. In order for the ``python manage.py syncdb`` command to work, your Oracle
  430. database user must have privileges to run the following commands:
  431. * CREATE TABLE
  432. * CREATE SEQUENCE
  433. * CREATE PROCEDURE
  434. * CREATE TRIGGER
  435. To run Django's test suite, the user needs these *additional* privileges:
  436. * CREATE USER
  437. * DROP USER
  438. * CREATE TABLESPACE
  439. * DROP TABLESPACE
  440. * CONNECT WITH ADMIN OPTION
  441. * RESOURCE WITH ADMIN OPTION
  442. Connecting to the database
  443. --------------------------
  444. Your Django settings.py file should look something like this for Oracle::
  445. DATABASES = {
  446. 'default': {
  447. 'ENGINE': 'django.db.backends.oracle',
  448. 'NAME': 'xe',
  449. 'USER': 'a_user',
  450. 'PASSWORD': 'a_password',
  451. 'HOST': '',
  452. 'PORT': '',
  453. }
  454. }
  455. If you don't use a ``tnsnames.ora`` file or a similar naming method that
  456. recognizes the SID ("xe" in this example), then fill in both
  457. :setting:`HOST` and :setting:`PORT` like so::
  458. DATABASES = {
  459. 'default': {
  460. 'ENGINE': 'django.db.backends.oracle',
  461. 'NAME': 'xe',
  462. 'USER': 'a_user',
  463. 'PASSWORD': 'a_password',
  464. 'HOST': 'dbprod01ned.mycompany.com',
  465. 'PORT': '1540',
  466. }
  467. }
  468. You should supply both :setting:`HOST` and :setting:`PORT`, or leave both
  469. as empty strings.
  470. Threaded option
  471. ----------------
  472. If you plan to run Django in a multithreaded environment (e.g. Apache in Windows
  473. using the default MPM module), then you **must** set the ``threaded`` option of
  474. your Oracle database configuration to True::
  475. 'OPTIONS': {
  476. 'threaded': True,
  477. },
  478. Failure to do this may result in crashes and other odd behavior.
  479. INSERT ... RETURNING INTO
  480. -------------------------
  481. By default, the Oracle backend uses a ``RETURNING INTO`` clause to efficiently
  482. retrieve the value of an ``AutoField`` when inserting new rows. This behavior
  483. may result in a ``DatabaseError`` in certain unusual setups, such as when
  484. inserting into a remote table, or into a view with an ``INSTEAD OF`` trigger.
  485. The ``RETURNING INTO`` clause can be disabled by setting the
  486. ``use_returning_into`` option of the database configuration to False::
  487. 'OPTIONS': {
  488. 'use_returning_into': False,
  489. },
  490. In this case, the Oracle backend will use a separate ``SELECT`` query to
  491. retrieve AutoField values.
  492. Naming issues
  493. -------------
  494. Oracle imposes a name length limit of 30 characters. To accommodate this, the
  495. backend truncates database identifiers to fit, replacing the final four
  496. characters of the truncated name with a repeatable MD5 hash value.
  497. When running syncdb, an ``ORA-06552`` error may be encountered if
  498. certain Oracle keywords are used as the name of a model field or the
  499. value of a ``db_column`` option. Django quotes all identifiers used
  500. in queries to prevent most such problems, but this error can still
  501. occur when an Oracle datatype is used as a column name. In
  502. particular, take care to avoid using the names ``date``,
  503. ``timestamp``, ``number`` or ``float`` as a field name.
  504. NULL and empty strings
  505. ----------------------
  506. Django generally prefers to use the empty string ('') rather than
  507. NULL, but Oracle treats both identically. To get around this, the
  508. Oracle backend ignores an explicit ``null`` option on fields that
  509. have the empty string as a possible value and generates DDL as if
  510. ``null=True``. When fetching from the database, it is assumed that
  511. a ``NULL`` value in one of these fields really means the empty
  512. string, and the data is silently converted to reflect this assumption.
  513. ``TextField`` limitations
  514. -------------------------
  515. The Oracle backend stores ``TextFields`` as ``NCLOB`` columns. Oracle imposes
  516. some limitations on the usage of such LOB columns in general:
  517. * LOB columns may not be used as primary keys.
  518. * LOB columns may not be used in indexes.
  519. * LOB columns may not be used in a ``SELECT DISTINCT`` list. This means that
  520. attempting to use the ``QuerySet.distinct`` method on a model that
  521. includes ``TextField`` columns will result in an error when run against
  522. Oracle. As a workaround, use the ``QuerySet.defer`` method in conjunction
  523. with ``distinct()`` to prevent ``TextField`` columns from being included in
  524. the ``SELECT DISTINCT`` list.
  525. .. _third-party-notes:
  526. Using a 3rd-party database backend
  527. ==================================
  528. In addition to the officially supported databases, there are backends provided
  529. by 3rd parties that allow you to use other databases with Django:
  530. * `Sybase SQL Anywhere`_
  531. * `IBM DB2`_
  532. * `Microsoft SQL Server 2005`_
  533. * Firebird_
  534. * ODBC_
  535. * ADSDB_
  536. The Django versions and ORM features supported by these unofficial backends
  537. vary considerably. Queries regarding the specific capabilities of these
  538. unofficial backends, along with any support queries, should be directed to
  539. the support channels provided by each 3rd party project.
  540. .. _Sybase SQL Anywhere: http://code.google.com/p/sqlany-django/
  541. .. _IBM DB2: http://code.google.com/p/ibm-db/
  542. .. _Microsoft SQL Server 2005: http://code.google.com/p/django-mssql/
  543. .. _Firebird: http://code.google.com/p/django-firebird/
  544. .. _ODBC: http://code.google.com/p/django-pyodbc/
  545. .. _ADSDB: http://code.google.com/p/adsdb-django/