From ad8e55db9b0856573bfe740c350bfb39c7ca388e Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Sun, 17 Jul 2005 15:53:56 +0000 Subject: [PATCH] Added notes to documentation that MySQL support has not been comprehensively tested. Thanks, Simon! git-svn-id: http://code.djangoproject.com/svn/django/trunk@148 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/install.txt | 7 +++++++ docs/overview.txt | 4 ++-- docs/tutorial01.txt | 6 ++++++ 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/install.txt b/docs/install.txt index f2e10d5807..df12f5fc2e 100644 --- a/docs/install.txt +++ b/docs/install.txt @@ -29,6 +29,12 @@ If you plan to use Django's database API functionality, you'll need to make sure a database server is running. Django works with PostgreSQL_ (recommended) or MySQL_. +Note that MySQL support is a recent development, and Django hasn't been +comprehensively tested with that database. If you find any bugs in Django's +MySQL bindings, please file them in `Django's ticket system`_ so we can fix them +immediately. + + Additionally, you'll need to make sure your Python database bindings are installed. If you're using PostgreSQL, you'll need the psycopg_ package (version 1 -- not version 2, which is still in beta). If you're using @@ -36,6 +42,7 @@ MySQL, you'll need MySQLdb_. .. _PostgreSQL: http://www.postgresql.org/ .. _MySQL: http://www.mysql.com/ +.. _`Django's ticket system: http://code.djangoproject.com/report/1 .. _psycopg: http://initd.org/projects/psycopg1 .. _MySQLdb: http://sourceforge.net/projects/mysql-python diff --git a/docs/overview.txt b/docs/overview.txt index 242b5991ac..9e4327ef59 100644 --- a/docs/overview.txt +++ b/docs/overview.txt @@ -44,8 +44,8 @@ Install it Next, run the Django command-line utility. It'll create the database tables for you automatically, in the database specified in your Django settings. Django -works with PostgreSQL and MySQL, although other database adapters are on the -way:: +works best with PostgreSQL, although we've recently added beta MySQL +support and other database adapters are on the way:: django-admin.py install news diff --git a/docs/tutorial01.txt b/docs/tutorial01.txt index 27ef474ef8..516d095cc2 100644 --- a/docs/tutorial01.txt +++ b/docs/tutorial01.txt @@ -60,6 +60,11 @@ these settings to match your database's connection parameters: Do that with "``CREATE DATABASE database_name;``" within your database's interactive prompt.) +Also, note that MySQL support is a recent development, and Django hasn't been +comprehensively tested with that database. If you find any bugs in Django's +MySQL bindings, please file them in `Django's ticket system`_ so we can fix them +immediately. + Once you've done that, you need to tell Django which settings module you're currently using. Do that by setting an environment variable, ``DJANGO_SETTINGS_MODULE``. Here's how you do that in the Bash shell on Unix:: @@ -88,6 +93,7 @@ Now you're set to start doing work. You won't have to take care of this boring administrative stuff again. .. _`Python path`: http://docs.python.org/tut/node8.html#SECTION008110000000000000000 +.. _`Django's ticket system: http://code.djangoproject.com/report/1 Creating models ===============