.. auto generated by export_reference.py ******** Database ******** |development| |area| A plethora, a cornucopia, a totally ridiculous number of models, fields, and other resources that may be used as a starting point for your database. **Version:** 0.4.0-d .. include:: _includes/db.rst The resources provided by SuperDjango DB general consist of abstract models that may be used for various common (and some not so common) purposes. .. note:: SuperDjango DB does *not* (and will never) provide concrete models. .. _db-db-archived-developer: Archived Models =============== |development| |library| Provides support for a simple archive workflow. Component Reference: :ref:`db-db-archived` admin ----- .. automodule:: superdjango.db.archived.admin :members: :show-inheritance: :special-members: __init__ filters ------- .. automodule:: superdjango.db.archived.filters :members: :show-inheritance: :special-members: __init__ managers -------- .. automodule:: superdjango.db.archived.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.archived.models :members: :show-inheritance: :special-members: __init__ .. _db-db-audit-developer: Audit Models ============ |development| |library| Adds support for added by/modified by/viewed by (and added/modified/viewed date/time) to a model. Component Reference: :ref:`db-db-audit` mixins ------ .. automodule:: superdjango.db.audit.mixins :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.audit.models :members: :show-inheritance: :special-members: __init__ admin ----- .. automodule:: superdjango.db.audit.admin :members: :show-inheritance: :special-members: __init__ filters ------- .. automodule:: superdjango.db.audit.filters :members: :show-inheritance: :special-members: __init__ utils ----- .. automodule:: superdjango.db.audit.utils :members: :show-inheritance: :special-members: __init__ .. _db-db-calculated-developer: Calculated Fields ================= |planning| |library| Provides support for standard calculated fields as well as creating your own calculated fields. Component Reference: :ref:`db-db-calculated` fields ------ .. automodule:: superdjango.db.calculated.fields :members: :show-inheritance: :special-members: __init__ .. _db-db-completed-developer: Completed Models ================ |development| |library| Provides the ability to mark a record as complete. Component Reference: :ref:`db-db-completed` admin ----- .. automodule:: superdjango.db.completed.admin :members: :show-inheritance: :special-members: __init__ filters ------- .. automodule:: superdjango.db.completed.filters :members: :show-inheritance: :special-members: __init__ managers -------- .. automodule:: superdjango.db.completed.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.completed.models :members: :show-inheritance: :special-members: __init__ .. _db-db-datetime-developer: Date/Time Models ================ |development| |library| Fields and abstract models for working with dates and datetimes. Component Reference: :ref:`db-db-datetime` fields ------ .. automodule:: superdjango.db.datetime.fields :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.datetime.models :members: :show-inheritance: :special-members: __init__ .. _db-db-default-developer: Default Models ============== |experimental| |library| Provides the ability to mark a record as the default of it's type. Component Reference: :ref:`db-db-default` admin ----- .. automodule:: superdjango.db.default.admin :members: :show-inheritance: :special-members: __init__ managers -------- .. automodule:: superdjango.db.default.managers :members: :show-inheritance: :special-members: __init__ mixins ------ .. automodule:: superdjango.db.default.mixins :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.default.models :members: :show-inheritance: :special-members: __init__ .. _db-db-displayed-developer: Displayed Models ================ |alpha| |library| Provides a consistent means of acquiring the human friendly name of a model instance. Component Reference: :ref:`db-db-displayed` mixins ------ .. automodule:: superdjango.db.displayed.mixins :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.displayed.models :members: :show-inheritance: :special-members: __init__ .. _db-db-eav-developer: EAV Models ========== |experimental| |library| Support for the Entity Attribute Value (EAV) approach to adding custom fields. Component Reference: :ref:`db-db-eav` admin ----- .. automodule:: superdjango.db.eav.admin :members: :show-inheritance: :special-members: __init__ constants --------- .. automodule:: superdjango.db.eav.constants :members: :show-inheritance: :special-members: __init__ mappings -------- .. automodule:: superdjango.db.eav.mappings :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.eav.models :members: :show-inheritance: :special-members: __init__ ui -- .. automodule:: superdjango.db.eav.ui :members: :show-inheritance: :special-members: __init__ .. _db-db-expiration-developer: Expiration Models ================= |planning| |library| Work with records that have an expiration date and time. Component Reference: :ref:`db-db-expiration` managers -------- .. automodule:: superdjango.db.expiration.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.expiration.models :members: :show-inheritance: :special-members: __init__ .. _db-db-history-developer: History Models ============== |planning| |library| Abstract model for implementing audit history on models. Component Reference: :ref:`db-db-history` admin ----- .. automodule:: superdjango.db.history.admin :members: :show-inheritance: :special-members: __init__ constants --------- .. automodule:: superdjango.db.history.constants :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.history.models :members: :show-inheritance: :special-members: __init__ ui -- .. automodule:: superdjango.db.history.ui :members: :show-inheritance: :special-members: __init__ utils ----- .. automodule:: superdjango.db.history.utils :members: :show-inheritance: :special-members: __init__ .. _db-db-locked-developer: Locked Models ============= |planning| |library| Work with records that have been locked from update or delete. Component Reference: :ref:`db-db-locked` admin ----- .. automodule:: superdjango.db.locked.admin :members: :show-inheritance: :special-members: __init__ managers -------- .. automodule:: superdjango.db.locked.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.locked.models :members: :show-inheritance: :special-members: __init__ .. _db-db-lookups-developer: Lookup Models ============= |development| |library| Provides pre-defined models for managing lookup (aka validation) data. Component Reference: :ref:`db-db-lookups` admin ----- .. automodule:: superdjango.db.lookups.admin :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.lookups.models :members: :show-inheritance: :special-members: __init__ .. _db-db-owned-developer: Owned Models ============ |development| |library| Provides a random character field. Component Reference: :ref:`db-db-owned` admin ----- .. automodule:: superdjango.db.owned.admin :members: :show-inheritance: :special-members: __init__ filters ------- .. automodule:: superdjango.db.owned.filters :members: :show-inheritance: :special-members: __init__ managers -------- .. automodule:: superdjango.db.owned.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.owned.models :members: :show-inheritance: :special-members: __init__ .. _db-db-parent-developer: Parent-Tree Models ================== |experimental| |library| Provides a simple model for implementing parent-child-sibling relationships. Component Reference: :ref:`db-db-parent` models ------ .. automodule:: superdjango.db.parent.models :members: :show-inheritance: :special-members: __init__ utils ----- .. automodule:: superdjango.db.parent.utils :members: :show-inheritance: :special-members: __init__ .. _db-db-polymorphic-developer: Polymorphic Models ================== |experimental| |library| Managers and mixins for polymorphic behavior. Component Reference: :ref:`db-db-polymorphic` managers -------- .. automodule:: superdjango.db.polymorphic.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.polymorphic.models :members: :show-inheritance: :special-members: __init__ utils ----- .. automodule:: superdjango.db.polymorphic.utils :members: :show-inheritance: :special-members: __init__ .. _db-db-primary-developer: Primary Models ============== |experimental| |library| Provides support for a publishing workflow. Component Reference: :ref:`db-db-primary` admin ----- .. automodule:: superdjango.db.primary.admin :members: :show-inheritance: :special-members: __init__ managers -------- .. automodule:: superdjango.db.primary.managers :members: :show-inheritance: :special-members: __init__ mixins ------ .. automodule:: superdjango.db.primary.mixins :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.primary.models :members: :show-inheritance: :special-members: __init__ .. _db-db-published-developer: Published Models ================ |development| |library| Provides support for a publishing workflow. Component Reference: :ref:`db-db-published` admin ----- .. automodule:: superdjango.db.published.admin :members: :show-inheritance: :special-members: __init__ filters ------- .. automodule:: superdjango.db.published.filters :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.published.models :members: :show-inheritance: :special-members: __init__ .. _db-db-random-developer: Random Models ============= |experimental| |library| Provides a random character field. Component Reference: :ref:`db-db-random` fields ------ .. automodule:: superdjango.db.random.fields :members: :show-inheritance: :special-members: __init__ .. _db-db-resolved-developer: Resolved Models =============== |development| |library| Provides support for a resolution workflow. Component Reference: :ref:`db-db-resolved` admin ----- .. automodule:: superdjango.db.resolved.admin :members: :show-inheritance: :special-members: __init__ filters ------- .. automodule:: superdjango.db.resolved.filters :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.resolved.models :members: :show-inheritance: :special-members: __init__ .. _db-db-reviewed-developer: Reviewed Models =============== |development| |library| Provides support for a review workflow. Component Reference: :ref:`db-db-reviewed` admin ----- .. automodule:: superdjango.db.reviewed.admin :members: :show-inheritance: :special-members: __init__ filters ------- .. automodule:: superdjango.db.reviewed.filters :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.reviewed.models :members: :show-inheritance: :special-members: __init__ .. _db-db-revised-developer: Revised Models ============== |experimental| |library| A simple package that allows saving revisions of a record. Component Reference: :ref:`db-db-revised` managers -------- .. automodule:: superdjango.db.revised.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.revised.models :members: :show-inheritance: :special-members: __init__ .. _db-db-sorted-developer: Sorted Models ============= |experimental| |library| A model and utilities for implementing record sortation. Component Reference: :ref:`db-db-sorted` models ------ .. automodule:: superdjango.db.sorted.models :members: :show-inheritance: :special-members: __init__ utils ----- .. automodule:: superdjango.db.sorted.utils :members: :show-inheritance: :special-members: __init__ .. _db-db-slug-developer: Slug Fields =========== |experimental| |library| Provides support for a automatic slug field. Component Reference: :ref:`db-db-slug` fields ------ .. automodule:: superdjango.db.slug.fields :members: :show-inheritance: :special-members: __init__ utils ----- .. automodule:: superdjango.db.slug.utils :members: :show-inheritance: :special-members: __init__ .. _db-db-timed-developer: Timed Models ============ |experimental| |library| Create records that incorporate start/stop timing functionality. Component Reference: :ref:`db-db-timed` models ------ .. automodule:: superdjango.db.timed.models :members: :show-inheritance: :special-members: __init__ .. _db-db-trashed-developer: Trashed Models ============== |experimental| |library| Provides a workflow for trashed, but not deleted, models. Component Reference: :ref:`db-db-trashed` managers -------- .. automodule:: superdjango.db.trashed.managers :members: :show-inheritance: :special-members: __init__ models ------ .. automodule:: superdjango.db.trashed.models :members: :show-inheritance: :special-members: __init__