Home Explore Help
Sign In
zorun
/
django-postgresql-netfields
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 89c0c291bf
Branches Tags
django-postg...
/
README.rst

README.rst 2.1 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 
  1. Django PostgreSQL Netfields
    2. 

  2. ===========================
    3. 

  3. 

  4. This project is an attempt at making proper Django net related fields for
    5. 

  5. Django Currently the built in ``IPAddressField`` does not support IPv6 and uses
    6. 

  6. an inefficient ``HOST()`` cast in all lookups. Hopefully there experience from
    7. 

  7. this project can lead to a resolution of these issues upstream.
    8. 

  8. 

  9. In addition to the basic ``IPAddressField`` replacement a ``CIDR`` and
    10. 

  10. ``MACADDR`` field have been added. Furthermore a customer Manager allows for
    11. 

  11. access to all of PostgreSQL's INET operators.
    12. 

  12. 

  13. Dependencies
    14. 

  14. ------------
    15. 

  15. 

  16. Current version of code is targeting Django 1.2 support, as this relies heavily
    17. 

  17. on ORM internals supporting multiple versions is especially tricky. ``IPy`` is
    18. 

  18. used for the same reasons. ``ipaddr`` is being considered, but the conversion
    19. 

  19. hinges on the related projects conversion to ``ipaddr``.
    20. 

  20. 

  21. Getting started
    22. 

  22. ---------------
    23. 

  23. 

  24. Make sure ``netfields`` is in your ``PYTHONPATH``, then simply use the
    25. 

  25. following::
    26. 

  26. 

  27.  from netfields import InetAddressField, NetManager
    28. 

  28. 

  29.  class Example(models.Model):
    30. 

  30.      inet = InetAddressField()
    31. 

  31.      # ...
    32. 

  32. 

  33.      objects = NetManager()
    34. 

  34. 

  35. The page also provides ``CidrAddressField`` and a ``MACAddressField``.
    36. 

  36. ``NetManager`` is required for the extra lookups to be available. Lookups for
    37. 

  37. ``INET`` and ``CIDR`` database types will be handled differently than when
    38. 

  38. running vanilla Django.  All lookups are case-insensitive and text based
    39. 

  39. lookups are avoided whenever possible. In addition to Django's default lookup
    40. 

  40. types the following have been added.
    41. 

  41. 

  42. * ``__net_contained``
    43. 

  43. * ``__net_contained_or_equal``
    44. 

  44. * ``__net_contains``
    45. 

  45. * ``__net_contains_or_equals``
    46. 

  46. 

  47. These correspond with the operators from
    48. 

  48. http://www.postgresql.org/docs/8.3/interactive/functions-net.html
    49. 

  49. 

  50. ``netfields`` does not have to be in ``INSTALLED_APPS``.
    51. 

  51. 

  52. Related Django bugs
    53. 

  53. -------------------
    54. 

  54. 

  55. * 11442_ - Postgresql backend casts inet types to text, breaks IP operations and IPv6 lookups.
    56. 

  56. * 811_ - IPv6 address field support.
    57. 

  57. 

  58. .. _11442: http://code.djangoproject.com/ticket/11442
    59. 

  59. .. _811: http://code.djangoproject.com/ticket/811
    60.