Databases¶
Django officially supports the following databases:
- PostgreSQL
- MariaDB
- MySQL
- Oracle
- SQLite
There are also a number of database backends provided by third parties.
Django attempts to support as many features as possible on all database
backends. However, not all database backends are alike, and we’ve had to make
design decisions on which features to support and which assumptions we can make
safely.
This file describes some of the features that might be relevant to Django
usage. It is not intended as a replacement for server-specific documentation or
reference manuals.
General notes¶
Persistent connections¶
Persistent connections avoid the overhead of reestablishing a connection to
the database in each request. They’re controlled by the
CONN_MAX_AGE
parameter which defines the maximum lifetime of a
connection. It can be set independently for each database.
The default value is 0
, preserving the historical behavior of closing the
database connection at the end of each request. To enable persistent
connections, set CONN_MAX_AGE
to a positive integer of seconds. For
unlimited persistent connections, set it to None
.
Connection management¶
Django opens a connection to the database when it first makes a database
query. It keeps this connection open and reuses it in subsequent requests.
Django closes the connection once it exceeds the maximum age defined by
CONN_MAX_AGE
or when it isn’t usable any longer.
In detail, Django automatically opens a connection to the database whenever it
needs one and doesn’t have one already — either because this is the first
connection, or because the previous connection was closed.
At the beginning of each request, Django closes the connection if it has
reached its maximum age. If your database terminates idle connections after
some time, you should set CONN_MAX_AGE
to a lower value, so that
Django doesn’t attempt to use a connection that has been terminated by the
database server. (This problem may only affect very low traffic sites.)
At the end of each request, Django closes the connection if it has reached its
maximum age or if it is in an unrecoverable error state. If any database
errors have occurred while processing the requests, Django checks whether the
connection still works, and closes it if it doesn’t. Thus, database errors
affect at most one request per each application’s worker thread; if the
connection becomes unusable, the next request gets a fresh connection.
Setting CONN_HEALTH_CHECKS
to True
can be used to improve the
robustness of connection reuse and prevent errors when a connection has been
closed by the database server which is now ready to accept and serve new
connections, e.g. after database server restart. The health check is performed
only once per request and only if the database is being accessed during the
handling of the request.
Caveats¶
Since each thread maintains its own connection, your database must support at
least as many simultaneous connections as you have worker threads.
Sometimes a database won’t be accessed by the majority of your views, for
example because it’s the database of an external system, or thanks to caching.
In such cases, you should set CONN_MAX_AGE
to a low value or even
0
, because it doesn’t make sense to maintain a connection that’s unlikely
to be reused. This will help keep the number of simultaneous connections to
this database small.
The development server creates a new thread for each request it handles,
negating the effect of persistent connections. Don’t enable them during
development.
When Django establishes a connection to the database, it sets up appropriate
parameters, depending on the backend being used. If you enable persistent
connections, this setup is no longer repeated every request. If you modify
parameters such as the connection’s isolation level or time zone, you should
either restore Django’s defaults at the end of each request, force an
appropriate value at the beginning of each request, or disable persistent
connections.
Encoding¶
Django assumes that all databases use UTF-8 encoding. Using other encodings may
result in unexpected behavior such as “value too long” errors from your
database for data that is valid in Django. See the database specific notes
below for information on how to set up your database correctly.
PostgreSQL notes¶
Django supports PostgreSQL 11 and higher. psycopg2 2.8.4 or higher is
required, though the latest release is recommended.
PostgreSQL connection settings¶
See HOST
for details.
To connect using a service name from the connection service file and a
password from the password file, you must specify them in the
OPTIONS
part of your database configuration in DATABASES
:
settings.py
¶
DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', 'OPTIONS': { 'service': 'my_service', 'passfile': '.my_pgpass', }, } }
.pg_service.conf
¶
[my_service] host=localhost user=USER dbname=NAME port=5432
.my_pgpass
¶
localhost:5432:NAME:USER:PASSWORD
Changed in Django 4.0:
Support for connecting by a service name, and specifying a password file
was added.
Optimizing PostgreSQL’s configuration¶
Django needs the following parameters for its database connections:
client_encoding
:'UTF8'
,default_transaction_isolation
:'read committed'
by default,
or the value set in the connection options (see below),-
timezone
:-
- when
USE_TZ
isTrue
,'UTC'
by default, or the
TIME_ZONE
value set for the connection, - when
USE_TZ
isFalse
, the value of the global
TIME_ZONE
setting.
- when
If these parameters already have the correct values, Django won’t set them for
every new connection, which improves performance slightly. You can configure
them directly in postgresql.conf
or more conveniently per database
user with ALTER ROLE.
Django will work just fine without this optimization, but each new connection
will do some additional queries to set these parameters.
Isolation level¶
Like PostgreSQL itself, Django defaults to the READ COMMITTED
isolation
level. If you need a higher isolation level such as REPEATABLE READ
or
SERIALIZABLE
, set it in the OPTIONS
part of your database
configuration in DATABASES
:
import psycopg2.extensions DATABASES = { # ... 'OPTIONS': { 'isolation_level': psycopg2.extensions.ISOLATION_LEVEL_SERIALIZABLE, }, }
Note
Under higher isolation levels, your application should be prepared to
handle exceptions raised on serialization failures. This option is
designed for advanced uses.
Indexes for varchar
and text
columns¶
When specifying db_index=True
on your model fields, Django typically
outputs a single CREATE INDEX
statement. However, if the database type
for the field is either varchar
or text
(e.g., used by CharField
,
FileField
, and TextField
), then Django will create
an additional index that uses an appropriate PostgreSQL operator class
for the column. The extra index is necessary to correctly perform
lookups that use the LIKE
operator in their SQL, as is done with the
contains
and startswith
lookup types.
Migration operation for adding extensions¶
If you need to add a PostgreSQL extension (like hstore
, postgis
, etc.)
using a migration, use the
CreateExtension
operation.
Server-side cursors¶
When using QuerySet.iterator()
, Django opens a server-side
cursor. By default, PostgreSQL assumes that
only the first 10% of the results of cursor queries will be fetched. The query
planner spends less time planning the query and starts returning results
faster, but this could diminish performance if more than 10% of the results are
retrieved. PostgreSQL’s assumptions on the number of rows retrieved for a
cursor query is controlled with the cursor_tuple_fraction option.
Transaction pooling and server-side cursors¶
Using a connection pooler in transaction pooling mode (e.g. PgBouncer)
requires disabling server-side cursors for that connection.
Server-side cursors are local to a connection and remain open at the end of a
transaction when AUTOCOMMIT
is True
. A
subsequent transaction may attempt to fetch more results from a server-side
cursor. In transaction pooling mode, there’s no guarantee that subsequent
transactions will use the same connection. If a different connection is used,
an error is raised when the transaction references the server-side cursor,
because server-side cursors are only accessible in the connection in which they
were created.
One solution is to disable server-side cursors for a connection in
DATABASES
by setting DISABLE_SERVER_SIDE_CURSORS
to True
.
To benefit from server-side cursors in transaction pooling mode, you could set
up another connection to the database in order to
perform queries that use server-side cursors. This connection needs to either
be directly to the database or to a connection pooler in session pooling mode.
Another option is to wrap each QuerySet
using server-side cursors in an
atomic()
block, because it disables autocommit
for the duration of the transaction. This way, the server-side cursor will only
live for the duration of the transaction.
Manually-specifying values of auto-incrementing primary keys¶
Django uses PostgreSQL’s identity columns to store auto-incrementing primary
keys. An identity column is populated with values from a sequence that keeps
track of the next available value. Manually assigning a value to an
auto-incrementing field doesn’t update the field’s sequence, which might later
cause a conflict. For example:
>>> from django.contrib.auth.models import User >>> User.objects.create(username='alice', pk=1) <User: alice> >>> # The sequence hasn't been updated; its next value is 1. >>> User.objects.create(username='bob') ... IntegrityError: duplicate key value violates unique constraint "auth_user_pkey" DETAIL: Key (id)=(1) already exists.
If you need to specify such values, reset the sequence afterward to avoid
reusing a value that’s already in the table. The sqlsequencereset
management command generates the SQL statements to do that.
Changed in Django 4.1:
In older versions, PostgreSQL’s SERIAL
data type was used instead of
identity columns.
Test database templates¶
You can use the TEST['TEMPLATE']
setting to specify
a template (e.g. 'template0'
) from which to create a test database.
Speeding up test execution with non-durable settings¶
You can speed up test execution times by configuring PostgreSQL to be
non-durable.
Warning
This is dangerous: it will make your database more susceptible to data loss
or corruption in the case of a server crash or power loss. Only use this on
a development machine where you can easily restore the entire contents of
all databases in the cluster.
MariaDB notes¶
Django supports MariaDB 10.3 and higher.
To use MariaDB, use the MySQL backend, which is shared between the two. See the
MySQL notes for more details.
MySQL notes¶
Version support¶
Django supports MySQL 5.7 and higher.
Django’s inspectdb
feature uses the information_schema
database, which
contains detailed data on all database schemas.
Django expects the database to support Unicode (UTF-8 encoding) and delegates to
it the task of enforcing transactions and referential integrity. It is important
to be aware of the fact that the two latter ones aren’t actually enforced by
MySQL when using the MyISAM storage engine, see the next section.
Storage engines¶
MySQL has several storage engines. You can change the default storage engine
in the server configuration.
MySQL’s default storage engine is InnoDB. This engine is fully transactional
and supports foreign key references. It’s the recommended choice. However, the
InnoDB autoincrement counter is lost on a MySQL restart because it does not
remember the AUTO_INCREMENT
value, instead recreating it as “max(id)+1”.
This may result in an inadvertent reuse of AutoField
values.
The main drawbacks of MyISAM are that it doesn’t support transactions or
enforce foreign-key constraints.
MySQL DB API Drivers¶
MySQL has a couple drivers that implement the Python Database API described in
PEP 249:
- mysqlclient is a native driver. It’s the recommended choice.
- MySQL Connector/Python is a pure Python driver from Oracle that does not
require the MySQL client library or any Python modules outside the standard
library.
These drivers are thread-safe and provide connection pooling.
In addition to a DB API driver, Django needs an adapter to access the database
drivers from its ORM. Django provides an adapter for mysqlclient while MySQL
Connector/Python includes its own.
MySQL Connector/Python¶
MySQL Connector/Python is available from the download page.
The Django adapter is available in versions 1.1.X and later. It may not
support the most recent releases of Django.
Time zone definitions¶
If you plan on using Django’s timezone support,
use mysql_tzinfo_to_sql to load time zone tables into the MySQL database.
This needs to be done just once for your MySQL server, not per database.
Creating your database¶
You can create your database using the command-line tools and this SQL:
CREATE DATABASE <dbname> CHARACTER SET utf8;
This ensures all tables and columns will use UTF-8 by default.
Collation settings¶
The collation setting for a column controls the order in which data is sorted
as well as what strings compare as equal. You can specify the db_collation
parameter to set the collation name of the column for
CharField
and
TextField
.
The collation can also be set on a database-wide level and per-table. This is
documented thoroughly in the MySQL documentation. In such cases, you must
set the collation by directly manipulating the database settings or tables.
Django doesn’t provide an API to change them.
By default, with a UTF-8 database, MySQL will use the
utf8_general_ci
collation. This results in all string equality
comparisons being done in a case-insensitive manner. That is, "Fred"
and
"freD"
are considered equal at the database level. If you have a unique
constraint on a field, it would be illegal to try to insert both "aa"
and
"AA"
into the same column, since they compare as equal (and, hence,
non-unique) with the default collation. If you want case-sensitive comparisons
on a particular column or table, change the column or table to use the
utf8_bin
collation.
Please note that according to MySQL Unicode Character Sets, comparisons for
the utf8_general_ci
collation are faster, but slightly less correct, than
comparisons for utf8_unicode_ci
. If this is acceptable for your application,
you should use utf8_general_ci
because it is faster. If this is not acceptable
(for example, if you require German dictionary order), use utf8_unicode_ci
because it is more accurate.
Warning
Model formsets validate unique fields in a case-sensitive manner. Thus when
using a case-insensitive collation, a formset with unique field values that
differ only by case will pass validation, but upon calling save()
, an
IntegrityError
will be raised.
Connecting to the database¶
Refer to the settings documentation.
Connection settings are used in this order:
OPTIONS
.NAME
,USER
,PASSWORD
,HOST
,
PORT
- MySQL option files.
In other words, if you set the name of the database in OPTIONS
,
this will take precedence over NAME
, which would override
anything in a MySQL option file.
Here’s a sample configuration which uses a MySQL option file:
# settings.py DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'OPTIONS': { 'read_default_file': '/path/to/my.cnf', }, } } # my.cnf [client] database = NAME user = USER password = PASSWORD default-character-set = utf8
Several other MySQLdb connection options may be useful, such as ssl
,
init_command
, and sql_mode
.
Setting sql_mode
¶
From MySQL 5.7 onward, the default value of the sql_mode
option contains
STRICT_TRANS_TABLES
. That option escalates warnings into errors when data
are truncated upon insertion, so Django highly recommends activating a
strict mode for MySQL to prevent data loss (either STRICT_TRANS_TABLES
or STRICT_ALL_TABLES
).
If you need to customize the SQL mode, you can set the sql_mode
variable
like other MySQL options: either in a config file or with the entry
'init_command': "SET sql_mode='STRICT_TRANS_TABLES'"
in the
OPTIONS
part of your database configuration in DATABASES
.
Isolation level¶
When running concurrent loads, database transactions from different sessions
(say, separate threads handling different requests) may interact with each
other. These interactions are affected by each session’s transaction isolation
level. You can set a connection’s isolation level with an
'isolation_level'
entry in the OPTIONS
part of your database
configuration in DATABASES
. Valid values for
this entry are the four standard isolation levels:
'read uncommitted'
'read committed'
'repeatable read'
'serializable'
or None
to use the server’s configured isolation level. However, Django
works best with and defaults to read committed rather than MySQL’s default,
repeatable read. Data loss is possible with repeatable read. In particular,
you may see cases where get_or_create()
will raise an IntegrityError
but the object won’t appear in
a subsequent get()
call.
Creating your tables¶
When Django generates the schema, it doesn’t specify a storage engine, so
tables will be created with whatever default storage engine your database
server is configured for. The easiest solution is to set your database server’s
default storage engine to the desired engine.
If you’re using a hosting service and can’t change your server’s default
storage engine, you have a couple of options.
-
After the tables are created, execute an
ALTER TABLE
statement to
convert a table to a new storage engine (such as InnoDB):ALTER TABLE <tablename> ENGINE=INNODB;
This can be tedious if you have a lot of tables.
-
Another option is to use the
init_command
option for MySQLdb prior to
creating your tables:'OPTIONS': { 'init_command': 'SET default_storage_engine=INNODB', }
This sets the default storage engine upon connecting to the database.
After your tables have been created, you should remove this option as it
adds a query that is only needed during table creation to each database
connection.
Table names¶
There are known issues in even the latest versions of MySQL that can cause the
case of a table name to be altered when certain SQL statements are executed
under certain conditions. It is recommended that you use lowercase table
names, if possible, to avoid any problems that might arise from this behavior.
Django uses lowercase table names when it auto-generates table names from
models, so this is mainly a consideration if you are overriding the table name
via the db_table
parameter.
Savepoints¶
Both the Django ORM and MySQL (when using the InnoDB storage engine) support database savepoints.
If you use the MyISAM storage engine please be aware of the fact that you will
receive database-generated errors if you try to use the savepoint-related
methods of the transactions API. The reason
for this is that detecting the storage engine of a MySQL database/table is an
expensive operation so it was decided it isn’t worth to dynamically convert
these methods in no-op’s based in the results of such detection.
Notes on specific fields¶
Character fields¶
Any fields that are stored with VARCHAR
column types may have their
max_length
restricted to 255 characters if you are using unique=True
for the field. This affects CharField
,
SlugField
. See the MySQL documentation for more
details.
TextField
limitations¶
MySQL can index only the first N chars of a BLOB
or TEXT
column. Since
TextField
doesn’t have a defined length, you can’t mark it as
unique=True
. MySQL will report: “BLOB/TEXT column ‘<db_column>’ used in key
specification without a key length”.
Fractional seconds support for Time and DateTime fields¶
MySQL can store fractional seconds, provided that the column definition
includes a fractional indication (e.g. DATETIME(6)
).
Django will not upgrade existing columns to include fractional seconds if the
database server supports it. If you want to enable them on an existing database,
it’s up to you to either manually update the column on the target database, by
executing a command like:
ALTER TABLE `your_table` MODIFY `your_datetime_column` DATETIME(6)
or using a RunSQL
operation in a
data migration.
TIMESTAMP
columns¶
If you are using a legacy database that contains TIMESTAMP
columns, you must
set USE_TZ = False
to avoid data corruption.
inspectdb
maps these columns to
DateTimeField
and if you enable timezone support,
both MySQL and Django will attempt to convert the values from UTC to local time.
Row locking with QuerySet.select_for_update()
¶
MySQL and MariaDB do not support some options to the SELECT ... FOR UPDATE
statement. If select_for_update()
is used with an unsupported option, then
a NotSupportedError
is raised.
Option | MariaDB | MySQL |
---|---|---|
SKIP LOCKED |
X (≥10.6) | X (≥8.0.1) |
NOWAIT |
X | X (≥8.0.1) |
OF |
X (≥8.0.1) | |
NO KEY |
When using select_for_update()
on MySQL, make sure you filter a queryset
against at least a set of fields contained in unique constraints or only
against fields covered by indexes. Otherwise, an exclusive write lock will be
acquired over the full table for the duration of the transaction.
Automatic typecasting can cause unexpected results¶
When performing a query on a string type, but with an integer value, MySQL will
coerce the types of all values in the table to an integer before performing the
comparison. If your table contains the values 'abc'
, 'def'
and you
query for WHERE mycolumn=0
, both rows will match. Similarly, WHERE mycolumn=1
will match the value 'abc1'
. Therefore, string type fields included in Django
will always cast the value to a string before using it in a query.
If you implement custom model fields that inherit from
Field
directly, are overriding
get_prep_value()
, or use
RawSQL
,
extra()
, or
raw()
, you should ensure that you perform
appropriate typecasting.
SQLite notes¶
Django supports SQLite 3.9.0 and later.
SQLite provides an excellent development alternative for applications that
are predominantly read-only or require a smaller installation footprint. As
with all database servers, though, there are some differences that are
specific to SQLite that you should be aware of.
Substring matching and case sensitivity¶
For all SQLite versions, there is some slightly counter-intuitive behavior when
attempting to match some types of strings. These are triggered when using the
iexact
or contains
filters in Querysets. The behavior
splits into two cases:
1. For substring matching, all matches are done case-insensitively. That is a
filter such as filter(name__contains="aa")
will match a name of "Aabb"
.
2. For strings containing characters outside the ASCII range, all exact string
matches are performed case-sensitively, even when the case-insensitive options
are passed into the query. So the iexact
filter will behave exactly
the same as the exact
filter in these cases.
Some possible workarounds for this are documented at sqlite.org, but they
aren’t utilized by the default SQLite backend in Django, as incorporating them
would be fairly difficult to do robustly. Thus, Django exposes the default
SQLite behavior and you should be aware of this when doing case-insensitive or
substring filtering.
Decimal handling¶
SQLite has no real decimal internal type. Decimal values are internally
converted to the REAL
data type (8-byte IEEE floating point number), as
explained in the SQLite datatypes documentation, so they don’t support
correctly-rounded decimal floating point arithmetic.
“Database is locked” errors¶
SQLite is meant to be a lightweight database, and thus can’t support a high
level of concurrency. OperationalError: database is locked
errors indicate
that your application is experiencing more concurrency than sqlite
can
handle in default configuration. This error means that one thread or process has
an exclusive lock on the database connection and another thread timed out
waiting for the lock the be released.
Python’s SQLite wrapper has
a default timeout value that determines how long the second thread is allowed to
wait on the lock before it times out and raises the OperationalError: database
error.
is locked
If you’re getting this error, you can solve it by:
-
Switching to another database backend. At a certain point SQLite becomes
too “lite” for real-world applications, and these sorts of concurrency
errors indicate you’ve reached that point. -
Rewriting your code to reduce concurrency and ensure that database
transactions are short-lived. -
Increase the default timeout value by setting the
timeout
database
option:'OPTIONS': { # ... 'timeout': 20, # ... }
This will make SQLite wait a bit longer before throwing “database is locked”
errors; it won’t really do anything to solve them.
QuerySet.select_for_update()
not supported¶
SQLite does not support the SELECT ... FOR UPDATE
syntax. Calling it will
have no effect.
“pyformat” parameter style in raw queries not supported¶
For most backends, raw queries (Manager.raw()
or cursor.execute()
)
can use the “pyformat” parameter style, where placeholders in the query
are given as '%(name)s'
and the parameters are passed as a dictionary
rather than a list. SQLite does not support this.
Isolation when using QuerySet.iterator()
¶
There are special considerations described in Isolation In SQLite when
modifying a table while iterating over it using QuerySet.iterator()
. If
a row is added, changed, or deleted within the loop, then that row may or may
not appear, or may appear twice, in subsequent results fetched from the
iterator. Your code must handle this.
Enabling JSON1 extension on SQLite¶
To use JSONField
on SQLite, you need to enable the
JSON1 extension on Python’s sqlite3
library. If the extension is
not enabled on your installation, a system error (fields.E180
) will be
raised.
To enable the JSON1 extension you can follow the instruction on
the wiki page.
Oracle notes¶
Django supports Oracle Database Server versions 19c and higher. Version 7.0
or higher of the cx_Oracle Python driver is required.
In order for the python manage.py migrate
command to work, your Oracle
database user must have privileges to run the following commands:
- CREATE TABLE
- CREATE SEQUENCE
- CREATE PROCEDURE
- CREATE TRIGGER
To run a project’s test suite, the user usually needs these additional
privileges:
- CREATE USER
- ALTER USER
- DROP USER
- CREATE TABLESPACE
- DROP TABLESPACE
- CREATE SESSION WITH ADMIN OPTION
- CREATE TABLE WITH ADMIN OPTION
- CREATE SEQUENCE WITH ADMIN OPTION
- CREATE PROCEDURE WITH ADMIN OPTION
- CREATE TRIGGER WITH ADMIN OPTION
While the RESOURCE
role has the required CREATE TABLE
,
CREATE SEQUENCE
, CREATE PROCEDURE
, and CREATE TRIGGER
privileges,
and a user granted RESOURCE WITH ADMIN OPTION
can grant RESOURCE
, such
a user cannot grant the individual privileges (e.g. CREATE TABLE
), and thus
RESOURCE WITH ADMIN OPTION
is not usually sufficient for running tests.
Some test suites also create views or materialized views; to run these, the
user also needs CREATE VIEW WITH ADMIN OPTION
and
CREATE MATERIALIZED VIEW WITH ADMIN OPTION
privileges. In particular, this
is needed for Django’s own test suite.
All of these privileges are included in the DBA role, which is appropriate
for use on a private developer’s database.
The Oracle database backend uses the SYS.DBMS_LOB
and SYS.DBMS_RANDOM
packages, so your user will require execute permissions on it. It’s normally
accessible to all users by default, but in case it is not, you’ll need to grant
permissions like so:
GRANT EXECUTE ON SYS.DBMS_LOB TO user; GRANT EXECUTE ON SYS.DBMS_RANDOM TO user;
Connecting to the database¶
To connect using the service name of your Oracle database, your settings.py
file should look something like this:
DATABASES = { 'default': { 'ENGINE': 'django.db.backends.oracle', 'NAME': 'xe', 'USER': 'a_user', 'PASSWORD': 'a_password', 'HOST': '', 'PORT': '', } }
In this case, you should leave both HOST
and PORT
empty.
However, if you don’t use a tnsnames.ora
file or a similar naming method
and want to connect using the SID (“xe” in this example), then fill in both
HOST
and PORT
like so:
DATABASES = { 'default': { 'ENGINE': 'django.db.backends.oracle', 'NAME': 'xe', 'USER': 'a_user', 'PASSWORD': 'a_password', 'HOST': 'dbprod01ned.mycompany.com', 'PORT': '1540', } }
You should either supply both HOST
and PORT
, or leave
both as empty strings. Django will use a different connect descriptor depending
on that choice.
Full DSN and Easy Connect¶
A Full DSN or Easy Connect string can be used in NAME
if both
HOST
and PORT
are empty. This format is required when
using RAC or pluggable databases without tnsnames.ora
, for example.
Example of an Easy Connect string:
'NAME': 'localhost:1521/orclpdb1',
Example of a full DSN string:
'NAME': ( '(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))' '(CONNECT_DATA=(SERVICE_NAME=orclpdb1)))' ),
Threaded option¶
If you plan to run Django in a multithreaded environment (e.g. Apache using the
default MPM module on any modern operating system), then you must set
the threaded
option of your Oracle database configuration to True
:
'OPTIONS': { 'threaded': True, },
Failure to do this may result in crashes and other odd behavior.
INSERT … RETURNING INTO¶
By default, the Oracle backend uses a RETURNING INTO
clause to efficiently
retrieve the value of an AutoField
when inserting new rows. This behavior
may result in a DatabaseError
in certain unusual setups, such as when
inserting into a remote table, or into a view with an INSTEAD OF
trigger.
The RETURNING INTO
clause can be disabled by setting the
use_returning_into
option of the database configuration to False
:
'OPTIONS': { 'use_returning_into': False, },
In this case, the Oracle backend will use a separate SELECT
query to
retrieve AutoField
values.
Naming issues¶
Oracle imposes a name length limit of 30 characters. To accommodate this, the
backend truncates database identifiers to fit, replacing the final four
characters of the truncated name with a repeatable MD5 hash value.
Additionally, the backend turns database identifiers to all-uppercase.
To prevent these transformations (this is usually required only when dealing
with legacy databases or accessing tables which belong to other users), use
a quoted name as the value for db_table
:
class LegacyModel(models.Model): class Meta: db_table = '"name_left_in_lowercase"' class ForeignModel(models.Model): class Meta: db_table = '"OTHER_USER"."NAME_ONLY_SEEMS_OVER_30"'
Quoted names can also be used with Django’s other supported database
backends; except for Oracle, however, the quotes have no effect.
When running migrate
, an ORA-06552
error may be encountered if
certain Oracle keywords are used as the name of a model field or the
value of a db_column
option. Django quotes all identifiers used
in queries to prevent most such problems, but this error can still
occur when an Oracle datatype is used as a column name. In
particular, take care to avoid using the names date
,
timestamp
, number
or float
as a field name.
NULL and empty strings¶
Django generally prefers to use the empty string (''
) rather than
NULL
, but Oracle treats both identically. To get around this, the
Oracle backend ignores an explicit null
option on fields that
have the empty string as a possible value and generates DDL as if
null=True
. When fetching from the database, it is assumed that
a NULL
value in one of these fields really means the empty
string, and the data is silently converted to reflect this assumption.
TextField
limitations¶
The Oracle backend stores TextFields
as NCLOB
columns. Oracle imposes
some limitations on the usage of such LOB columns in general:
- LOB columns may not be used as primary keys.
- LOB columns may not be used in indexes.
- LOB columns may not be used in a
SELECT DISTINCT
list. This means that
attempting to use theQuerySet.distinct
method on a model that
includesTextField
columns will result in anORA-00932
error when
run against Oracle. As a workaround, use theQuerySet.defer
method in
conjunction withdistinct()
to preventTextField
columns from being
included in theSELECT DISTINCT
list.
Subclassing the built-in database backends¶
Django comes with built-in database backends. You may subclass an existing
database backends to modify its behavior, features, or configuration.
Consider, for example, that you need to change a single database feature.
First, you have to create a new directory with a base
module in it. For
example:
mysite/ ... mydbengine/ __init__.py base.py
The base.py
module must contain a class named DatabaseWrapper
that
subclasses an existing engine from the django.db.backends
module. Here’s an
example of subclassing the PostgreSQL engine to change a feature class
allows_group_by_selected_pks_on_model
:
mysite/mydbengine/base.py
¶
from django.db.backends.postgresql import base, features class DatabaseFeatures(features.DatabaseFeatures): def allows_group_by_selected_pks_on_model(self, model): return True class DatabaseWrapper(base.DatabaseWrapper): features_class = DatabaseFeatures
Finally, you must specify a DATABASE-ENGINE
in your settings.py
file:
DATABASES = { 'default': { 'ENGINE': 'mydbengine', ... }, }
You can see the current list of database engines by looking in
django/db/backends.
Using a 3rd-party database backend¶
In addition to the officially supported databases, there are backends provided
by 3rd parties that allow you to use other databases with Django:
- CockroachDB
- Firebird
- Google Cloud Spanner
- Microsoft SQL Server
- TiDB
- YugabyteDB
The Django versions and ORM features supported by these unofficial backends
vary considerably. Queries regarding the specific capabilities of these
unofficial backends, along with any support queries, should be directed to
the support channels provided by each 3rd party project.
- Первоначальная настройка подключения MySQL к Django
- Настройки подключения Django MySQL
При работе с базами данных у нас есть много вариантов в списке. Мы можем выбирать между реляционными базами данных или базами данных SQL, такими как MySQL, PostgreSQL, SQL Server, SQLite, MariaDB, и нереляционными базами данных или базами данных, отличными от SQL, такими как MongoDB и Redis Couchbase.
Поскольку Django — это полноценный надежный веб-фреймворк, он совместим практически со всеми базами данных. Возможно, нам придется проделать дополнительную работу с нашей стороны или, возможно, использовать некоторые плагины или приложения для определенных баз данных, но официальный Django поддерживает PostgreSQL, MariaDB, MySQL, Oracle и SQLite.
В этой статье рассказывается о том, как подключить MySQL к Django.
Первоначальная настройка подключения MySQL к Django
Прежде чем приступить к настройке подключения, убедитесь, что в вашей системе настроен MySQL. Убедитесь, что у вас есть учетная запись и созданы базы данных, к которым вы хотите подключиться.
Более того, вам также потребуется клиент MySQL для взаимодействия с базами данных с помощью Python (версии 3.X).
Клиент MySQL можно загрузить с помощью следующей команды pip
.
Или же,
Настройки подключения Django MySQL
Django по умолчанию использует базу данных SQLite. Настройки подключения для того же выглядят так.
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db.sqlite3',
}
}
Чтобы подключить Django к базе данных MySQL, мы должны использовать следующие настройки.
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'databaseName',
'USER': 'databaseUser',
'PASSWORD': 'databasePassword',
'HOST': 'localhost',
'PORT': 'portNumber',
}
}
Ключ ENGINE
для базы данных MySQL может быть разным. Кроме того, есть несколько дополнительных клавиш, таких как USER
, PASSWORD
, HOST
и PORT
.
NAME |
Этот ключ хранит имя вашей базы данных MySQL. |
USER |
В этом ключе хранится имя пользователя вашей учетной записи MySQL, с помощью которой будет подключена база данных MySQL. |
PASSWORD |
Этот ключ хранит пароль этой учетной записи MySQL. |
HOST |
В этом ключе хранится IP-адрес, на котором размещена ваша база данных MySQL. |
PORT |
В этом ключе хранится номер порта, на котором размещена ваша база данных MySQL. |
Наконец, выполните необходимые миграции с помощью python manage.py makemigrations
и python manage.py migrate
, чтобы завершить настройку.
База данных является важным компонентом веб-приложения для хранения и организации данных. Всякий раз, когда мы разрабатываем приложение или веб-сайт, нам нужно выбрать подходящую базу данных, которая сделает его более интерактивным.
Django поставляется со встроенной базой данных SQLite. Однако мы можем использовать различные базы данных в Django. Ниже приведены списки баз данных, которые поддерживает Django.
- PostgreSQL
- MariaDB
- MySQL
- Oracle
- SQLite
Есть также ряд серверных баз данных, предоставленных третьими сторонами. Промежуточное ПО Django позволяет нам взаимодействовать с базой данных. В этом руководстве мы узнаем, как подключить базу данных MySQL к нашему приложению Django.
Предпосылки
- Сервер MySQL 5.7+ должен быть установлен;
- Python 3.0+ должен быть установлен.
Мы предполагаем, что вы уже установили сервер MySQL на свой локальный компьютер. Если вы не установили его, загрузите его с официального сайта MySQL.
Выполнение
Мы используем следующие шаги, чтобы установить соединение между Django и MySQL.
Шаг – 1. Создайте виртуальную среду и настройте проект Django.
Сначала мы создадим виртуальную среду и установим в нее Django. Мы пропускаем этот процесс, так как он удлиняет урок. Мы создаем новый проект, используя следующую команду.
django-admin startproject MyProject .
Точка(.) в конце команды означает, что мы создаем проект в рабочем каталоге. Если период не указан, проект будет создан в новом каталоге с именем MyProject, и внутри этого каталога будут содержаться наши настоящие файлы django.
Теперь запустите сервер с помощью приведенной ниже команды.
python manage.py runserver
Терминал отобразит ссылку http://127.0.0.1:8000, перейдите по этой ссылке.
Шаг – 2. Создайте новую базу данных.
Мы можем создать базу данных двумя способами — MySQL Workbench и MySQL shell. MySQL Workbench — это инструмент с графическим интерфейсом для базы данных MySQL, который предоставляет такие функции, как разработка SQL, моделирование данных и администрирование сервера. Мы будем использовать оболочку MySQL, которая более рекомендуема для учебных целей.
- Подключить сервер MySQL.
- Создать базу данных с помощью SQL-запросов.
Используйте запрос создания базы данных my_database. Это создаст новую базу данных.
Мы можем проверить базы данных с помощью запроса show databases.
mysql> show databases;
+--------------------------------------+ | Database | +--------------------------------------+ | information_schema | | my_database | | mysql | | performance_schema | | sys | +---------------------------------------+ 5 rows in set(0.05 sec)
Он показывает всю доступную базу данных на нашем сервере MySQL.
Шаг – 3. Обновите файл settings.py.
Когда мы закончим создание базы данных, мы должны обновить раздел базы данных файла settings.py со следующей конфигурацией параметров.
DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', 'NAME': 'my_database', 'USER': 'root', 'PASSWORD': 'your_password', 'HOST': '127.0.0.1', 'PORT': '3306', 'OPTIONS': { 'init_command': "SET sql_mode='STRICT_TRANS_TABLES'" } } }
Давайте разберемся, что мы сделали выше.
- Во-первых, мы заменили «django.db.backends.sqlite3» на «django.db.backends.mysql». Это в основном указывает на то, что мы переносим SQLite на базу данных MySQL.
- NAME указывает имя базы данных, которую мы хотим использовать.
- USER — это имя пользователя MYSQL, который имеет доступ к базе данных и действует как администратор базы данных.
- PASSWORD — пароль базы данных. Он будет создан во время установки MySQL.
- «HOST» — «127.0.0.1», а «PORT» «3306» указывает, что база данных MySQL размещена с именем хоста «0.0.1» и прослушивает конкретный номер порта — 3306.
- В последней строке мы используем SET sql_mode = ‘STATIC_TRANS_TABLES’, который используется для обработки недопустимых или отсутствующих значений, сохраняемых в базе данных операторами INSERT и UPDATE.
Шаг – 4. Установите пакет mysqlclient.
Перед установкой пакета mysqlclient давайте разберемся, что такое mysqlclient и почему мы его используем. mysqlclient — это интерфейс Python для MySQL, который позволяет проекту Python подключаться к серверу MySQL.
Поэтому необходимо установить пакет mysqlclient, чтобы установить соединение между MySQL и Django. Для установки используйте следующую команду в рабочем каталоге.
pip install mysqlclient
Шаг – 5. Запустите команду миграции.
Теперь мы готовы к миграции или созданию таблиц во вновь созданной базе данных. На этом последнем шаге мы запустим команду migrate, и она создаст существующие таблицы в базе данных my_database.
python manage.py migrate
После запуска этой команды Django автоматически создаст необходимые таблицы, такие как auth_group, auth_user, auth_permission и т. д. Он также создаст таблицы, определенные в файле models.py.
mysql> use my_database;
База данных изменена.
mysql> show tables;
+-------------------------------------------------------+ | Tables_in_my_database | +-------------------------------------------------------+ | auth_group | | auth_group_permissions | | auth_permission | | auth_user | | auth_user_groups | | auth_user_user_permissions | | django_admin_log | | django_content_type | | django_migrations | | django_session | | myweatherapp_profile | +---------------------------------------------------------+ 11 rows in set(0.05 sec)
Вывод
В этом руководстве мы обсудили, как мы можем использовать базу данных MySQL в Django. Хотя Django поставляется со встроенной базой данных SQLite, иногда она не соответствует требованиям. Таким образом, мы можем подключаться к различным базам данных.
Изучаю Python вместе с вами, читаю, собираю и записываю информацию опытных программистов.
MySQL support is simple to add. In your DATABASES
dictionary, you will have an entry like this:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'DB_NAME',
'USER': 'DB_USER',
'PASSWORD': 'DB_PASSWORD',
'HOST': 'localhost', # Or an IP Address that your DB is hosted on
'PORT': '3306',
}
}
You also have the option of utilizing MySQL option files, as of Django 1.7. You can accomplish this by setting your DATABASES
array like so:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': '/path/to/my.cnf',
},
}
}
You also need to create the /path/to/my.cnf
file with similar settings from above
[client]
database = DB_NAME
host = localhost
user = DB_USER
password = DB_PASSWORD
default-character-set = utf8
With this new method of connecting in Django 1.7, it is important to know the order connections are established:
1. OPTIONS.
2. NAME, USER, PASSWORD, HOST, PORT
3. MySQL option files.
In other words, if you set the name of the database in OPTIONS, this will take precedence over NAME, which would override anything in a MySQL option file.
If you are just testing your application on your local machine, you can use
python manage.py runserver
Adding the ip:port
argument allows machines other than your own to access your development application. Once you are ready to deploy your application, I recommend taking a look at the chapter on Deploying Django on the djangobook
Mysql default character set is often not utf-8, therefore make sure to create your database using this sql:
CREATE DATABASE mydatabase CHARACTER SET utf8 COLLATE utf8_bin
If you are using Oracle’s MySQL connector your ENGINE
line should look like this:
'ENGINE': 'mysql.connector.django',
Note that you will first need to install mysql on your OS.
brew install mysql (MacOS)
Also, the mysql client package has changed for python 3 (MySQL-Client
works only for python 2)
pip3 install mysqlclient
Hello Coders,
This article explains How to use MySql with Django and switch from the default SQLite database to a production-ready DBMS (MySql). This topic might sound like a trivial subject but during my support sessions, I got this question over and over especially from beginners.
For newcomers, Django is a leading Python web framework built by experts using a bateries-included
concept. Being such a mature framework, Django provides an easy way to switch from the default SQLite database to other database engines like MySql, PostgreSQL, or Oracle. MySql is a powerful open-source relational database where the information is correlated and saved in one or more tables.
Django Database System
Django provides a generic way to access multiple database backends using a generic interface. In theory, Django empowers us to switch between DB Engines without updating the SQL code. The default SQLite database usually covers all requirements for small or demo projects but for production use, a more powerful database engine like MySql or PostgreSQL is recommended.
The database settings are saved in the file referred by manage.py
file. In my Django projects, this file is saved inside the core
directory:
< PROJECT ROOT >
|
|-- manage.py # Specify the settings file
|
|-- core/ # Implements app logic
| |-- settings.py # Django app bootstrapper
| |-- wsgi.py # Start the app in production
| |-- urls.py # Define URLs served by all apps/nodes
Enter fullscreen mode
Exit fullscreen mode
Let’s visualize the contents of the settings.py
file that configures the database interface.
# File: core/settings.py
...
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME' : 'db.sqlite3',
}
}
...
Enter fullscreen mode
Exit fullscreen mode
The above snippet is provided by when Django scaffolds the project. We can see that the SQLite driver is specified by the ENGINE
variable.
Update Django for MySql
To use MySql as the backend engine for a Django project, we need to follow a simple setup:
- Install the MySql Server (we can also use a remote one)
- Install the Mysql Python driver — used by Django to connect and communicate
- Create the Mysql database and the user
- Update settings Django
- Execute the Django migration and create the project tables
Install MySql Server
The installation process is different on different systems but this phase should not be a blocking point because Unix systems provide by default a MySql server and for Windows, we can use a visual installer. For more information please access the download page and select the installer that matches your operating system:
- MySql — official website
- MySql Downloads page
Install the Python Driver
To successfully access the Mysql Engine, Django needs a driver (aka a connector) to translate the Python queries to pure SQL instructions.
$ pip install mysqlclient
Enter fullscreen mode
Exit fullscreen mode
The above instruction will install the Python MySql driver globally in the system. Another way is to use a virtual environment
that sandboxes the installation.
$ # Create and activate the virtual environment
$ virtualenv env
$ source env/bin/activate
$
$ # install the mysql driver
$ pip install mysqlclient
Enter fullscreen mode
Exit fullscreen mode
Create the MySql Database
During the initial setup, Django creates the project tables but cannot create the database. To have a usable project we need the database credentials used later by the Django project. The database can be created visually using a database tool (like MySQL Workbench) or using the terminal:
CREATE DATABASE mytestdb;
Enter fullscreen mode
Exit fullscreen mode
Create a new MySql user
CREATE USER 'test'@'localhost' IDENTIFIED BY 'Secret_1234';
Enter fullscreen mode
Exit fullscreen mode
Grant all privileges to the newly created user
GRANT ALL PRIVILEGES ON `mytestdb` . * TO 'test'@'localhost';
FLUSH PRIVILEGES;
Enter fullscreen mode
Exit fullscreen mode
Update Django Settings
Once the MySql database is created we can move on and update the project settings to use a MySql server.
# File: core/settings.py
...
DATABASES = {
'default': {
'ENGINE' : 'django.db.backends.mysql', # <-- UPDATED line
'NAME' : 'mytestdb', # <-- UPDATED line
'USER' : 'test', # <-- UPDATED line
'PASSWORD': 'Secret_1234', # <-- UPDATED line
'HOST' : 'localhost', # <-- UPDATED line
'PORT' : '3306',
}
}
...
Enter fullscreen mode
Exit fullscreen mode
Start the project
The next step in our simple tutorial is to run the Django migration that will create all necessary tables.
$ # Create tables
$ python manage.py makemigrations
$ python manage.py migrate
Enter fullscreen mode
Exit fullscreen mode
Start the Django project
$ # Start the application (development mode)
$ python manage.py runserver
Enter fullscreen mode
Exit fullscreen mode
At this point, Django should be successfully connected to the Mysql Server and we can check the database and list the newly created tables during the database migration.
Thanks for reading! For more resources feel free to access:
- Django Dashboards — a curated index with simple starters
- Free Dashboards — open-source projects crafted in different technologies (Flask, Django, React)
🌚 Friends don’t let friends browse without dark mode.
Just kidding, it’s a personal preference. But you can change your theme, font, etc. in your settings.
The more you know. 🌈
Read next
Improving the performance of styled components with native CSS features
Ondrej Sevcik — Jan 28
How to implement a .NET Core DbConnectionFactory?
Daryl Young — Jan 6
51 AI tools you should be using for life, programming, content creation and everything else
Andrew Baisden — Jan 14
React useRef() 🪝
Mihir Chhatre — Jan 28
Once unpublished, all posts by sm0ke will become hidden and only accessible to themselves.
If sm0ke is not suspended, they can still re-publish their posts from their dashboard.
Note:
Once unpublished, this post will become invisible to the public and only accessible to Sm0ke.
They can still re-publish the post if they are not suspended.
Thanks for keeping DEV Community 👩💻👨💻 safe. Here is what you can do to flag sm0ke:
Make all posts by sm0ke less visible
sm0ke consistently posts content that violates DEV Community 👩💻👨💻’s
code of conduct because it is harassing, offensive or spammy.
Содержание
- Управление базой данных с помощью Django
- SQLite
- PostgreSQL
- MySql
- 1. Создайте новую базу данных в PhpMyAdmin.
- 2. Соединение нашего проекта helloworld Django с нашим клиентом Mysql
- 3. Установите клиент Mysql.
- 4. Перенесите свой проект.
Управление базой данных с помощью Django
Django официально поддерживает пять баз данных.
- PostgreSQL
- MariaDB
- MySQL
- Oracle
- SQLite
В этом блоге я объясняю, как подключить Django PostgreSQL, Mysql, and SQLite
к базе данных. Я уже создал проект helloworld
на Django. Если вам нужна помощь в создании базового приложения Django, загляните в мой предыдущий блог (Приложение Hello World с Django).
SQLite
SQLite — это база данных с открытым исходным кодом, которая помогает взаимодействовать с реляционными базами данных. SQLite хранится в одном файле. Это упрощает совместное использование баз данных. По умолчанию Django использует базу данных SQLite.
- Чтобы подключиться к базе данных SQLite, убедитесь, что у вас есть
db.sqlite3
файл в домашнем каталоге.
2. Теперь откройте файл helloworld/settings.py
. Прокрутите вниз до раздела базы данных. Вы можете увидеть что-то вроде этого. Здесь мы инициализируем все учетные данные базы данных. Если вы не видите ничего подобного, добавьте вручную приведенный ниже код в раздел базы данных.
# Database # https://docs.djangoproject.com/en/1.11/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), } }
3. Теперь все готово.
(hello-world-django) bash-3.2$ python3 manage.py migrate
С помощью этой команды все миграции будут применены, и вы сможете начать сборку своего приложения.
4. Проверить, созданы ли базы данных. Просто используйте команду ниже
(hello-world-django) bash-3.2$ sqlite3 db.sqlite3 SQLite version 3.28.0 2019-04-15 14:49:49 Enter ".help" for usage hints. sqlite>
Теперь просто введите .tables
, чтобы просмотреть все созданные таблицы.
sqlite> .tables auth_group auth_user_user_permissions auth_group_permissions django_admin_log auth_permission django_content_type auth_user django_migrations auth_user_groups django_session
PostgreSQL
PostgreSQL — это система управления реляционными базами данных с открытым исходным кодом, которая отличается высоким уровнем устойчивости, целостности и корректности. PostgreSQL используется как хранилище баз данных для многих мобильных и веб-приложений. Он также используется во многих аналитических приложениях. PostgreSQL идеально подходит для науки о данных. Он обеспечивает хорошую поддержку и гибкость для работы с большими данными. Для работы с PostgreSQL у вас должен быть любой из клиентов PostgreSQL. Я использую pgAdmin.
- Создайте новую базу данных в pgAdmin.
2. Соединяем наш helloworld
проект Django с нашим PostgreSQL.
Установите psycopg2. Psycopg2 — это адаптер базы данных, обычно используемый для языка программирования Python.
(hello-world-django) bash-3.2$ pip install psycopg2
Теперь откройте файл helloworld/settings.py
. Прокрутите до раздела базы данных. Там вы должны увидеть приведенный ниже код.
# Database # https://docs.djangoproject.com/en/1.11/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), } }
Теперь просто замените приведенный выше код нашими учетными данными для подключения к pgAdmin. Обновленный код должен выглядеть так, как показано ниже.
# Database # https://docs.djangoproject.com/en/1.11/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql_psycopg2', 'NAME': 'CURD-Django', #Database Name 'USER': 'postgres', #Your Postgresql user 'PASSWORD': 'admin', #Your Postgresql password 'HOST': '127.0.0.1', 'PORT': '5432', } }
3. Перенесите свой проект. По умолчанию Django предоставляет некоторые миграции.
(hello-world-django) bash-3.2$ python3 manage.py migrate Operations to perform: Apply all migrations: admin, auth, contenttypes, sessions Running migrations: Applying contenttypes.0001_initial... OK Applying auth.0001_initial... OK Applying admin.0001_initial... OK Applying admin.0002_logentry_remove_auto_add... OK Applying admin.0003_logentry_add_action_flag_choices... OK Applying contenttypes.0002_remove_content_type_name... OK Applying auth.0002_alter_permission_name_max_length... OK Applying auth.0003_alter_user_email_max_length... OK Applying auth.0004_alter_user_username_opts... OK Applying auth.0005_alter_user_last_login_null... OK Applying auth.0006_require_contenttypes_0002... OK Applying auth.0007_alter_validators_add_error_messages... OK Applying auth.0008_alter_user_username_max_length... OK Applying auth.0009_alter_user_last_name_max_length... OK Applying auth.0010_alter_group_name_max_length... OK Applying auth.0011_update_proxy_permissions... OK Applying auth.0012_alter_user_first_name_max_length... OK Applying sessions.0001_initial... OK
После успешной миграции вы должны увидеть такую схему базы данных.
MySql
База данных MySQL также широко используется в отрасли. Mysql также является системой управления реляционными базами данных. Mysql SQL широко используется в приложениях электронной коммерции, хранилищ данных и ведения журналов. Mysql — это веб-база данных. Создание базы данных с помощью Mysql в Django аналогично тому, что мы сделали для PostgreSQL. Здесь я использую PhpMyAdmin, который является клиентом Mysql.
1. Создайте новую базу данных в PhpMyAdmin.
2. Соединение нашего проекта helloworld Django с нашим клиентом Mysql
Теперь откройте файл helloworld/settings.py
. Прокрутите до раздела базы данных. Там вы должны увидеть приведенный ниже код.
# Database # https://docs.djangoproject.com/en/1.11/ref/settings/#databases DATABASES = { 'default': { 'ENGINE': 'django.db.backends.sqlite3', 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), } }
Теперь мы должны заменить приведенный выше код нашими учетными данными для подключения к Mysql. Обновленный код должен выглядеть так, как показано ниже.
# Database # https://docs.djangoproject.com/en/1.11/ref/settings/#databases] DATABASES = { 'default': { 'ENGINE': 'django.db.backends.mysql', #Mysql Client Adapter 'NAME': 'CURD-django', #Database Name 'USER': 'root', #Your Postgresql user 'PASSWORD': 'root', #Your Postgresql password 'HOST': '127.0.0.1', 'PORT': '3306', } }
3. Установите клиент Mysql.
Мы инициализировали настройки адаптера. Но еще не скачал. Загрузите клиент MySQL с командой.
(hello-world-django) bash-3.2$ pip install mysqlclient
После установки откройте файл helloworld/__init__.py
и добавьте в него приведенный ниже код.
import pymysql pymysql.install_as_MySQLdb()
4. Перенесите свой проект.
(hello-world-django) bash-3.2$ python3 manage.py migrate Operations to perform: Apply all migrations: admin, auth, contenttypes, sessions Running migrations: Applying contenttypes.0001_initial... OK Applying auth.0001_initial... OK Applying admin.0001_initial... OK Applying admin.0002_logentry_remove_auto_add... OK Applying admin.0003_logentry_add_action_flag_choices... OK Applying contenttypes.0002_remove_content_type_name... OK Applying auth.0002_alter_permission_name_max_length... OK Applying auth.0003_alter_user_email_max_length... OK Applying auth.0004_alter_user_username_opts... OK Applying auth.0005_alter_user_last_login_null... OK Applying auth.0006_require_contenttypes_0002... OK Applying auth.0007_alter_validators_add_error_messages... OK Applying auth.0008_alter_user_username_max_length... OK Applying auth.0009_alter_user_last_name_max_length... OK Applying auth.0010_alter_group_name_max_length... OK Applying auth.0011_update_proxy_permissions... OK Applying auth.0012_alter_user_first_name_max_length... OK Applying sessions.0001_initial... OK
Теперь вы должны увидеть схему базы данных по умолчанию в PhpMyAdmin.
Удачного кодирования!
Improve Article
Save Article
Improve Article
Save Article
Django is a Python-based web framework that allows you to quickly create efficient web applications. It is also called batteries included framework because Django provides built-in features for everything including Django Admin Interface, default database – SQLlite3, etc.
Installation
Install the Mysql database, After downloading install the setup and set the admin and password.
https://dev.mysql.com/downloads/installer/
Install Django
pip install django
Then install another library to use the MySQL database
pip install mysqlclient
Steps to connect MySQL to Django
Step 1: Create a new project
django-admin startproject MyDB
Step 2: Move to the MyDB folder.
cd MyDB
Step 3: Create a MySql database.
Step 4: Update the settings.py
Open settings.py here inside the DATABASES variable configure MySQL database values, and add values of your database.
Python3
DATABASES
=
{
'default'
: {
'ENGINE'
:
'django.db.backends.mysql'
,
'NAME'
:
'mydb'
,
'USER'
:
'root'
,
'PASSWORD'
:
'admin'
,
'HOST'
:
'localhost'
,
'PORT'
:
'3306'
,
}
}
First, we have replaced the ‘django.db.backends.sqlite3’ to ‘django.db.backends.mysql’. This is basically indicating we shift SQLite to MySQL database.
- NAME: It indicates the name of the database we want to connect.
- USER: The MYSQL username is the one who has access to the database and manages it.
- PASSWORD: It is the password of the database.
- HOST: It is indicated by “127.0.0.1” and “PORT” “3306” that the MySQL database is accessible at hostname “0.0.1” and on port “3306.”
Step 5: Run the server.
python manage.py runserver
Step 6: Run the migration command
python manage.py makemigrations
python manage.py migrate
29 сентября, 2017 12:28 пп
15 895 views
| Комментариев нет
Python, Ubuntu
Django – это свободный и открытый веб-фреймворк Python, который поддерживает масштабируемость, повторное использование и быструю разработку кода.
В данном мануале вы узнаете, как создать основу для блога и подключить его к базе данных MySQL. Для этого нужно создать «скелет» веб-приложения с помощью django-admin, затем создать БД MySQL и подключить веб-приложение к базе данных.
Требования
- Сервер Ubuntu 16.04, настроенный согласно этому руководству.
- Предварительно установленный фреймворк Django (инструкции по установке и настройке среды разработки вы найдете здесь).
- MySQL (установить эту СУБД вам поможет мануал Установка последней версии MySQL в Ubuntu 16.04).
1: Создание каркаса проекта Django
Чтобы заложить основу приложения, нужно сгенерировать скелет проекта, используя команду django-admin. Этот каркас станет основой приложения для блога.
Перейдите в домашний каталог:
cd ~
Просмотрите его содержимое:
ls
Если вы выполнили руководство по установке Django, вы увидите такой каталог:
test_django_app
Это скелет проекта, который был сгенерирован для проверки установки.
Этот каталог вам не подойдет. Создайте новый каталог для приложения блога. Выберите для него описательное имя; в руководстве используется my_blog_app.
mkdir my_blog_app
Перейдите в новый каталог:
cd my_blog_app
Чтобы сгенерировать проект, запустите команду:
django-admin startproject blog
Чтобы убедиться, что все выполнено правильно, попробуйте перейти в каталог blog/:
cd blog
Каталог blog/ должен появиться в текущем каталоге ~/my_blog_app/ после запуска команды django-admin.
Запустите ls, чтобы убедиться, что все необходимые элементы были созданы. Должен быть каталог blog и файл manage.py:
blog manage.py
2: Настройка проекта
Сгенерировав проект, вы создали файл settings.py.
Чтобы блог использовал правильное время, связанное с вашим часовым поясом, отредактируйте файл settings.py. Этот список часовых поясов может вам помочь. В данном примере используется пояс America/New_York.
Откройте каталог, в котором находится нужный файл:
cd ~/my_blog_app/blog/blog/
Откройте файл settings.py:
nano settings.py
Найдите поле TIME_ZONE:
...
# Internationalization
# https://docs.djangoproject.com/en/1.11/topics/i18n/
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'UTC'
USE_I18N = True
USE_L10N = True
USE_TZ = True
...
Измените часовой пояс:
...
# Internationalization
# https://docs.djangoproject.com/en/1.11/topics/i18n/
LANGUAGE_CODE = 'en-us'
TIME_ZONE = 'America/New_York'
USE_I18N = True
...
Не закрывайте файл – далее нужно будет добавить путь к статическим файлам. Файлы, которые обслуживаются веб-приложением Django, называются статическими файлами. К ним относятся любые файлы для отображения веб-страницы, включая JavaScript, CSS и изображения.
Перейдите в конец settings.py и найдите STATIC_ROOT.
...
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/1.11/howto/static-files/
STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')
Теперь, когда часовой пояс и путь для статических файлов указаны правильно, нужно добавить ваш IP-адрес в список разрешенных хостов. Перейдите к строке ALLOWED_HOSTS, которая находится в верхней части файла settings.py.
...
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
ALLOWED_HOSTS = ['your server IP address']
# Application definition
...
Добавьте в скобки свой IP-адрес, взяв его в одинарные кавычки.
Теперь сохраните и закройте файл.
3: Установка соединения с базой данных MySQL
Чтобы использовать MySQL в проекте, понадобится соединительная библиотека Python 3, совместимая с Django. Установите соединитель баз данных mysqlclient, который является форком MySQLdb.
Согласно документации mysqlclient, «MySQLdb – это поточно-совместимый интерфейс к популярному серверу базы данных MySQL, который предоставляет API баз данных Python». Основное преимущество заключается в том, что mysqlclient поддерживает Python 3.
Для начала установите python3-dev.
sudo apt-get install python3-dev
Затем установите заголовки и библиотеки Python и MySQL.
sudo apt-get install python3-dev libmysqlclient-dev
Когда увидите такое сообщение:
After this operation, 11.9 MB of additional disk space will be used.
Do you want to continue? [Y/n]
Нажмите y и ENTER, чтобы продолжить.
С помощью pip3 установите библиотеку mysqlclient из PyPi:
sudo pip3 install mysqlclient
Команда выведет на экран следующее:
successfully installed mysqlclient
Collecting mysqlclient
Downloading mysqlclient-1.3.10.tar.gz (82kB)
100% |████████████████████████████████| 92kB 6.7MB/s
Building wheels for collected packages: mysqlclient
Running setup.py bdist_wheel for mysqlclient ... done
Stored in directory: /root/.cache/pip/wheels/32/50/86/c7be3383279812efb2378c7b393567569a8ab1307c75d40c5a
Successfully built mysqlclient
Installing collected packages: mysqlclient
Successfully installed mysqlclient-1.3.10
4: Создание базы данных
На данный момент у вас есть каркас приложения и соединитель mysqlclient. Теперь можно настроить бэкэнд Django для поддержки MySQL.
Сначала инициируйте сервис MySQL:
systemctl status mysql.service
starting mysql.service
mysql.service - MySQL Community Server
Loaded: loaded (/lib/systemd/system/mysql.service; enabled; vendor preset: enabled)
Active: active (running) since Sat 2017-08-19 11:59:33 UTC; 1min 44s ago
Main PID: 26525 (mysqld)
CGroup: /system.slice/mysql.service
└─26525 /usr/sbin/mysqld
Теперь вы можете войти в MySQL с помощью учетных данных, используя следующую команду. Флаг -u позволяет указать пользователя, а -p включает запрос пароля MySQL:
mysql -u db_user -p
Примечание: Вместо db_user укажите имя вашего пользователя базы данных.
Когда появится строка:
Enter password:
Укажите пароль своего пользователя БД. После этого на экране появится:
Welcome to the MySQL monitor. Commands end with ; or g.
Your MySQL connection id is 6
Server version: 5.7.19-0ubuntu0.16.04.1 (Ubuntu)
Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.
Type 'help;' or 'h' for help. Type 'c' to clear the current input statement.
Запросите список текущих баз данных MySQL:
SHOW DATABASES;
Команда выведет имена всех БД, которые существуют на данный момент:
+-------------------+
| Database |
+-------------------+
| information_schema|
| mysql |
| performance_schema|
| sys |
+-------------------+
4 rows in set (0.00 sec)
Примечание: Если при попытке подключиться вы получили ошибку, убедитесь, что правильно ввели пароль и установили MySQL. Также можно проконсультироваться с руководством по установке и настройке MySQL.
По умолчанию в MySQL есть 4 БД: information_schema, MySQL, performance_schema и sys. Не трогайте их – они содержат важную для сервера MySQL информацию.
Теперь создайте исходную базу данных, в которой будут храниться данные блога.
Для этого запустите эту команду, указав описательное имя для новой БД.
CREATE DATABASE blog_data;
После успешного создания базы данных вы увидите следующий результат:
Query OK, 1 row affected (0.00 sec)
Примечание: Если вы видите на экране такой вывод:
database creation failed
ERROR 1007 (HY000): Can't create database blog_data; database exists
значит, БД с таким именем уже существует. Если же вы видите следующую ошибку MySQL:
database creation failed
ERROR 1064 (42000): You have an error in your SQL syntax;
это означает, что в команде допущена синтаксическая ошибка. Убедитесь, что вы ввели команду точно так, как показано выше.
Снова просмотрите список доступных БД:
SHOW DATABASES;
В списке должна появиться новая БД blog_data:
+——————-+
| Database |
+——————-+
| information_schema|
| blog_data |
| MySQL |
| performance_schema|
| sys |
+——————-+
5 rows in set (0.00 sec)
База данных для блога полностью готова.
Чтобы выйти из MySQL, нажмите CTRL + D.
5: Настройка соединения базы данных MySQL и приложения
Теперь нужно добавить учетные данные БД в настройки приложения Django.
Примечание: Важно помнить, что настройки соединения согласно документации Django используются в следующем порядке:
– опции
– имя, пользователь, пароль, хост, порт
– файлы параметров MySQL.
Внесите все необходимые поправки.
Перейдите в файл settings.py и замените все текущие строки DATABASES следующими строками. Приложение должно знать, как использовать MySQL в качестве базы данных и из какого файла читать учетные данные для подключения к БД:
# Database
# https://docs.djangoproject.com/en/1.11/ref/settings/#databases
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'OPTIONS': {
'read_default_file': '/etc/mysql/my.cnf',
},
}
}
...
Затем нужно указать в конфигурационном файле учетные данные MySQL. Откройте файл в nano и добавьте следующую информацию:
sudo nano /etc/mysql/my.cnf
...
[client]
database = db_name
user = db_user
password = db_password
default-character-set = utf8
utf8 устанавливается как шифрование по умолчанию, это обычный способ кодирования данных Unicode в MySQL.
После этого перезапустите MySQL:
systemctl daemon-reload
systemctl restart mysql
Это займет несколько минут.
6: Проверка соединения между приложением и БД MySQL
Теперь нужно убедиться, что приложение Django может подключиться к MySQL. Для этого просто запустите сервер. Если запустить его не получится, значит, соединение не получается создать. В противном случае соединение работает.
Перейдите в следующий каталог:
cd ~/my_blog_app/blog/
Запустите команду:
python3 manage.py runserver your-server-ip:8000
Команда выведет:
Performing system checks...
System check identified no issues (0 silenced).
You have 13 unapplied migration(s). Your project may not work properly until you apply the migrations for app(s): admin, auth, contenttypes, sessions.
Run 'python manage.py migrate' to apply them.
August 19, 2017 - 15:45:39
Django version 1.11.4, using settings 'blog.settings'
Starting development server at http://your-server-ip:8000/
Quit the server with CONTROL-C.
Следуя инструкциям из вывода, перейдите по следующей ссылке:
http://your-server-ip:8000/
чтобы просмотреть веб-приложение и убедиться, что оно работает правильно. Вы должны увидеть страницу:
It worked!
Congratulations on your first Django powered page.
Если такая страница появилась – приложение Django работает правильно!
Tags: Django, MySQL, Ubuntu 16.04