ChatGPT解决这个技术问题 Extra ChatGPT

How can I combine two or more querysets in a Django view?

I am trying to build the search for a Django site I am building, and in that search, I am searching in three different models. And to get pagination on the search result list, I would like to use a generic object_list view to display the results. But to do that, I have to merge three querysets into one.

How can I do that? I've tried this:

result_list = []
page_list = Page.objects.filter(
    Q(title__icontains=cleaned_search_term) |
    Q(body__icontains=cleaned_search_term))
article_list = Article.objects.filter(
    Q(title__icontains=cleaned_search_term) |
    Q(body__icontains=cleaned_search_term) |
    Q(tags__icontains=cleaned_search_term))
post_list = Post.objects.filter(
    Q(title__icontains=cleaned_search_term) |
    Q(body__icontains=cleaned_search_term) |
    Q(tags__icontains=cleaned_search_term))

for x in page_list:
    result_list.append(x)
for x in article_list:
    result_list.append(x)
for x in post_list:
    result_list.append(x)

return object_list(
    request,
    queryset=result_list,
    template_object_name='result',
    paginate_by=10,
    extra_context={
        'search_term': search_term},
    template_name="search/result_list.html")

But this doesn't work. I get an error when I try to use that list in the generic view. The list is missing the clone attribute.

How can I merge the three lists, page_list, article_list and post_list?

Looks like t_rybik has created a comprehensive solution at djangosnippets.org/snippets/1933
For searching it's better to use dedicated solutions like Haystack - it's very flexible.
Django users 1.11 and abv, see this answer - stackoverflow.com/a/42186970/6003362
note: the question is limited to the very rare case when after merging 3 different models together you don't need extracting models again on the listing to distinguish data on types. For most cases - if distinction is expected - it will wrong interface. For the same models: see answers about union.

a
akaihola

Concatenating the querysets into a list is the simplest approach. If the database will be hit for all querysets anyway (e.g. because the result needs to be sorted), this won't add further cost.

from itertools import chain
result_list = list(chain(page_list, article_list, post_list))

Using itertools.chain is faster than looping each list and appending elements one by one, since itertools is implemented in C. It also consumes less memory than converting each queryset into a list before concatenating.

Now it's possible to sort the resulting list e.g. by date (as requested in hasen j's comment to another answer). The sorted() function conveniently accepts a generator and returns a list:

result_list = sorted(
    chain(page_list, article_list, post_list),
    key=lambda instance: instance.date_created)

If you're using Python 2.4 or later, you can use attrgetter instead of a lambda. I remember reading about it being faster, but I didn't see a noticeable speed difference for a million item list.

from operator import attrgetter
result_list = sorted(
    chain(page_list, article_list, post_list),
    key=attrgetter('date_created'))

If merging querysets from the same table to perform an OR query, and have duplicated rows you can eliminate them with the groupby function: from itertools import groupby unique_results = [rows.next() for (key, rows) in groupby(result_list, key=lambda obj: obj.id)]
Ok, so nm about the groupby function in this context. With the the Q function you should be able to perform any OR query you need: https://docs.djangoproject.com/en/1.3/topics/db/queries/#complex-lookups-with-q-objects
@apelliciari Chain uses significantly less memory than list.extend, because it doesn't need to load both lists fully into memory.
@AWrightIV Here's the new version of that link: docs.djangoproject.com/en/1.8/topics/db/queries/…
trying this approacg but have 'list' object has no attribute 'complex_filter'
D
Daniel Holmes

Try this:

matches = pages | articles | posts

It retains all the functions of the querysets which is nice if you want to order_by or similar.

Please note: this doesn't work on querysets from two different models.


Doesn't work on sliced querysets, though. Or am I missing something?
I used to join the querysets using "|" but not always works fine. It's better to use "Q": docs.djangoproject.com/en/dev/topics/db/queries/…
Here | is the set union operator, not bitwise OR.
@e100 no, it's not the set union operator. django overloads the bitwise OR operator: github.com/django/django/blob/master/django/db/models/…
Note that this solution does not preserve ordering, so a set {x,y,x} and a set {a,b,c} may end up {a,b,c,x,y,z} regardless of whether you use s1 | s2 or s2 | s1 and that makes | somewhat useless in many cases.
P
Peter Mortensen

Related, for mixing querysets from the same model, or for similar fields from a few models, starting with Django 1.11 a QuerySet.union() method is also available:

union() union(*other_qs, all=False) New in Django 1.11. Uses SQL’s UNION operator to combine the results of two or more QuerySets. For example: >>> qs1.union(qs2, qs3) The UNION operator selects only distinct values by default. To allow duplicate values, use the all=True argument. union(), intersection(), and difference() return model instances of the type of the first QuerySet even if the arguments are QuerySets of other models. Passing different models works as long as the SELECT list is the same in all QuerySets (at least the types, the names don’t matter as long as the types in the same order). In addition, only LIMIT, OFFSET, and ORDER BY (i.e. slicing and order_by()) are allowed on the resulting QuerySet. Further, databases place restrictions on what operations are allowed in the combined queries. For example, most databases don’t allow LIMIT or OFFSET in the combined queries.


This is a better solution for my problem set that needs to have unique values.
Where do you import union from though? Does it have to come from one of the X number of querysets?
Yes, it is a method of queryset.
I think it removes search filters
Keep in mind you won't be able to filter() this queryset anymore after using union(). filter() will just fail silently. At least in Django 2.2
a
akaihola

You can use the QuerySetChain class below. When using it with Django's paginator, it should only hit the database with COUNT(*) queries for all querysets and SELECT() queries only for those querysets whose records are displayed on the current page.

Note that you need to specify template_name= if using a QuerySetChain with generic views, even if the chained querysets all use the same model.

from itertools import islice, chain

class QuerySetChain(object):
    """
    Chains multiple subquerysets (possibly of different models) and behaves as
    one queryset.  Supports minimal methods needed for use with
    django.core.paginator.
    """

    def __init__(self, *subquerysets):
        self.querysets = subquerysets

    def count(self):
        """
        Performs a .count() for all subquerysets and returns the number of
        records as an integer.
        """
        return sum(qs.count() for qs in self.querysets)

    def _clone(self):
        "Returns a clone of this queryset chain"
        return self.__class__(*self.querysets)

    def _all(self):
        "Iterates records in all subquerysets"
        return chain(*self.querysets)

    def __getitem__(self, ndx):
        """
        Retrieves an item or slice from the chained set of results from all
        subquerysets.
        """
        if type(ndx) is slice:
            return list(islice(self._all(), ndx.start, ndx.stop, ndx.step or 1))
        else:
            return islice(self._all(), ndx, ndx+1).next()

In your example, the usage would be:

pages = Page.objects.filter(Q(title__icontains=cleaned_search_term) |
                            Q(body__icontains=cleaned_search_term))
articles = Article.objects.filter(Q(title__icontains=cleaned_search_term) |
                                  Q(body__icontains=cleaned_search_term) |
                                  Q(tags__icontains=cleaned_search_term))
posts = Post.objects.filter(Q(title__icontains=cleaned_search_term) |
                            Q(body__icontains=cleaned_search_term) | 
                            Q(tags__icontains=cleaned_search_term))
matches = QuerySetChain(pages, articles, posts)

Then use matches with the paginator like you used result_list in your example.

The itertools module was introduced in Python 2.3, so it should be available in all Python versions Django runs on.


Nice approach, but one problem I see here is that the query sets are appended "head-to-tail". What if each queryset is ordered by date and one needs the combined-set to also be ordered by date?
This certaintly looks promising, great, I'll have to try that, but i dont have time today. I'll get back to you if it solves my problem. Great work.
Ok, I had to try today, but it didnt work, first it complained that it didnt have to _clone attribute so i added that one, just copied the _all and that worked, but it seems that the paginator has some problem with this queryset. I get this paginator error: "len() of unsized object"
@Espen Python library: pdb, logging. External: IPython, ipdb, django-logging, django-debug-toolbar, django-command-extensions, werkzeug. Use print statements in code or use the logging module. Above all, learn to introspect in the shell. Google for blog posts about debugging Django. Glad to help!
@patrick see djangosnippets.org/snippets/1103 and djangosnippets.org/snippets/1933 – epecially the latter is a very comprehensive solution
v
vutran

In case you want to chain a lot of querysets, try this:

from itertools import chain
result = list(chain(*docs))

where: docs is a list of querysets


C
Carl Meyer

The big downside of your current approach is its inefficiency with large search result sets, as you have to pull down the entire result set from the database each time, even though you only intend to display one page of results.

In order to only pull down the objects you actually need from the database, you have to use pagination on a QuerySet, not a list. If you do this, Django actually slices the QuerySet before the query is executed, so the SQL query will use OFFSET and LIMIT to only get the records you will actually display. But you can't do this unless you can cram your search into a single query somehow.

Given that all three of your models have title and body fields, why not use model inheritance? Just have all three models inherit from a common ancestor that has title and body, and perform the search as a single query on the ancestor model.


D
Devang Padhiyar

This can be achieved by two ways either.

1st way to do this

Use union operator for queryset | to take union of two queryset. If both queryset belongs to same model / single model than it is possible to combine querysets by using union operator.

For an instance

pagelist1 = Page.objects.filter(
    Q(title__icontains=cleaned_search_term) | 
    Q(body__icontains=cleaned_search_term))
pagelist2 = Page.objects.filter(
    Q(title__icontains=cleaned_search_term) | 
    Q(body__icontains=cleaned_search_term))
combined_list = pagelist1 | pagelist2 # this would take union of two querysets

2nd way to do this

One other way to achieve combine operation between two queryset is to use itertools chain function.

from itertools import chain
combined_results = list(chain(pagelist1, pagelist2))

Instead of itertools.chain (which runs each query separately), functools.reduce(operator.or_, [pagelist1, pagelist2]) can be used to programmatically apply your first approach. This results in a single query.
P
Peter Mortensen

You can use Union:

qs = qs1.union(qs2, qs3)

But if you want to apply order_by on the foreign models of the combined queryset... then you need to Select them beforehand this way... otherwise it won't work.

Example

qs = qs1.union(qs2.select_related("foreignModel"), qs3.select_related("foreignModel"))
qs.order_by("foreignModel__prop1")

where prop1 is a property in the foreign model.


r
ray6080
DATE_FIELD_MAPPING = {
    Model1: 'date',
    Model2: 'pubdate',
}

def my_key_func(obj):
    return getattr(obj, DATE_FIELD_MAPPING[type(obj)])

And then sorted(chain(Model1.objects.all(), Model2.objects.all()), key=my_key_func)

Quoted from https://groups.google.com/forum/#!topic/django-users/6wUNuJa4jVw. See Alex Gaynor


S
Stephen Rauch

Requirements: Django==2.0.2, django-querysetsequence==0.8

In case you want to combine querysets and still come out with a QuerySet, you might want to check out django-queryset-sequence.

But one note about it. It only takes two querysets as it's argument. But with python reduce you can always apply it to multiple querysets.

from functools import reduce
from queryset_sequence import QuerySetSequence

combined_queryset = reduce(QuerySetSequence, list_of_queryset)

And that's it. Below is a situation I ran into and how I employed list comprehension, reduce and django-queryset-sequence

from functools import reduce
from django.shortcuts import render    
from queryset_sequence import QuerySetSequence

class People(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    mentor = models.ForeignKey('self', null=True, on_delete=models.SET_NULL, related_name='my_mentees')

class Book(models.Model):
    name = models.CharField(max_length=20)
    owner = models.ForeignKey(Student, on_delete=models.CASCADE)

# as a mentor, I want to see all the books owned by all my mentees in one view.
def mentee_books(request):
    template = "my_mentee_books.html"
    mentor = People.objects.get(user=request.user)
    my_mentees = mentor.my_mentees.all() # returns QuerySet of all my mentees
    mentee_books = reduce(QuerySetSequence, [each.book_set.all() for each in my_mentees])

    return render(request, template, {'mentee_books' : mentee_books})

Does Book.objects.filter(owner__mentor=mentor) not do the same thing? I'm not sure this is a valid use-case. I think a Book might need to have multiple owners before you needed to start doing anything like this.
Yeah it does the same thing. I tried it. Anyway, perhaps this could be useful in some other situation. Thanks for pointing that out. You don't exactly start out knowing all the shortcuts as a beginner. Sometimes you gotta travel the load winding road to appreciate the crow's fly
P
Peter Mortensen

Here's an idea... just pull down one full page of results from each of the three and then throw out the 20 least useful ones... this eliminates the large querysets and that way you only sacrifice a little performance instead of a lot.


P
Peter Mortensen

This will do the work without using any other libraries:

result_list = page_list | article_list | post_list

Worth noting that this may not retain the order of your results
P
Peter Mortensen

The best option is to use the Django built-in methods:

# Union method
result_list = page_list.union(article_list, post_list)

That will return the union of all the objects in those querysets.

If you want to get just the objects that are in the three querysets, you will love the built-in method of querysets, intersection.

# intersection method
result_list = page_list.intersection(article_list, post_list)

P
Petr Dvořáček

This recursive function concatenates array of querysets into one queryset.

def merge_query(ar):
    if len(ar) ==0:
        return [ar]
    while len(ar)>1:
        tmp=ar[0] | ar[1]
        ar[0]=tmp
        ar.pop(1)
        return ar

I am literally lost.
we combining query result it cannot be use at run-time and that really bad idea to do that. because sometime it's add duplication over result.
Too much complex , and the recursion results in a resources burn in the server.