mirror of
https://github.com/django/django.git
synced 2025-11-03 05:13:23 +00:00
82 lines
3 KiB
Text
82 lines
3 KiB
Text
=============================
|
|
GeoDjango Management Commands
|
|
=============================
|
|
|
|
``inspectdb``
|
|
=============
|
|
|
|
.. describe:: django-admin inspectdb
|
|
|
|
When :mod:`django.contrib.gis` is in your :setting:`INSTALLED_APPS`, the
|
|
:djadmin:`inspectdb` management command is overridden with one from GeoDjango.
|
|
The overridden command is spatially-aware, and places geometry fields in the
|
|
auto-generated model definition, where appropriate.
|
|
|
|
``ogrinspect``
|
|
==============
|
|
|
|
.. django-admin:: ogrinspect data_source model_name
|
|
|
|
The ``ogrinspect`` management command will inspect the given OGR-compatible
|
|
:class:`~django.contrib.gis.gdal.DataSource` (e.g., a shapefile) and will
|
|
output a GeoDjango model with the given model name. There's a detailed example
|
|
of using ``ogrinspect`` :ref:`in the tutorial <ogrinspect-intro>`.
|
|
|
|
.. django-admin-option:: --blank BLANK
|
|
|
|
Use a comma separated list of OGR field names to add the ``blank=True``
|
|
keyword option to the field definition. Set with ``true`` to apply
|
|
to all applicable fields.
|
|
|
|
.. django-admin-option:: --decimal DECIMAL
|
|
|
|
Use a comma separated list of OGR float fields to generate
|
|
:class:`~django.db.models.DecimalField` instead of the default
|
|
:class:`~django.db.models.FloatField`. Set to ``true`` to apply to all
|
|
OGR float fields.
|
|
|
|
.. django-admin-option:: --geom-name GEOM_NAME
|
|
|
|
Specifies the model attribute name to use for the geometry field.
|
|
Defaults to ``'geom'``.
|
|
|
|
.. django-admin-option:: --layer LAYER_KEY
|
|
|
|
The key for specifying which layer in the OGR
|
|
:class:`~django.contrib.gis.gdal.DataSource` source to use.
|
|
Defaults to 0 (the first layer). May be an integer or a string identifier
|
|
for the :class:`~django.contrib.gis.gdal.Layer`. When inspecting databases,
|
|
``layer`` is generally the table name you want to inspect.
|
|
|
|
.. django-admin-option:: --mapping
|
|
|
|
Automatically generate a mapping dictionary for use with
|
|
:class:`~django.contrib.gis.utils.LayerMapping`.
|
|
|
|
.. django-admin-option:: --multi-geom
|
|
|
|
When generating the geometry field, treat it as a geometry collection.
|
|
For example, if this setting is enabled then a
|
|
:class:`~django.contrib.gis.db.models.MultiPolygonField` will be placed
|
|
in the generated model rather than
|
|
:class:`~django.contrib.gis.db.models.PolygonField`.
|
|
|
|
.. django-admin-option:: --name-field NAME_FIELD
|
|
|
|
Generates a ``__str__`` routine (``__unicode__`` on Python 2) on the model
|
|
that will return the given field name.
|
|
|
|
.. django-admin-option:: --no-imports
|
|
|
|
Suppresses the ``from django.contrib.gis.db import models`` import statement.
|
|
|
|
.. django-admin-option:: --null NULL
|
|
|
|
Use a comma separated list of OGR field names to add the ``null=True``
|
|
keyword option to the field definition. Set with ``true`` to apply to
|
|
all applicable fields.
|
|
|
|
.. django-admin-option:: --srid SRID
|
|
|
|
The SRID to use for the geometry field. If not set, ``ogrinspect`` attempts
|
|
to automatically determine of the SRID of the data source.
|