Added note to docs/django-admin.txt about the examples using django-admin.txt but the examples being just as relevant for manage.py. Refs #3893

git-svn-id: http://code.djangoproject.com/svn/django/trunk@4964 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Adrian Holovaty 2007-04-09 01:44:26 +00:00
parent e34e433641
commit 099022c6aa
1 changed files with 36 additions and 32 deletions

View File

@ -29,6 +29,9 @@ Generally, when working on a single Django project, it's easier to use
``--settings`` command line option, if you need to switch between multiple ``--settings`` command line option, if you need to switch between multiple
Django settings files. Django settings files.
The command-line examples throughout this document use ``django-admin.py`` to
be consistent, but any example can use ``manage.py`` just as well.
Usage Usage
===== =====
@ -100,23 +103,23 @@ if you're ever curious to see the full list of defaults.
dumpdata [appname appname ...] dumpdata [appname appname ...]
------------------------------ ------------------------------
Output to standard output all data in the database associated with the named Output to standard output all data in the database associated with the named
application(s). application(s).
By default, the database will be dumped in JSON format. If you want the output By default, the database will be dumped in JSON format. If you want the output
to be in another format, use the ``--format`` option (e.g., ``format=xml``). to be in another format, use the ``--format`` option (e.g., ``format=xml``).
You may specify any Django serialization backend (including any user specified You may specify any Django serialization backend (including any user specified
serialization backends named in the ``SERIALIZATION_MODULES`` setting). serialization backends named in the ``SERIALIZATION_MODULES`` setting).
If no application name is provided, all installed applications will be dumped. If no application name is provided, all installed applications will be dumped.
The output of ``dumpdata`` can be used as input for ``loaddata``. The output of ``dumpdata`` can be used as input for ``loaddata``.
flush flush
----- -----
Return the database to the state it was in immediately after syncdb was Return the database to the state it was in immediately after syncdb was
executed. This means that all data will be removed from the database, any executed. This means that all data will be removed from the database, any
post-synchronization handlers will be re-executed, and the ``initial_data`` post-synchronization handlers will be re-executed, and the ``initial_data``
fixture will be re-installed. fixture will be re-installed.
@ -178,37 +181,37 @@ Django will search in three locations for fixtures:
3. In the literal path named by the fixture 3. In the literal path named by the fixture
Django will load any and all fixtures it finds in these locations that match Django will load any and all fixtures it finds in these locations that match
the provided fixture names. the provided fixture names.
If the named fixture has a file extension, only fixtures of that type If the named fixture has a file extension, only fixtures of that type
will be loaded. For example:: will be loaded. For example::
django-admin.py loaddata mydata.json django-admin.py loaddata mydata.json
would only load JSON fixtures called ``mydata``. The fixture extension would only load JSON fixtures called ``mydata``. The fixture extension
must correspond to the registered name of a serializer (e.g., ``json`` or must correspond to the registered name of a serializer (e.g., ``json`` or
``xml``). ``xml``).
If you omit the extension, Django will search all available fixture types If you omit the extension, Django will search all available fixture types
for a matching fixture. For example:: for a matching fixture. For example::
django-admin.py loaddata mydata django-admin.py loaddata mydata
would look for any fixture of any fixture type called ``mydata``. If a fixture would look for any fixture of any fixture type called ``mydata``. If a fixture
directory contained ``mydata.json``, that fixture would be loaded directory contained ``mydata.json``, that fixture would be loaded
as a JSON fixture. However, if two fixtures with the same name but different as a JSON fixture. However, if two fixtures with the same name but different
fixture type are discovered (for example, if ``mydata.json`` and fixture type are discovered (for example, if ``mydata.json`` and
``mydata.xml`` were found in the same fixture directory), fixture ``mydata.xml`` were found in the same fixture directory), fixture
installation will be aborted, and any data installed in the call to installation will be aborted, and any data installed in the call to
``loaddata`` will be removed from the database. ``loaddata`` will be removed from the database.
The fixtures that are named can include directory components. These The fixtures that are named can include directory components. These
directories will be included in the search path. For example:: directories will be included in the search path. For example::
django-admin.py loaddata foo/bar/mydata.json django-admin.py loaddata foo/bar/mydata.json
would search ``<appname>/fixtures/foo/bar/mydata.json`` for each installed would search ``<appname>/fixtures/foo/bar/mydata.json`` for each installed
application, ``<dirname>/foo/bar/mydata.json`` for each directory in application, ``<dirname>/foo/bar/mydata.json`` for each directory in
``FIXTURE_DIRS``, and the literal path ``foo/bar/mydata.json``. ``FIXTURE_DIRS``, and the literal path ``foo/bar/mydata.json``.
Note that the order in which fixture files are processed is undefined. However, Note that the order in which fixture files are processed is undefined. However,
@ -219,14 +222,14 @@ end of the transaction.
.. admonition:: MySQL and Fixtures .. admonition:: MySQL and Fixtures
Unfortunately, MySQL isn't capable of completely supporting all the Unfortunately, MySQL isn't capable of completely supporting all the
features of Django fixtures. If you use MyISAM tables, MySQL doesn't features of Django fixtures. If you use MyISAM tables, MySQL doesn't
support transactions or constraints, so you won't get a rollback if support transactions or constraints, so you won't get a rollback if
multiple transaction files are found, or validation of fixture data. multiple transaction files are found, or validation of fixture data.
If you use InnoDB tables, you won't be able to have any forward If you use InnoDB tables, you won't be able to have any forward
references in your data files - MySQL doesn't provide a mechanism to references in your data files - MySQL doesn't provide a mechanism to
defer checking of row constraints until a transaction is committed. defer checking of row constraints until a transaction is committed.
reset [appname appname ...] reset [appname appname ...]
--------------------------- ---------------------------
Executes the equivalent of ``sqlreset`` for the given appnames. Executes the equivalent of ``sqlreset`` for the given appnames.
@ -397,8 +400,8 @@ this command to install the default apps.
If you're installing the ``django.contrib.auth`` application, ``syncdb`` will If you're installing the ``django.contrib.auth`` application, ``syncdb`` will
give you the option of creating a superuser immediately. give you the option of creating a superuser immediately.
``syncdb`` will also search for and install any fixture named ``initial_data``. ``syncdb`` will also search for and install any fixture named ``initial_data``.
See the documentation for ``loaddata`` for details on the specification of See the documentation for ``loaddata`` for details on the specification of
fixture data files. fixture data files.
test test
@ -471,7 +474,7 @@ Example usage::
django-admin.py dumpdata --indent=4 django-admin.py dumpdata --indent=4
Specifies the number of spaces that will be used for indentation when Specifies the number of spaces that will be used for indentation when
pretty-printing output. By default, output will *not* be pretty-printed. pretty-printing output. By default, output will *not* be pretty-printed.
Pretty-printing will only be enabled if the indent option is provided. Pretty-printing will only be enabled if the indent option is provided.
@ -512,7 +515,8 @@ and `2` is verbose output.
------------ ------------
Example usage:: Example usage::
django-admin.py manage.py --adminmedia=/tmp/new-admin-style/
django-admin.py --adminmedia=/tmp/new-admin-style/
Tells Django where to find the various CSS and JavaScript files for the admin Tells Django where to find the various CSS and JavaScript files for the admin
interface when running the development server. Normally these files are served interface when running the development server. Normally these files are served