From 8ee1eddb7e148de89aebde9e68da495633fc1ec9 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Thu, 13 Dec 2012 22:11:06 +0100 Subject: Add a BinaryField model field Thanks Michael Jung, Charl Botha and Florian Apolloner for review and help on the patch. --- docs/ref/models/fields.txt | 16 ++++++++++++++++ docs/releases/1.6.txt | 6 ++++++ 2 files changed, 22 insertions(+) (limited to 'docs') diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt index 1a0f93cf9d..1dbc8c3998 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -347,6 +347,22 @@ A 64 bit integer, much like an :class:`IntegerField` except that it is guaranteed to fit numbers from -9223372036854775808 to 9223372036854775807. The default form widget for this field is a :class:`~django.forms.TextInput`. +``BinaryField`` +------------------- + +.. class:: BinaryField([**options]) + +.. versionadded:: 1.6 + +A field to store raw binary data. It only supports ``bytes`` assignment. Be +aware that this field has limited functionality. For example, it is not possible +to filter a queryset on a ``BinaryField`` value. + +.. admonition:: Abusing ``BinaryField`` + + Although you might think about storing files in the database, consider that + it is bad design in 99% of the cases. This field is *not* a replacement for + proper :ref.`static files handling. ``BooleanField`` ---------------- diff --git a/docs/releases/1.6.txt b/docs/releases/1.6.txt index 34fa687290..89e7ff17ee 100644 --- a/docs/releases/1.6.txt +++ b/docs/releases/1.6.txt @@ -53,6 +53,12 @@ UTC. This limitation was lifted in Django 1.6. Use :meth:`QuerySet.datetimes() ` to perform time zone aware aggregation on a :class:`~django.db.models.DateTimeField`. +``BinaryField`` model field +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A new :class:`django.db.models.BinaryField` model field allows to store raw +binary data in the database. + Minor features ~~~~~~~~~~~~~~ -- cgit v1.3