How do i cast char to integer while querying in django ORM?

Recently started using Django ORM.I want to execute this query

 select student_id from students where student_id like "%97318%" order by CAST(student_id as UNSIGNED) desc;   

where student_id is a CharField which I want as integer for querying.
I tried with

  students.objects.filter(student_id__contains "97318").order('-student_id')

works fine. But don’t know and couldn’t find how to cast “student_id” to int like the actual MySQL query mentioned above with “Django ORM”. should I use raw query or is there a way out?
Let me know your suggestions.

Here is Solutions:

We have many solutions to this problem, But we recommend you to use the first solution because it is tested & true solution that will 100% work for you.

Solution 1

An updated alternative without requiring the use of extra is the cast function (new in Django 1.10):

>>> from django.db.models import FloatField
>>> from django.db.models.functions import Cast
>>> Value.objects.create(integer=4)
>>> value = Value.objects.annotate(as_float=Cast('integer', FloatField())).get()> 
>>> print(value.as_float)


Solution 2

Use queryset’s extra() method:

students.objects.filter(student_id__contains="97318") \
                .extra({'stident_id_uint': "CAST(student_id as UNSIGNED)"}) \

Solution 3

I have tried extra() and annotate() to CAST, but they did not work well with related fields and generates JOINS resulting unexpected queryset sometimes.

What I ended up was to create a Custom Lookup.

The documentation is few but can be found at here and here

Here is my example:

class IntegerValue(Transform):
    # Register this before you filter things, for example in
    lookup_name = 'int'  # Used as object.filter(LeftField__int__gte, "777")
    bilateral = True  # To cast both left and right

    def as_sql(self, compiler, connection):
        sql, params = compiler.compile(self.lhs)
        sql = 'CAST(%s AS UNSIGNED)' % sql
        return sql, params

Then below should work:


Solution 4

Use cast from Django.
If you are working with Django CBV (class based view) you can do this way:

class Document(TenantAwareModel):
    document_data = JSONField(null=True)

from django.db.models import TextField
from django.db.models.functions import Cast

def get_queryset(self):
    document = Document.objects.annotate(document_data_as_text=Cast('document_data', TextField()))
    user = self.request.user
    tenant = self.request.user.tenant
    return document.filter(tenant=tenant)

Then, in your method you can use document_data_as_text as a normal field to filter by it:

def list(self, request, *args, **kwargs):
    document_part_filter_param = request.query_params.get("documentPart")
    if document_part_filter_param:
        queryset = queryset.filter(document_data_as_text__unaccent__icontains=document_part_filter_param)

Note: Use and implement solution 1 because this method fully tested our system.
Thank you 🙂

All methods was sourced from or, is licensed under cc by-sa 2.5, cc by-sa 3.0 and cc by-sa 4.0

Leave a Reply