This document contains all the gory details about all the field options and field types Django’s got to offer.
See also
If the built-in fields don’t do the trick, you can easily write your own custom model fields.
Note
Technically, these models are defined in django.db.models.fields, but for convenience they’re imported into django.db.models; the standard convention is to use from django.db import models and refer to fields as models.<Foo>Field.
The following arguments are available to all field types. All are optional.
If True, Django will store empty values as NULL in the database. Default is False.
Note that empty string values will always get stored as empty strings, not as NULL. Only use null=True for non-string fields such as integers, booleans and dates. For both types of fields, you will also need to set blank=True if you wish to permit empty values in forms, as the null parameter only affects database storage (see blank).
Avoid using null on string-based fields such as CharField and TextField unless you have an excellent reason. If a string-based field has null=True, that means it has two possible values for “no data”: NULL, and the empty string. In most cases, it’s redundant to have two possible values for “no data;” Django convention is to use the empty string, not NULL.
Note
When using the Oracle database backend, the null=True option will be coerced for string-based fields that have the empty string as a possible value, and the value NULL will be stored to denote the empty string.
If True, the field is allowed to be blank. Default is False.
Note that this is different than null. null is purely database-related, whereas blank is validation-related. If a field has blank=True, validation on Django’s admin site will allow entry of an empty value. If a field has blank=False, the field will be required.
An iterable (e.g., a list or tuple) of 2-tuples to use as choices for this field.
If this is given, Django’s admin will use a select box instead of the standard text field and will limit choices to the choices given.
A choices list looks like this:
YEAR_IN_SCHOOL_CHOICES = (
('FR', 'Freshman'),
('SO', 'Sophomore'),
('JR', 'Junior'),
('SR', 'Senior'),
('GR', 'Graduate'),
)
The first element in each tuple is the actual value to be stored. The second element is the human-readable name for the option.
The choices list can be defined either as part of your model class:
class Foo(models.Model):
GENDER_CHOICES = (
('M', 'Male'),
('F', 'Female'),
)
gender = models.CharField(max_length=1, choices=GENDER_CHOICES)
or outside your model class altogether:
GENDER_CHOICES = (
('M', 'Male'),
('F', 'Female'),
)
class Foo(models.Model):
gender = models.CharField(max_length=1, choices=GENDER_CHOICES)
You can also collect your available choices into named groups that can be used for organizational purposes:
MEDIA_CHOICES = (
('Audio', (
('vinyl', 'Vinyl'),
('cd', 'CD'),
)
),
('Video', (
('vhs', 'VHS Tape'),
('dvd', 'DVD'),
)
),
('unknown', 'Unknown'),
)
The first element in each tuple is the name to apply to the group. The second element is an iterable of 2-tuples, with each 2-tuple containing a value and a human-readable name for an option. Grouped options may be combined with ungrouped options within a single list (such as the unknown option in this example).
For each model field that has choices set, Django will add a method to retrieve the human-readable name for the field's current value. See get_FOO_display() in the database API documentation.
Finally, note that choices can be any iterable object -- not necessarily a list or tuple. This lets you construct choices dynamically. But if you find yourself hacking choices to be dynamic, you're probably better off using a proper database table with a ForeignKey. choices is meant for static data that doesn't change much, if ever.
The name of the database column to use for this field. If this isn't given, Django will use the field's name.
If your database column name is an SQL reserved word, or contains characters that aren't allowed in Python variable names -- notably, the hyphen -- that's OK. Django quotes column and table names behind the scenes.
If True, djadmin:django-admin.py sqlindexes <sqlindexes> will output a CREATE INDEX statement for this field.
The name of the database tablespace to use for this field's index, if this field is indexed. The default is the project's DEFAULT_INDEX_TABLESPACE setting, if set, or the db_tablespace of the model, if any. If the backend doesn't support tablespaces, this option is ignored.
The default value for the field. This can be a value or a callable object. If callable it will be called every time a new object is created.
If False, the field will not be editable in the admin or via forms automatically generated from the model class. Default is True.
The error_messages argument lets you override the default messages that the field will raise. Pass in a dictionary with keys matching the error messages you want to override.
Extra "help" text to be displayed under the field on the object's admin form. It's useful for documentation even if your object doesn't have an admin form.
Note that this value is not HTML-escaped when it's displayed in the admin interface. This lets you include HTML in help_text if you so desire. For example:
help_text="Please use the following format: <em>YYYY-MM-DD</em>."
Alternatively you can use plain text and django.utils.html.escape() to escape any HTML special characters.
If True, this field is the primary key for the model.
If you don't specify primary_key=True for any fields in your model, Django will automatically add an IntegerField to hold the primary key, so you don't need to set primary_key=True on any of your fields unless you want to override the default primary-key behavior. For more, see Automatic primary key fields.
primary_key=True implies null=False and unique=True. Only one primary key is allowed on an object.
If True, this field must be unique throughout the table.
This is enforced at the database level and at the Django admin-form level. If you try to save a model with a duplicate value in a unique field, a django.db.IntegrityError will be raised by the model's save() method.
This option is valid on all field types except ManyToManyField and FileField.
Set this to the name of a DateField or DateTimeField to require that this field be unique for the value of the date field.
For example, if you have a field title that has unique_for_date="pub_date", then Django wouldn't allow the entry of two records with the same title and pub_date.
This is enforced at the Django admin-form level but not at the database level.
Like unique_for_date, but requires the field to be unique with respect to the month.
A human-readable name for the field. If the verbose name isn't given, Django will automatically create it using the field's attribute name, converting underscores to spaces. See Verbose field names.
A list of validators to run for this field.See the validators documentation for more information.
An IntegerField that automatically increments according to available IDs. You usually won't need to use this directly; a primary key field will automatically be added to your model if you don't specify otherwise. See Automatic primary key fields.
A 64 bit integer, much like an IntegerField except that it is guaranteed to fit numbers from -9223372036854775808 to 9223372036854775807. The admin represents this as an <input type="text"> (a single-line input).
A true/false field.
The admin represents this as a checkbox.
A string field, for small- to large-sized strings.
For large amounts of text, use TextField.
The admin represents this as an <input type="text"> (a single-line input).
CharField has one extra required argument:
Note
If you are writing an application that must be portable to multiple database backends, you should be aware that there are restrictions on max_length for some backends. Refer to the database backend notes for details.
MySQL users
If you are using this field with MySQLdb 1.2.2 and the utf8_bin collation (which is not the default), there are some issues to be aware of. Refer to the MySQL database notes for details.
A field of integers separated by commas. As in CharField, the max_length argument is required and the note about database portability mentioned there should be heeded.
A date, represented in Python by a datetime.date instance. Has a few extra, optional arguments:
The admin represents this as an <input type="text"> with a JavaScript calendar, and a shortcut for "Today". The JavaScript calendar will always start the week on a Sunday.
A date and time, represented in Python by a datetime.datetime instance. Takes the same extra arguments as DateField.
The admin represents this as two <input type="text"> fields, with JavaScript shortcuts.
A fixed-precision decimal number, represented in Python by a Decimal instance. Has two required arguments:
For example, to store numbers up to 999 with a resolution of 2 decimal places, you'd use:
models.DecimalField(..., max_digits=5, decimal_places=2)
And to store numbers up to approximately one billion with a resolution of 10 decimal places:
models.DecimalField(..., max_digits=19, decimal_places=10)
The admin represents this as an <input type="text"> (a single-line input).
A CharField that checks that the value is a valid e-mail address.
A file-upload field.
Note
The primary_key and unique arguments are not supported, and will raise a TypeError if used.
Has one required argument:
A local filesystem path that will be appended to your MEDIA_ROOT setting to determine the value of the url attribute.
This path may contain strftime formatting, which will be replaced by the date/time of the file upload (so that uploaded files don't fill up the given directory).
This may also be a callable, such as a function, which will be called to obtain the upload path, including the filename. This callable must be able to accept two arguments, and return a Unix-style path (with forward slashes) to be passed along to the storage system. The two arguments that will be passed are:
| Argument | Description |
|---|---|
| instance | An instance of the model where the FileField is defined. More specifically, this is the particular instance where the current file is being attached. In most cases, this object will not have been saved to the database yet, so if it uses the default AutoField, it might not yet have a value for its primary key field. |
| filename | The filename that was originally given to the file. This may or may not be taken into account when determining the final destination path. |
Also has one optional argument:
Optional. A storage object, which handles the storage and retrieval of your files. See Managing files for details on how to provide this object.
The admin represents this field as an <input type="file"> (a file-upload widget).
Using a FileField or an ImageField (see below) in a model takes a few steps:
For example, say your MEDIA_ROOT is set to '/home/media', and upload_to is set to 'photos/%Y/%m/%d'. The '%Y/%m/%d' part of upload_to is strftime formatting; '%Y' is the four-digit year, '%m' is the two-digit month and '%d' is the two-digit day. If you upload a file on Jan. 15, 2007, it will be saved in the directory /home/media/photos/2007/01/15.
If you want to retrieve the upload file's on-disk filename, or a URL that refers to that file, or the file's size, you can use the name, url and size attributes; see Managing files.
Note that whenever you deal with uploaded files, you should pay close attention to where you're uploading them and what type of files they are, to avoid security holes. Validate all uploaded files so that you're sure the files are what you think they are. For example, if you blindly let somebody upload files, without validation, to a directory that's within your Web server's document root, then somebody could upload a CGI or PHP script and execute that script by visiting its URL on your site. Don't allow that.
By default, FileField instances are created as varchar(100) columns in your database. As with other fields, you can change the maximum length using the max_length argument.
When you access a FileField on a model, you are given an instance of FieldFile as a proxy for accessing the underlying file. This class has several methods that can be used to interact with file data:
Behaves like the standard Python open() method and opens the file associated with this instance in the mode specified by mode.
Behaves like the standard Python file.close() method and closes the file associated with this instance.
This method takes a filename and file contents and passes them to the storage class for the field, then associates the stored file with the model field. If you want to manually associate file data with FileField instances on your model, the save() method is used to persist that file data.
Takes two required arguments: name which is the name of the file, and content which is a file-like object containing the file's contents. The optional save argument controls whether or not the instance is saved after the file has been altered. Defaults to True.
Deletes the file associated with this instance and clears all attributes on the field. Note: This method will close the file if it happens to be open when delete() is called.
The optional save argument controls whether or not the instance is saved after the file has been deleted. Defaults to True.
A CharField whose choices are limited to the filenames in a certain directory on the filesystem. Has three special arguments, of which the first is required:
Of course, these arguments can be used together.
The one potential gotcha is that match applies to the base filename, not the full path. So, this example:
FilePathField(path="/home/images", match="foo.*", recursive=True)
...will match /home/images/foo.gif but not /home/images/foo/bar.gif because the match applies to the base filename (foo.gif and bar.gif).
By default, FilePathField instances are created as varchar(100) columns in your database. As with other fields, you can change the maximum length using the max_length argument.
A floating-point number represented in Python by a float instance.
The admin represents this as an <input type="text"> (a single-line input).
Inherits all attributes and methods from FileField, but also validates that the uploaded object is a valid image.
In addition to the special attributes that are available for FileField, an ImageField also has height and width attributes.
To facilitate querying on those attributes, ImageField has two extra optional arguments:
Requires the Python Imaging Library.
By default, ImageField instances are created as varchar(100) columns in your database. As with other fields, you can change the maximum length using the max_length argument.
An integer. The admin represents this as an <input type="text"> (a single-line input).
An IP address, in string format (e.g. "192.0.2.30"). The admin represents this as an <input type="text"> (a single-line input).
Like a BooleanField, but allows NULL as one of the options. Use this instead of a BooleanField with null=True. The admin represents this as a <select> box with "Unknown", "Yes" and "No" choices.
Like an IntegerField, but must be positive.
Like a PositiveIntegerField, but only allows values under a certain (database-dependent) point.
Slug is a newspaper term. A slug is a short label for something, containing only letters, numbers, underscores or hyphens. They're generally used in URLs.
Like a CharField, you can specify max_length (read the note about database portability and max_length in that section, too). If max_length is not specified, Django will use a default length of 50.
Implies setting Field.db_index to True.
It is often useful to automatically prepopulate a SlugField based on the value of some other value. You can do this automatically in the admin using prepopulated_fields.
Like an IntegerField, but only allows values under a certain (database-dependent) point.
A large text field. The admin represents this as a <textarea> (a multi-line input).
MySQL users
If you are using this field with MySQLdb 1.2.1p2 and the utf8_bin collation (which is not the default), there are some issues to be aware of. Refer to the MySQL database notes for details.
A time, represented in Python by a datetime.time instance. Accepts the same auto-population options as DateField.
The admin represents this as an <input type="text"> with some JavaScript shortcuts.
A CharField for a URL. Has one extra optional argument:
If True (the default), the URL given will be checked for existence (i.e., the URL actually loads and doesn't give a 404 response).
Note that when you're using the single-threaded development server, validating a URL being served by the same server will hang. This should not be a problem for multithreaded servers.
The admin represents this as an <input type="text"> (a single-line input).
Like all CharField subclasses, URLField takes the optional max_length, a default of 200 is used.
Jul 05, 2010