BinaryField is a special field to store raw binary data. It can be assigned bytes, bytearray, or memoryview. By default, BinaryField sets editable to False, that is it can’t be included in a ModelForm. Since BinaryField stores raw data or in other terms a python object, it can not be manually entered and needs to be assigned through a view or django shell. This is what editable to False means, that is it can’t be edited through any form.
field_name = models.BinaryField(**options)
Django Model BinaryField Explanation
Illustration of BinaryField using an Example. Consider a project named
geeksforgeeks having an app named
Refer to the following articles to check how to create a project and an app in Django.
Enter the following code into
models.py file of geeks app.
Add the geeks app to
Now when we run
makemigrations command from the terminal,
Python manage.py makemigrations
A new folder named migrations would be created in
geeks directory with a file named
geeks_field BigIntegerField is created when you run makemigrations on the project.It is a field to store raw binary data.
How to use BinaryField ?
Any type of data can be converted into bytes including integers, srings, images, etc. Let’s try to save a string into the BinaryField. String can be converted to bytes using the generic bytes function. This function internally points to CPython Library which implicitly calls the encode function for converting the string to specified encoding.
Now let’s check it in admin server. We have created an instance of GeeksModel
As specified, BinaryField is a non-editable field, if you manually try to make it editable using
editable=True it will create unexpected errors. It should be created in a function so that objects can be allocated to it.
Field Options are the arguments given to each field for applying some constraint or imparting a particular characteristic to a particular Field. For example, adding an argument
null = True to BinaryField will enable it to store empty values for that table in relational database.
Here are the option and attributes that an BinaryField can use.
|Null||If True, Django will store empty values as NULL in the database. Default is False.|
|Blank||If True, the field is allowed to be blank. Default is False.|
|Choices||An iterable (e.g., a list or tuple) of 2-tuples to use as choices for this field.|
|Default||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.|
|help_text||Extra “help” text to be displayed with the form widget. It’s useful for documentation even if your field isn’t used on a form.|
|primary_key||If True, this field is the primary key for the model.|
|Unique||If True, this field must be unique throughout the table.|
- Django Models | Set - 1
- Django Models | Set - 2
- PositiveSmallIntegerField - Django Models
- IntegerField - Django Models
- BigIntegerField - Django Models
- GenericIPAddressField - Django Models
- FloatField - Django Models
- ImageField - Django Models
- PositiveIntegerField - Django Models
- SlugField - Django Models
- URLField - Django Models
- UUIDField - Django Models
- SmallIntegerField - Django Models
- TimeField - Django Models
- DecimalField - Django Models
If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to firstname.lastname@example.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.
Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.