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

README.rst 1.6 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647 
  1. Django PostgreSQL Netfields
    2. 

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

  3. 

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

  5. Currently the built in IPAddressField does not support IPv6 and uses an inefficient
    6. 

  6. HOST() cast in all lookups. Hopefully there experience from this project can lead
    7. 

  7. to a resolution of these issues upstream.
    8. 

  8. 

  9. In addition to the basic IPAddressField replacement a CIDR and MAC field have
    10. 

  10. been added. Furthermore a customer Manager allows for access to all of PostgreSQL's
    11. 

  11. INET operators.
    12. 

  12. 

  13. Django version
    14. 

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

  15. 

  16. Currently this code has only been tested against 1.0.x due to the Django
    17. 

  17. version used by the related project that initiated this effort.
    18. 

  18. 

  19. Getting started
    20. 

  20. ---------------
    21. 

  21. 

  22. Make sure netfields is in your PYTHONPATH, then simply use the following::
    23. 

  23. 

  24.  from netfields import InetAddressField, NetManager
    25. 

  25. 

  26.  class Example(models.Model):
    27. 

  27.      inet = InetAddressField()
    28. 

  28.      # ...
    29. 

  29. 

  30.      objects = NetManager()
    31. 

  31. 

  32. The page also provides CidrAddressField and a MACAddressField. NetManger is
    33. 

  33. required for the extra lookups to be available. Lookups for INET and CIDR
    34. 

  34. database types will be handled differently than when running vanilla Django.
    35. 

  35. All lookups are case-insensitive and text based lookups are avoided whenever
    36. 

  36. possible. In addition to Django's default lookup types the following have been
    37. 

  37. added.
    38. 

  38. 

  39. * __net_contained
    40. 

  40. * __net_contained_or_equal
    41. 

  41. * __net_contains
    42. 

  42. * __net_contains_or_equals
    43. 

  43. 

  44. These correspond with the operators from
    45. 

  45. http://www.postgresql.org/docs/8.3/interactive/functions-net.html
    46. 

  46. 

  47. netfields does not have to be in INSTALLED_APPS.
    48.