diff options
Diffstat (limited to 'docs/ref/models')
| -rw-r--r-- | docs/ref/models/fields.txt | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index e7717e9d90..fe35f979ca 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -1012,6 +1012,31 @@ Like all :class:`CharField` subclasses, :class:`URLField` takes the optional :attr:`~CharField.max_length` argument. If you don't specify :attr:`~CharField.max_length`, a default of 200 is used. +UUIDField +--------- + +.. versionadded:: 1.8 + +.. class:: UUIDField([**options]) + +A field for storing universally unique identifiers. Uses Python's +:class:`~python:uuid.UUID` class. When used on PostgreSQL, this stores in a +``uuid`` datatype, otherwise in a ``char(32)``. + +Universally unique identifiers are a good alternative to :class:`AutoField` for +:attr:`~Field.primary_key`. The database will not generate the UUID for you, so +it is recommended to use :attr:`~Field.default`:: + + import uuid + from django.db import models + + class MyUUIDModel(models.Model): + id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False) + # other fields + +Note that a callable (with the parentheses omitted) is passed to ``default``, +not an instance of ``UUID``. + Relationship fields =================== |