Search and ordering in Django - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the search_fields attribute in Django's admin?

The search_fields attribute allows you to specify which model fields should be searchable in the Django admin interface. It enables a search box that filters the list view based on the entered query.

beginner

How do you enable ordering of model records in Django admin?

You can enable ordering by setting the <code>ordering</code> attribute in the model's <code>Meta</code> class or by using the <code>ordering</code> attribute in the admin class. This controls the default order of records shown.

intermediate

What does the ordering attribute accept in Django models or admin?

It accepts a list or tuple of field names as strings. Prefixing a field name with a minus sign (-) orders it in descending order; otherwise, ascending order is used.

intermediate

How can you add search functionality to a Django REST Framework API view?

You add the <code>SearchFilter</code> class to the view's <code>filter_backends</code> and specify <code>search_fields</code>. This enables searching by query parameters on specified fields.

intermediate

What is the difference between search_fields and ordering_fields in Django REST Framework?

search_fields defines which fields can be searched using a query string, while ordering_fields defines which fields can be used to order the results. Both are used with filter backends.

In Django admin, which attribute enables a search box to filter records?

A ordering

B search_fields

C list_filter

D filter_backends

The search_fields attribute adds a search box in Django admin to filter records by specified fields.

How do you specify descending order for a field in Django model ordering?

A Use the field name with a minus sign (-)

B Use uppercase field name

C Use the field name with a plus sign (+)

D Use the field name in quotes

Prefixing a field name with a minus sign (-) orders the results in descending order.

Which Django REST Framework filter backend enables search functionality?

A SearchFilter

B OrderingFilter

C DjangoFilterBackend

D LimitOffsetPagination

SearchFilter enables search functionality in Django REST Framework views.

What does the ordering_fields attribute do in Django REST Framework?

A Defines fields that can be searched

B Defines pagination size

C Defines fields that can be ordered

D Defines fields that are hidden

ordering_fields specifies which fields clients can use to order API results.

Where do you set the default ordering of records in a Django model?

A In the admin class using <code>search_fields</code>

B In the model's <code>__init__</code> method

C In the view using <code>filter_backends</code>

D In the model's <code>Meta</code> class using <code>ordering</code>

The default ordering is set in the model's Meta class with the ordering attribute.

Explain how to add search and ordering features to a Django admin interface.

Think about attributes in admin classes and model Meta.

Describe how to implement search and ordering in a Django REST Framework API view.

Focus on filter backends and query parameters.

Practice

1. What is the main purpose of adding search and ordering features in a Django ListView?

easy

A. To change the database schema automatically

B. To speed up the server response time

C. To disable pagination on the page

D. To let users find and sort data easily

Solution

1. Step 1: Understand the role of search and ordering

   Search and ordering help users locate specific data and arrange it in a preferred sequence.

2. Step 2: Identify the main benefit in a ListView context

   In Django ListView, these features improve user experience by making data easier to find and view in order.

3. Final Answer:

   To let users find and sort data easily -> Option D

4. Quick Check:

   Search and ordering = user-friendly data access [OK]

Hint: Search and ordering improve user data access quickly [OK]

Common Mistakes:

• Thinking search changes database structure
• Assuming ordering disables pagination
• Believing it speeds server without code changes

2. Which of the following is the correct way to override the get_queryset method in a Django ListView to add ordering by a field named name?

easy

A. def get_queryset(self): return self.queryset.order_by('name')

B. def get_queryset(self): return super().get_queryset().order_by('name')

C. def get_queryset(self): return self.objects.order_by('name')

D. def get_queryset(self): return Model.objects.order_by('name')

Solution

1. Step 1: Recall how to override get_queryset in ListView

   Use super() to get the base queryset, then apply ordering.

2. Step 2: Check each option for correct syntax and context

   def get_queryset(self): return super().get_queryset().order_by('name') correctly calls super() and orders by 'name'. Others misuse queryset or model references.

3. Final Answer:

   def get_queryset(self): return super().get_queryset().order_by('name') -> Option B

4. Quick Check:

   Use super() + order_by() = def get_queryset(self): return super().get_queryset().order_by('name') [OK]

Hint: Use super() to get base queryset before ordering [OK]

Common Mistakes:

• Using self.queryset without defining it
• Calling objects on self instead of model
• Not using super() in get_queryset override

3. Given this Django ListView code snippet, what will be the result of accessing the view with URL parameter ?search=apple&order=price?

class ProductListView(ListView):
    model = Product
    def get_queryset(self):
        qs = super().get_queryset()
        search = self.request.GET.get('search')
        order = self.request.GET.get('order')
        if search:
            qs = qs.filter(name__icontains=search)
        if order:
            qs = qs.order_by(order)
        return qs

medium

A. Products filtered to names containing 'apple' and ordered by price

B. All products ordered by price ignoring search

C. Products filtered by price containing 'apple'

D. Error because 'order' parameter is not validated

Solution

1. Step 1: Analyze filtering by 'search' parameter

   The code filters products where name contains 'apple' (case-insensitive).

2. Step 2: Analyze ordering by 'order' parameter

   The code orders the filtered queryset by the 'price' field.

3. Final Answer:

   Products filtered to names containing 'apple' and ordered by price -> Option A

4. Quick Check:

   Filter by search + order by price = Products filtered to names containing 'apple' and ordered by price [OK]

Hint: Filter first, then order queryset in get_queryset [OK]

Common Mistakes:

• Ignoring the search filter when order is present
• Confusing filter field with order field
• Assuming error without validation in this context

4. Identify the error in this Django ListView code that tries to add search and ordering:

class ItemListView(ListView):
    model = Item
    def get_queryset(self):
        qs = super().get_queryset()
        search = self.request.GET.get('search')
        if search:
            qs = qs.filter(name__icontains=search)
        order = self.request.GET.get('order')
        qs = qs.order_by(order)
        return qs

medium

A. Missing pagination in the view

B. Using filter with icontains instead of contains

C. Calling order_by without checking if 'order' is None

D. Not calling super() in get_queryset

Solution

1. Step 1: Check usage of order_by with 'order' parameter

   The code calls order_by(order) without verifying if order is None, causing error if no 'order' param.

2. Step 2: Verify other parts for correctness

   Filter with icontains is valid, super() is called, pagination is optional and not an error here.

3. Final Answer:

   Calling order_by without checking if 'order' is None -> Option C

4. Quick Check:

   order_by needs valid field or check [OK]

Hint: Check if order param exists before calling order_by [OK]

Common Mistakes:

• Assuming filter icontains is wrong
• Forgetting to call super() (not the case here)
• Confusing pagination with query errors

5. You want to implement a Django ListView that allows users to search products by name and order results by price or rating. You also want to prevent invalid ordering fields from causing errors. Which is the best way to implement get_queryset?

hard

A. Filter by search term, then order only if order param is in allowed list ['price', 'rating']

B. Filter by search term, order by any order param without validation

C. Order first by order param, then filter by search term

D. Ignore search and order, just return all products

Solution

1. Step 1: Understand the need for validation of ordering fields

   Allowing only specific fields prevents errors and security issues.

2. Step 2: Apply filtering before ordering and validate order param

   Filter products by search term, then order only if order param is in ['price', 'rating'].

3. Final Answer:

   Filter by search term, then order only if order param is in allowed list ['price', 'rating'] -> Option A

4. Quick Check:

   Validate order param before ordering = Filter by search term, then order only if order param is in allowed list ['price', 'rating'] [OK]

Hint: Validate order fields before ordering queryset [OK]

Common Mistakes:

• Ordering without checking allowed fields
• Ordering before filtering
• Ignoring search parameter completely